nosqlplugin

Documentation

Index

• func NewConditionFailure(name string) error
• type ClientErrorChecker
• type ConditionFailure
  • func (e *ConditionFailure) Error() string
• type ConflictedShardRow
• type CrossClusterTask
• type CurrentWorkflowRow
• type CurrentWorkflowWriteCondition
  • func (w *CurrentWorkflowWriteCondition) GetCurrentRunID() string
• type CurrentWorkflowWriteMode
• type CurrentWorkflowWriteRequest
• type DB
• type DomainRow
• type HistoryNodeFilter
• type HistoryNodeRow
• type HistoryTreeFilter
• type HistoryTreeRow
• type ListTaskListResult
• type NoSQLInternalDomainConfig
• type QueueMessageRow
• type QueueMetadataRow
• type ReplicationTask
• type SelectMessagesBetweenRequest
• type SelectMessagesBetweenResponse
• type SelectVisibilityResponse
• type ShardCondition
• type ShardOperationConditionFailure
  • func (e *ShardOperationConditionFailure) Error() string
• type ShardRow
• type TaskListFilter
• type TaskListRow
• type TaskOperationConditionFailure
  • func (e *TaskOperationConditionFailure) Error() string
• type TaskRow
• type TaskRowForInsert
• type TasksFilter
• type TimerTask
• type TransferTask
• type VisibilityFilter
• type VisibilityFilterType
• type VisibilityRow
• type VisibilityRowForInsert
• type VisibilityRowForUpdate
• type VisibilitySortType
• type WorkflowExecutionAlreadyExists
• type WorkflowExecutionRow
• type WorkflowOperationConditionFailure
  • func (e *WorkflowOperationConditionFailure) Error() string

Functions

func NewConditionFailure

func NewConditionFailure(name string) error

Types

type ClientErrorChecker

type ClientErrorChecker interface {
	IsTimeoutError(error) bool
	IsNotFoundError(error) bool
	IsThrottlingError(error) bool
}

ClientErrorChecker checks for common nosql errors on client

type ConditionFailure

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

Condition Errors for NoSQL interfaces

func (*ConditionFailure) Error

func (e *ConditionFailure) Error() string

type ConflictedShardRow

type ConflictedShardRow struct {
	ShardID int
	// PreviousRangeID is the condition of previous change that used for conditional update
	PreviousRangeID int64
	// optional detailed information for logging purpose
	Details string
}

ConflictedShardRow contains the partial information about a shard returned when a conditional write fails

type CrossClusterTask

type CrossClusterTask struct {
	TransferTask
	TargetCluster string
}

type CurrentWorkflowRow

type CurrentWorkflowRow struct {
	ShardID          int
	DomainID         string
	WorkflowID       string
	RunID            string
	State            int
	CloseStatus      int
	CreateRequestID  string
	LastWriteVersion int64
}

type CurrentWorkflowWriteCondition

type CurrentWorkflowWriteCondition struct {
	CurrentRunID     *string
	LastWriteVersion *int64
	State            *int
}

func (*CurrentWorkflowWriteCondition) GetCurrentRunID

func (w *CurrentWorkflowWriteCondition) GetCurrentRunID() string

type CurrentWorkflowWriteMode

type CurrentWorkflowWriteMode int

const (
	CurrentWorkflowWriteModeNoop CurrentWorkflowWriteMode = iota
	CurrentWorkflowWriteModeUpdate
	CurrentWorkflowWriteModeInsert
)

type CurrentWorkflowWriteRequest

type CurrentWorkflowWriteRequest struct {
	WriteMode CurrentWorkflowWriteMode
	Row       CurrentWorkflowRow
	Condition *CurrentWorkflowWriteCondition
}

type DB

type DB interface {
	PluginName() string
	Close()

	ClientErrorChecker
	// contains filtered or unexported methods
}

DB defines the API for regular NoSQL operations of a Cadence server

type DomainRow

type DomainRow struct {
	Info                        *persistence.DomainInfo
	Config                      *NoSQLInternalDomainConfig
	ReplicationConfig           *persistence.DomainReplicationConfig
	ConfigVersion               int64
	FailoverVersion             int64
	FailoverNotificationVersion int64
	PreviousFailoverVersion     int64
	FailoverEndTime             *time.Time
	NotificationVersion         int64
	LastUpdatedTime             time.Time
	IsGlobalDomain              bool
}

DomainRow defines the row struct for queue message

type HistoryNodeFilter

type HistoryNodeFilter struct {
	ShardID  int
	TreeID   string
	BranchID string
	// Inclusive
	MinNodeID int64
	// Exclusive
	MaxNodeID     int64
	NextPageToken []byte
	PageSize      int
}

HistoryNodeFilter contains the column names within history_node table that can be used to filter results through a WHERE clause

type HistoryNodeRow

type HistoryNodeRow struct {
	ShardID  int
	TreeID   string
	BranchID string
	NodeID   int64
	// Note: use pointer so that it's easier to multiple by -1 if needed
	TxnID        *int64
	Data         []byte
	DataEncoding string
}

HistoryNodeRow represents a row in history_node table

type HistoryTreeFilter

type HistoryTreeFilter struct {
	ShardID  int
	TreeID   string
	BranchID *string
}

HistoryTreeFilter contains the column names within history_tree table that can be used to filter results through a WHERE clause

type HistoryTreeRow

type HistoryTreeRow struct {
	ShardID         int
	TreeID          string
	BranchID        string
	Ancestors       []*types.HistoryBranchRange
	CreateTimestamp time.Time
	Info            string
}

HistoryTreeRow represents a row in history_tree table

type ListTaskListResult

type ListTaskListResult struct {
	TaskLists     []*TaskListRow
	NextPageToken []byte
}

type NoSQLInternalDomainConfig

type NoSQLInternalDomainConfig struct {
	Retention                time.Duration
	EmitMetric               bool                 // deprecated
	ArchivalBucket           string               // deprecated
	ArchivalStatus           types.ArchivalStatus // deprecated
	HistoryArchivalStatus    types.ArchivalStatus
	HistoryArchivalURI       string
	VisibilityArchivalStatus types.ArchivalStatus
	VisibilityArchivalURI    string
	BadBinaries              *persistence.DataBlob
}

NoSQLInternalDomainConfig defines the struct for the domainConfig

type QueueMessageRow

type QueueMessageRow struct {
	QueueType persistence.QueueType
	ID        int64
	Payload   []byte
}

QueueMessageRow defines the row struct for queue message

type QueueMetadataRow

type QueueMetadataRow struct {
	QueueType        persistence.QueueType
	ClusterAckLevels map[string]int64
	Version          int64
}

QueueMetadataRow defines the row struct for metadata

type ReplicationTask

type ReplicationTask struct {
	Type int

	DomainID            string
	WorkflowID          string
	RunID               string
	VisibilityTimestamp time.Time
	TaskID              int64
	FirstEventID        int64
	NextEventID         int64
	Version             int64
	ActivityScheduleID  int64
	EventStoreVersion   int
	BranchToken         []byte
	NewRunBranchToken   []byte
}

type SelectMessagesBetweenRequest

type SelectMessagesBetweenRequest struct {
	QueueType               persistence.QueueType
	ExclusiveBeginMessageID int64
	InclusiveEndMessageID   int64
	PageSize                int
	NextPageToken           []byte
}

SelectMessagesBetweenRequest is a request struct for SelectMessagesBetween

type SelectMessagesBetweenResponse

type SelectMessagesBetweenResponse struct {
	Rows          []QueueMessageRow
	NextPageToken []byte
}

SelectMessagesBetweenResponse is a response struct for SelectMessagesBetween

type SelectVisibilityResponse

type SelectVisibilityResponse struct {
	Executions    []*VisibilityRow
	NextPageToken []byte
}

type ShardCondition

type ShardCondition struct {
	ShardID int
	RangeID int64
}

type ShardOperationConditionFailure

type ShardOperationConditionFailure struct {
	RangeID int64
	Details string // detail info for logging
}

Condition Errors for NoSQL interfaces

func (*ShardOperationConditionFailure) Error

func (e *ShardOperationConditionFailure) Error() string

type ShardRow

type ShardRow = persistence.InternalShardInfo

For now ShardRow is the same as persistence.InternalShardInfo Separate them later when there is a need.

type TaskListFilter

type TaskListFilter struct {
	DomainID     string
	TaskListName string
	TaskListType int
}

type TaskListRow

type TaskListRow struct {
	DomainID     string
	TaskListName string
	TaskListType int

	RangeID         int64
	TaskListKind    int
	AckLevel        int64
	LastUpdatedTime time.Time
}

type TaskOperationConditionFailure

type TaskOperationConditionFailure struct {
	RangeID int64
	Details string // detail info for logging
}

Condition Errors for NoSQL interfaces

func (*TaskOperationConditionFailure) Error

func (e *TaskOperationConditionFailure) Error() string

type TaskRow

type TaskRow struct {
	DomainID     string
	TaskListName string
	TaskListType int
	TaskID       int64

	WorkflowID  string
	RunID       string
	ScheduledID int64
	CreatedTime time.Time
}

type TaskRowForInsert

type TaskRowForInsert struct {
	TaskRow
	// <= 0 means no TTL
	TTLSeconds int
}

type TasksFilter

type TasksFilter struct {
	TaskListFilter
	// Exclusive
	MinTaskID int64
	// Inclusive
	MaxTaskID int64
	BatchSize int
}

type TimerTask

type TimerTask struct {
	Type int

	DomainID            string
	WorkflowID          string
	RunID               string
	VisibilityTimestamp time.Time
	TaskID              int64

	TimeoutType int
	EventID     int64
	Attempt     int64
	Version     int64
}

type TransferTask

type TransferTask struct {
	Type                    int
	DomainID                string
	WorkflowID              string
	RunID                   string
	VisibilityTimestamp     time.Time
	TaskID                  int64
	TargetDomainID          string
	TargetWorkflowID        string
	TargetRunID             string
	TargetChildWorkflowOnly bool
	TaskList                string
	ScheduleID              int64
	RecordVisibility        bool
	Version                 int64
}

type VisibilityFilter

type VisibilityFilter struct {
	ListRequest  persistence.InternalListWorkflowExecutionsRequest
	FilterType   VisibilityFilterType
	SortType     VisibilitySortType
	WorkflowType string
	WorkflowID   string
	CloseStatus  int32
}

VisibilityFilter contains the column names within executions_visibility table that can be used to filter results through a WHERE clause

type VisibilityFilterType

type VisibilityFilterType int

const (
	AllOpen VisibilityFilterType = iota
	AllClosed
	OpenByWorkflowType
	ClosedByWorkflowType
	OpenByWorkflowID
	ClosedByWorkflowID
	ClosedByClosedStatus
)

type VisibilityRow

type VisibilityRow = persistence.InternalVisibilityWorkflowExecutionInfo

TODO separate in the future when need it

type VisibilityRowForInsert

type VisibilityRowForInsert struct {
	VisibilityRow
	DomainID string
}

type VisibilityRowForUpdate

type VisibilityRowForUpdate struct {
	VisibilityRow
	DomainID string
	// NOTE: this is only for some implementation (e.g. Cassandra) that uses multiple tables,
	// they needs to delete record from the open execution table. Ignore this field if not need it
	UpdateOpenToClose bool
	//  Similar as UpdateOpenToClose
	UpdateCloseToOpen bool
}

type VisibilitySortType

type VisibilitySortType int

const (
	SortByStartTime VisibilitySortType = iota
	SortByClosedTime
)

type WorkflowExecutionAlreadyExists

type WorkflowExecutionAlreadyExists struct {
	RunID            string
	CreateRequestID  string
	State            int
	CloseStatus      int
	LastWriteVersion int64
	OtherInfo        string
}

Condition Errors for NoSQL interfaces

type WorkflowExecutionRow

type WorkflowExecutionRow struct {
	persistence.InternalWorkflowExecutionInfo
	VersionHistories *persistence.DataBlob
	Checksums        *checksum.Checksum
	LastWriteVersion int64
}

type WorkflowOperationConditionFailure

type WorkflowOperationConditionFailure struct {
	UnknownConditionFailureDetails   *string // return some info for logging
	ShardRangeIDNotMatch             *int64  // return the previous shardRangeID
	WorkflowExecutionAlreadyExists   *WorkflowExecutionAlreadyExists
	CurrentWorkflowConditionFailInfo *string // return the logging info if fail on condition of CurrentWorkflow
}

Only one of the fields must be non-nil

func (*WorkflowOperationConditionFailure) Error

func (e *WorkflowOperationConditionFailure) Error() string