query

Documentation

Index

• type Registry
  • func NewRegistry() Registry
• type TerminationState
• type TerminationType

Types

type Registry

type Registry interface {
	HasBufferedQuery() bool
	GetBufferedIDs() []string
	HasCompletedQuery() bool
	GetCompletedIDs() []string
	HasUnblockedQuery() bool
	GetUnblockedIDs() []string
	HasFailedQuery() bool
	GetFailedIDs() []string

	GetQueryTermCh(string) (<-chan struct{}, error)
	GetQueryInput(string) (*shared.WorkflowQuery, error)
	GetTerminationState(string) (*TerminationState, error)

	BufferQuery(queryInput *shared.WorkflowQuery) (string, <-chan struct{})
	SetTerminationState(string, *TerminationState) error
	RemoveQuery(id string)
}

Registry manages all the queries for a workflow

func NewRegistry

func NewRegistry() Registry

NewRegistry creates a new query registry

type TerminationState

type TerminationState struct {
	TerminationType TerminationType
	QueryResult     *shared.WorkflowQueryResult
	Failure         error
}

TerminationState describes a query's termination state

type TerminationType

type TerminationType int

TerminationType is the type of a query's termination state

const (
	// TerminationTypeCompleted means a query reaches its termination state because it has been completed
	TerminationTypeCompleted TerminationType = iota
	// TerminationTypeUnblocked means a query reaches its termination state because it has been unblocked
	TerminationTypeUnblocked
	// TerminationTypeFailed means a query reaches its termination state because it has failed
	TerminationTypeFailed
)