executions

Documentation

Index

• Constants
• func ConcreteExecutionConfig(dc *dynamicconfig.Collection) *shardscanner.ScannerConfig
• func ConcreteFixerWorkflow(ctx workflow.Context, params shardscanner.FixerWorkflowParams) error
• func ConcreteScannerWorkflow(ctx workflow.Context, params shardscanner.ScannerWorkflowParams) error
• func CurrentExecutionConfig(dc *dynamicconfig.Collection) *shardscanner.ScannerConfig
• func CurrentFixerWorkflow(ctx workflow.Context, params shardscanner.FixerWorkflowParams) error
• func CurrentScannerWorkflow(ctx workflow.Context, params shardscanner.ScannerWorkflowParams) error
• func ParseCollections(params shardscanner.CustomScannerConfig) []invariant.Collection
• func ScanTypeStrings() []string
• type ExecutionFetcher
• type InvariantFactory
• type ScanType
  • func ScanTypeString(s string) (ScanType, error)
  • func ScanTypeValues() []ScanType
  • func (i ScanType) IsAScanType() bool
  • func (i ScanType) String() string
  • func (st ScanType) ToBlobstoreEntity() entity.Entity
  • func (st ScanType) ToExecutionFetcher() ExecutionFetcher
  • func (st ScanType) ToInvariants(collections []invariant.Collection, logger *zap.Logger) []InvariantFactory
  • func (st ScanType) ToIterator() ...

Constants

const (
	// ConcreteExecutionsScannerWFTypeName defines workflow type name for concrete executions scanner
	ConcreteExecutionsScannerWFTypeName = "cadence-sys-executions-scanner-workflow"

	// ConcreteExecutionsFixerWFTypeName defines workflow type name for concrete executions fixer
	ConcreteExecutionsFixerWFTypeName = "cadence-sys-executions-fixer-workflow"
)

const (

	// CurrentExecutionsScannerWFTypeName is the current execution scanner workflow type
	CurrentExecutionsScannerWFTypeName = "cadence-sys-current-executions-scanner-workflow"
	// CurrentExecutionsScannerTaskListName is the current execution scanner workflow tasklist
	CurrentExecutionsScannerTaskListName = "cadence-sys-current-executions-scanner-tasklist-0"

	// CurrentExecutionsFixerWFTypeName is the current execution fixer workflow ID
	CurrentExecutionsFixerWFTypeName = "cadence-sys-current-executions-fixer-workflow"

	// CurrentExecutionsFixerTaskListName is the current execution fixer workflow tasklist
	CurrentExecutionsFixerTaskListName = "cadence-sys-current-executions-fixer-tasklist-0"
)

Functions

func ConcreteExecutionConfig

func ConcreteExecutionConfig(dc *dynamicconfig.Collection) *shardscanner.ScannerConfig

ConcreteExecutionConfig configures concrete execution scanner

func ConcreteFixerWorkflow

func ConcreteFixerWorkflow(
	ctx workflow.Context,
	params shardscanner.FixerWorkflowParams,
) error

ConcreteFixerWorkflow starts concrete executions fixer.

func ConcreteScannerWorkflow

func ConcreteScannerWorkflow(ctx workflow.Context, params shardscanner.ScannerWorkflowParams) error

ConcreteScannerWorkflow starts concrete executions scanner.

func CurrentExecutionConfig

func CurrentExecutionConfig(dc *dynamicconfig.Collection) *shardscanner.ScannerConfig

CurrentExecutionConfig configures current execution scanner

func CurrentFixerWorkflow

func CurrentFixerWorkflow(
	ctx workflow.Context,
	params shardscanner.FixerWorkflowParams,
) error

CurrentFixerWorkflow starts current executions fixer.

func CurrentScannerWorkflow

func CurrentScannerWorkflow(
	ctx workflow.Context,
	params shardscanner.ScannerWorkflowParams,
) error

CurrentScannerWorkflow is the workflow that scans over all current executions

func ParseCollections

func ParseCollections(params shardscanner.CustomScannerConfig) []invariant.Collection

ParseCollections converts string based map to list of collections

func ScanTypeStrings

func ScanTypeStrings() []string

ScanTypeStrings returns a slice of all String values of the enum

Types

type ExecutionFetcher

type ExecutionFetcher func(ctx context.Context, retryer persistence.Retryer, request fetcher.ExecutionRequest) (entity.Entity, error)

ExecutionFetcher represents a function which returns specific execution entity

type InvariantFactory

type InvariantFactory func(retryer persistence.Retryer, domainCache cache.DomainCache) invariant.Invariant

InvariantFactory represents a function which returns Invariant

type ScanType

type ScanType int

ScanType is the enum for representing different entity types to scan

const (
	// ConcreteExecutionType concrete execution entity
	ConcreteExecutionType ScanType = iota
	// CurrentExecutionType current execution entity
	CurrentExecutionType
)

func ScanTypeString

func ScanTypeString(s string) (ScanType, error)

ScanTypeString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ScanTypeValues

func ScanTypeValues() []ScanType

ScanTypeValues returns all values of the enum

func (ScanType) IsAScanType

func (i ScanType) IsAScanType() bool

IsAScanType returns "true" if the value is listed in the enum definition. "false" otherwise

func (ScanType) String

func (i ScanType) String() string

func (ScanType) ToBlobstoreEntity

func (st ScanType) ToBlobstoreEntity() entity.Entity

ToBlobstoreEntity picks struct depending on scanner type.

func (ScanType) ToExecutionFetcher

func (st ScanType) ToExecutionFetcher() ExecutionFetcher

ToExecutionFetcher selects appropriate execution fetcher. Fetcher returns single execution entity. It will panic if scan type is unknown.

func (ScanType) ToInvariants

func (st ScanType) ToInvariants(collections []invariant.Collection, logger *zap.Logger) []InvariantFactory

ToInvariants returns list of invariants to be checked depending on scan type.

func (ScanType) ToIterator

func (st ScanType) ToIterator() func(ctx context.Context, retryer persistence.Retryer, pageSize int) pagination.Iterator

ToIterator selects appropriate iterator. It will panic if scan type is unknown.