pgnotifier

Documentation

Index

• Constants
• func CheckForPGNotifierEnvVars() bool
• func GetCurrentSQLTimestamp() string
• func GetPGNotifierConnectionString() string
• func Init()
• type ClaimResponseT
• type ClaimT
• type JobPayload
• type JobsResponse
• type MessagePayload
• type PgNotifierT
  • func New(workspaceIdentifier, fallbackConnectionInfo string) (notifier PgNotifierT, err error)
  • func (notifier PgNotifierT) ClearJobs(ctx context.Context) (err error)
  • func (notifier PgNotifierT) GetDBHandle() *sql.DB
  • func (notifier *PgNotifierT) Publish(payload MessagePayload, schema *whUtils.SchemaT, priority int) (ch chan []ResponseT, err error)
  • func (notifier *PgNotifierT) RunMaintenanceWorker(ctx context.Context) error
  • func (notifier *PgNotifierT) Subscribe(ctx context.Context, workerId string, jobsBufferSize int) chan ClaimT
  • func (notifier *PgNotifierT) UpdateClaimedEvent(claim *ClaimT, response *ClaimResponseT)
• type ResponseT

Constants

const (
	WaitingState   = "waiting"
	ExecutingState = "executing"
	SucceededState = "succeeded"
	FailedState    = "failed"
	AbortedState   = "aborted"
)

const (
	AsyncJobType  = "async_job"
	UploadJobType = "upload"
)

const MaxTrackAsyncBatchRetries = 5

Functions

func CheckForPGNotifierEnvVars

func CheckForPGNotifierEnvVars() bool

CheckForPGNotifierEnvVars Checks if all the required Env Variables for PG Notifier are present

func GetCurrentSQLTimestamp

func GetCurrentSQLTimestamp() string

GetCurrentSQLTimestamp to get sql complaint current datetime string

func GetPGNotifierConnectionString

func GetPGNotifierConnectionString() string

GetPGNotifierConnectionString Returns PG Notifier DB Connection Configuration

func Init

func Init()

Types

type ClaimResponseT

type ClaimResponseT struct {
	Payload json.RawMessage
	Err     error
}

type ClaimT

type ClaimT struct {
	ID        int64
	BatchID   string
	Status    string
	Workspace string
	Payload   json.RawMessage
	Attempt   int
	JobType   string
}

type JobPayload

type JobPayload json.RawMessage

type JobsResponse

type JobsResponse struct {
	Status    string
	Output    json.RawMessage
	Error     string
	JobType   string
	JobRunID  string
	TaskRunID string
}

type MessagePayload

type MessagePayload struct {
	Jobs    []JobPayload
	JobType string
}

type PgNotifierT

type PgNotifierT struct {
	URI string
	// contains filtered or unexported fields
}

func New

func New(workspaceIdentifier, fallbackConnectionInfo string) (notifier PgNotifierT, err error)

New Given default connection info return pg notifier object from it

func (PgNotifierT) ClearJobs

func (notifier PgNotifierT) ClearJobs(ctx context.Context) (err error)

func (PgNotifierT) GetDBHandle

func (notifier PgNotifierT) GetDBHandle() *sql.DB

func (*PgNotifierT) Publish

func (notifier *PgNotifierT) Publish(payload MessagePayload, schema *whUtils.SchemaT, priority int) (ch chan []ResponseT, err error)

func (*PgNotifierT) RunMaintenanceWorker

func (notifier *PgNotifierT) RunMaintenanceWorker(ctx context.Context) error

RunMaintenanceWorker (blocking - to be called from go routine) re-triggers zombie jobs which were left behind by dead workers in executing state

func (*PgNotifierT) Subscribe

func (notifier *PgNotifierT) Subscribe(ctx context.Context, workerId string, jobsBufferSize int) chan ClaimT

func (*PgNotifierT) UpdateClaimedEvent

func (notifier *PgNotifierT) UpdateClaimedEvent(claim *ClaimT, response *ClaimResponseT)

type ResponseT

type ResponseT struct {
	JobID   int64
	Status  string
	Output  json.RawMessage
	Error   string
	JobType string
}