sqlplugin

Documentation

Index

• type ActivityInfoMapsFilter
• type ActivityInfoMapsRow
• type AdminDB
• type BufferedEventsFilter
• type BufferedEventsRow
• type ChildExecutionInfoMapsFilter
• type ChildExecutionInfoMapsRow
• type Conn
• type CurrentExecutionsFilter
• type CurrentExecutionsRow
• type DB
• type DomainFilter
• type DomainMetadataRow
• type DomainRow
• type EventsFilter
• type EventsRow
• type ExecutionsFilter
• type ExecutionsRow
• type HistoryNodeFilter
• type HistoryNodeRow
• type HistoryTreeFilter
• type HistoryTreeRow
• type Plugin
• type QueueMetadataRow
• type QueueRow
• type ReplicationTaskDLQRow
• type ReplicationTasksDLQFilter
• type ReplicationTasksFilter
• type ReplicationTasksRow
• type RequestCancelInfoMapsFilter
• type RequestCancelInfoMapsRow
• type ShardsFilter
• type ShardsRow
• type SignalInfoMapsFilter
• type SignalInfoMapsRow
• type SignalsRequestedSetsFilter
• type SignalsRequestedSetsRow
• type TaskListsFilter
• type TaskListsRow
• type TasksFilter
• type TasksRow
• type TimerInfoMapsFilter
• type TimerInfoMapsRow
• type TimerTasksFilter
• type TimerTasksRow
• type TransferTasksFilter
• type TransferTasksRow
• type Tx
• type UUID
  • func MustParseUUID(s string) UUID
  • func UUIDPtr(u UUID) *UUID
  • func (u *UUID) Scan(src interface{}) error
  • func (u UUID) String() string
  • func (u UUID) Value() (driver.Value, error)
• type VisibilityFilter
• type VisibilityRow

Types

type ActivityInfoMapsFilter

type ActivityInfoMapsFilter struct {
	ShardID    int64
	DomainID   UUID
	WorkflowID string
	RunID      UUID
	ScheduleID *int64
}

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

type ActivityInfoMapsRow

type ActivityInfoMapsRow struct {
	ShardID                  int64
	DomainID                 UUID
	WorkflowID               string
	RunID                    UUID
	ScheduleID               int64
	Data                     []byte
	DataEncoding             string
	LastHeartbeatDetails     []byte
	LastHeartbeatUpdatedTime time.Time
}

ActivityInfoMapsRow represents a row in activity_info_maps table

type AdminDB

type AdminDB interface {
	PluginName() string
	Close() error
	// contains filtered or unexported methods
}

AdminDB defines the API for admin SQL operations for CLI and testing suites

type BufferedEventsFilter

type BufferedEventsFilter struct {
	ShardID    int
	DomainID   UUID
	WorkflowID string
	RunID      UUID
}

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

type BufferedEventsRow

type BufferedEventsRow struct {
	ShardID      int
	DomainID     UUID
	WorkflowID   string
	RunID        UUID
	Data         []byte
	DataEncoding string
}

BufferedEventsRow represents a row in buffered_events table

type ChildExecutionInfoMapsFilter

type ChildExecutionInfoMapsFilter struct {
	ShardID     int64
	DomainID    UUID
	WorkflowID  string
	RunID       UUID
	InitiatedID *int64
}

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

type ChildExecutionInfoMapsRow

type ChildExecutionInfoMapsRow struct {
	ShardID      int64
	DomainID     UUID
	WorkflowID   string
	RunID        UUID
	InitiatedID  int64
	Data         []byte
	DataEncoding string
}

ChildExecutionInfoMapsRow represents a row in child_execution_info_maps table

type Conn

type Conn interface {
	Exec(query string, args ...interface{}) (sql.Result, error)
	NamedExec(query string, arg interface{}) (sql.Result, error)
	Get(dest interface{}, query string, args ...interface{}) error
	Select(dest interface{}, query string, args ...interface{}) error
}

Conn defines the API for a single database connection

type CurrentExecutionsFilter

type CurrentExecutionsFilter struct {
	ShardID    int64
	DomainID   UUID
	WorkflowID string
	RunID      UUID
}

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

type CurrentExecutionsRow

type CurrentExecutionsRow struct {
	ShardID          int64
	DomainID         UUID
	WorkflowID       string
	RunID            UUID
	CreateRequestID  string
	State            int
	CloseStatus      int
	LastWriteVersion int64
	StartVersion     int64
}

CurrentExecutionsRow represents a row in current_executions table

type DB

type DB interface {
	BeginTx() (Tx, error)
	PluginName() string
	IsDupEntryError(err error) bool
	Close() error
	// contains filtered or unexported methods
}

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

type DomainFilter

type DomainFilter struct {
	ID            *UUID
	Name          *string
	GreaterThanID *UUID
	PageSize      *int
}

DomainFilter contains the column names within domain table that can be used to filter results through a WHERE clause. When ID is not nil, it will be used for WHERE condition. If ID is nil and Name is non-nil, Name will be used for WHERE condition. When both ID and Name are nil, no WHERE clause will be used

type DomainMetadataRow

type DomainMetadataRow struct {
	NotificationVersion int64
}

DomainMetadataRow represents a row in domain_metadata table

type DomainRow

type DomainRow struct {
	ID           UUID
	Name         string
	Data         []byte
	DataEncoding string
	IsGlobal     bool
}

DomainRow represents a row in domain table

type EventsFilter

type EventsFilter struct {
	DomainID     UUID
	WorkflowID   string
	RunID        UUID
	FirstEventID *int64
	NextEventID  *int64
	PageSize     *int
}

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

type EventsRow

type EventsRow struct {
	DomainID     UUID
	WorkflowID   string
	RunID        UUID
	FirstEventID int64
	BatchVersion int64
	RangeID      int64
	TxID         int64
	Data         []byte
	DataEncoding string
}

EventsRow represents a row in events table

type ExecutionsFilter

type ExecutionsFilter struct {
	ShardID    int
	DomainID   UUID
	WorkflowID string
	RunID      UUID
}

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

type ExecutionsRow

type ExecutionsRow struct {
	ShardID                  int
	DomainID                 UUID
	WorkflowID               string
	RunID                    UUID
	NextEventID              int64
	LastWriteVersion         int64
	Data                     []byte
	DataEncoding             string
	VersionHistories         []byte
	VersionHistoriesEncoding string
}

ExecutionsRow represents a row in executions table

type HistoryNodeFilter

type HistoryNodeFilter struct {
	ShardID  int
	TreeID   UUID
	BranchID UUID
	// Inclusive
	MinNodeID *int64
	// Exclusive
	MaxNodeID *int64
	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   UUID
	BranchID UUID
	NodeID   int64
	// use pointer so that it's easier to multiple by -1
	TxnID        *int64
	Data         []byte
	DataEncoding string
}

HistoryNodeRow represents a row in history_node table

type HistoryTreeFilter

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

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       UUID
	BranchID     UUID
	Data         []byte
	DataEncoding string
}

HistoryTreeRow represents a row in history_tree table

type Plugin

type Plugin interface {
	CreateDB(cfg *config.SQL) (DB, error)
	CreateAdminDB(cfg *config.SQL) (AdminDB, error)
}

Plugin defines the interface for any SQL database that needs to implement

type QueueMetadataRow

type QueueMetadataRow struct {
	QueueType persistence.QueueType
	Data      []byte
}

QueueMetadataRow represents a row in queue_metadata table

type QueueRow

type QueueRow struct {
	QueueType      persistence.QueueType
	MessageID      int64
	MessagePayload []byte
}

QueueRow represents a row in queue table

type ReplicationTaskDLQRow

type ReplicationTaskDLQRow struct {
	SourceClusterName string
	ShardID           int
	TaskID            int64
	Data              []byte
	DataEncoding      string
}

ReplicationTaskDLQRow represents a row in replication_tasks_dlq table

type ReplicationTasksDLQFilter

type ReplicationTasksDLQFilter struct {
	ReplicationTasksFilter
	SourceClusterName string
}

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

type ReplicationTasksFilter

type ReplicationTasksFilter struct {
	ShardID            int
	TaskID             int64
	InclusiveEndTaskID int64
	MinTaskID          int64
	MaxTaskID          int64
	PageSize           int
}

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

type ReplicationTasksRow

type ReplicationTasksRow struct {
	ShardID      int
	TaskID       int64
	Data         []byte
	DataEncoding string
}

ReplicationTasksRow represents a row in replication_tasks table

type RequestCancelInfoMapsFilter

type RequestCancelInfoMapsFilter struct {
	ShardID     int64
	DomainID    UUID
	WorkflowID  string
	RunID       UUID
	InitiatedID *int64
}

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

type RequestCancelInfoMapsRow

type RequestCancelInfoMapsRow struct {
	ShardID      int64
	DomainID     UUID
	WorkflowID   string
	RunID        UUID
	InitiatedID  int64
	Data         []byte
	DataEncoding string
}

RequestCancelInfoMapsRow represents a row in request_cancel_info_maps table

type ShardsFilter

type ShardsFilter struct {
	ShardID int64
}

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

type ShardsRow

type ShardsRow struct {
	ShardID      int64
	RangeID      int64
	Data         []byte
	DataEncoding string
}

ShardsRow represents a row in shards table

type SignalInfoMapsFilter

type SignalInfoMapsFilter struct {
	ShardID     int64
	DomainID    UUID
	WorkflowID  string
	RunID       UUID
	InitiatedID *int64
}

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

type SignalInfoMapsRow

type SignalInfoMapsRow struct {
	ShardID      int64
	DomainID     UUID
	WorkflowID   string
	RunID        UUID
	InitiatedID  int64
	Data         []byte
	DataEncoding string
}

SignalInfoMapsRow represents a row in signal_info_maps table

type SignalsRequestedSetsFilter

type SignalsRequestedSetsFilter struct {
	ShardID    int64
	DomainID   UUID
	WorkflowID string
	RunID      UUID
	SignalID   *string
}

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

type SignalsRequestedSetsRow

type SignalsRequestedSetsRow struct {
	ShardID    int64
	DomainID   UUID
	WorkflowID string
	RunID      UUID
	SignalID   string
}

SignalsRequestedSetsRow represents a row in signals_requested_sets table

type TaskListsFilter

type TaskListsFilter struct {
	ShardID             int
	DomainID            *UUID
	Name                *string
	TaskType            *int64
	DomainIDGreaterThan *UUID
	NameGreaterThan     *string
	TaskTypeGreaterThan *int64
	RangeID             *int64
	PageSize            *int
}

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

type TaskListsRow

type TaskListsRow struct {
	ShardID      int
	DomainID     UUID
	Name         string
	TaskType     int64
	RangeID      int64
	Data         []byte
	DataEncoding string
}

TaskListsRow represents a row in task_lists table

type TasksFilter

type TasksFilter struct {
	DomainID             UUID
	TaskListName         string
	TaskType             int64
	TaskID               *int64
	MinTaskID            *int64
	MaxTaskID            *int64
	TaskIDLessThanEquals *int64
	Limit                *int
	PageSize             *int
}

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

type TasksRow

type TasksRow struct {
	DomainID     UUID
	TaskType     int64
	TaskID       int64
	TaskListName string
	Data         []byte
	DataEncoding string
}

TasksRow represents a row in tasks table

type TimerInfoMapsFilter

type TimerInfoMapsFilter struct {
	ShardID    int64
	DomainID   UUID
	WorkflowID string
	RunID      UUID
	TimerID    *string
}

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

type TimerInfoMapsRow

type TimerInfoMapsRow struct {
	ShardID      int64
	DomainID     UUID
	WorkflowID   string
	RunID        UUID
	TimerID      string
	Data         []byte
	DataEncoding string
}

TimerInfoMapsRow represents a row in timer_info_maps table

type TimerTasksFilter

type TimerTasksFilter struct {
	ShardID                int
	TaskID                 int64
	VisibilityTimestamp    *time.Time
	MinVisibilityTimestamp *time.Time
	MaxVisibilityTimestamp *time.Time
	PageSize               *int
}

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

type TimerTasksRow

type TimerTasksRow struct {
	ShardID             int
	VisibilityTimestamp time.Time
	TaskID              int64
	Data                []byte
	DataEncoding        string
}

TimerTasksRow represents a row in timer_tasks table

type TransferTasksFilter

type TransferTasksFilter struct {
	ShardID   int
	TaskID    *int64
	MinTaskID *int64
	MaxTaskID *int64
}

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

type TransferTasksRow

type TransferTasksRow struct {
	ShardID      int
	TaskID       int64
	Data         []byte
	DataEncoding string
}

TransferTasksRow represents a row in transfer_tasks table

type Tx

type Tx interface {
	Commit() error
	Rollback() error
	// contains filtered or unexported methods
}

Tx defines the API for a SQL transaction

type UUID

type UUID []byte

UUID represents a 16-byte universally unique identifier this type is a wrapper around google/uuid with the following differences

• type is a byte slice instead of [16]byte
• db serialization converts uuid to bytes as opposed to string

func MustParseUUID

func MustParseUUID(s string) UUID

MustParseUUID returns a UUID parsed from the given string representation returns nil if the input is empty string panics if the given input is malformed

func UUIDPtr

func UUIDPtr(u UUID) *UUID

UUIDPtr simply returns a pointer for the given value type

func (*UUID) Scan

func (u *UUID) Scan(src interface{}) error

Scan implements sql.Scanner interface to allow this type to be parsed transparently by database drivers

func (UUID) String

func (u UUID) String() string

String returns the 36 byet hexstring representation of this uuid return empty string if this uuid is nil

func (UUID) Value

func (u UUID) Value() (driver.Value, error)

Value implements sql.Valuer so that UUIDs can be written to databases transparently. This method returns a byte slice representation of uuid

type VisibilityFilter

type VisibilityFilter struct {
	DomainID         string
	Closed           bool
	RunID            *string
	WorkflowID       *string
	WorkflowTypeName *string
	CloseStatus      *int32
	MinStartTime     *time.Time
	MaxStartTime     *time.Time
	PageSize         *int
}

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

type VisibilityRow

type VisibilityRow struct {
	DomainID         string
	RunID            string
	WorkflowTypeName string
	WorkflowID       string
	StartTime        time.Time
	ExecutionTime    time.Time
	CloseStatus      *int32
	CloseTime        *time.Time
	HistoryLength    *int64
	Memo             []byte
	Encoding         string
}

VisibilityRow represents a row in executions_visibility table