scheduler

Documentation

Index

• Constants
• Variables
• func CleanSpec(spec *schedpb.ScheduleSpec)
• func GetListInfoFromStartArgs(args *schedspb.StartScheduleArgs, now time.Time, specBuilder *SpecBuilder) *schedpb.ScheduleListInfo
• func NewResult(dcCollection *dynamicconfig.Collection, specBuilder *SpecBuilder, ...) fxResult
• func SchedulerWorkflow(ctx workflow.Context, args *schedspb.StartScheduleArgs) error
• func ValidateVisibilityQuery(queryString string) error
• type CompiledSpec
  • func (cs *CompiledSpec) CanonicalForm() *schedpb.ScheduleSpec
• type SchedulerWorkflowVersion
• type SpecBuilder
  • func NewSpecBuilder() *SpecBuilder
  • func (b *SpecBuilder) NewCompiledSpec(spec *schedpb.ScheduleSpec) (*CompiledSpec, error)

Constants

const (
	WorkflowType      = "temporal-sys-scheduler-workflow"
	NamespaceDivision = "TemporalScheduler"
)

const (

	// represents the state before Version is introduced
	InitialVersion SchedulerWorkflowVersion = 0
	// skip over entire time range if paused and batch and cache getNextTime queries
	BatchAndCacheTimeQueries = 1
	// use cache v2, and include ids in jitter
	NewCacheAndJitter = 2
	// Don't put possibly-overlapping runs (from SCHEDULE_OVERLAP_POLICY_ALLOW_ALL) in
	// RunningWorkflows.
	DontTrackOverlapping = 3
	// start time in backfill is inclusive rather than exclusive
	InclusiveBackfillStartTime = 4
	// do backfill incrementally
	IncrementalBackfill = 5
	// update from previous action instead of current time
	UpdateFromPrevious = 6
	// do continue-as-new after pending signals
	CANAfterSignals = 7
)

const (
	// Schedules are implemented by a workflow whose ID is this string plus the schedule ID.
	WorkflowIDPrefix = "temporal-sys-scheduler:"

	// This is an example of a timestamp that's appended to the workflow
	// id, used for validation in the frontend.
	AppendedTimestampForValidation = "-2009-11-10T23:00:00Z"

	SignalNameUpdate   = "update"
	SignalNamePatch    = "patch"
	SignalNameRefresh  = "refresh"
	SignalNameForceCAN = "force-continue-as-new"

	QueryNameDescribe          = "describe"
	QueryNameListMatchingTimes = "listMatchingTimes"

	MemoFieldInfo = "ScheduleInfo"

	InitialConflictToken = 1
)

Variables

var Module = fx.Options(
	fx.Provide(NewResult),
	fx.Provide(NewSpecBuilder),
)

var (
	VisibilityBaseListQuery = fmt.Sprintf(
		"%s = '%s' AND %s = '%s' AND %s = '%s'",
		searchattribute.WorkflowType,
		WorkflowType,
		searchattribute.TemporalNamespaceDivision,
		NamespaceDivision,
		searchattribute.ExecutionStatus,
		enumspb.WORKFLOW_EXECUTION_STATUS_RUNNING.String(),
	)
)

Functions

func CleanSpec

func CleanSpec(spec *schedpb.ScheduleSpec)

CleanSpec sets default values in ranges.

func GetListInfoFromStartArgs

func GetListInfoFromStartArgs(args *schedspb.StartScheduleArgs, now time.Time, specBuilder *SpecBuilder) *schedpb.ScheduleListInfo

func NewResult

func NewResult(
	dcCollection *dynamicconfig.Collection,
	specBuilder *SpecBuilder,
	params activityDeps,
) fxResult

func SchedulerWorkflow

func SchedulerWorkflow(ctx workflow.Context, args *schedspb.StartScheduleArgs) error

func ValidateVisibilityQuery

func ValidateVisibilityQuery(queryString string) error

Types

type CompiledSpec

type CompiledSpec struct {
	// contains filtered or unexported fields
}

func (*CompiledSpec) CanonicalForm

func (cs *CompiledSpec) CanonicalForm() *schedpb.ScheduleSpec

type SchedulerWorkflowVersion

type SchedulerWorkflowVersion int64

type SpecBuilder

type SpecBuilder struct {
	// contains filtered or unexported fields
}

func NewSpecBuilder

func NewSpecBuilder() *SpecBuilder

func (*SpecBuilder) NewCompiledSpec

func (b *SpecBuilder) NewCompiledSpec(spec *schedpb.ScheduleSpec) (*CompiledSpec, error)