sql

Documentation

Index

• Constants
• func NewSQLAdminDB(dbKind sqlplugin.DbKind, cfg *config.SQL, r resolver.ServiceResolver) (sqlplugin.AdminDB, error)
• func NewSQLDB(dbKind sqlplugin.DbKind, cfg *config.SQL, r resolver.ServiceResolver) (sqlplugin.DB, error)
• func NewSQLExecutionStore(db sqlplugin.DB, logger log.Logger, shardID int32) (p.ExecutionStore, error)
• func NewSQLVisibilityStore(db sqlplugin.DB, logger log.Logger) (p.VisibilityStore, error)
• func RegisterPlugin(pluginName string, plugin sqlplugin.Plugin)
• func VerifyCompatibleVersion(cfg config.Persistence, r resolver.ServiceResolver, checkVisibility bool) error
• type Factory
  • func NewFactory(cfg config.SQL, r resolver.ServiceResolver, clusterName string, ...) *Factory
  • func (f *Factory) Close()
  • func (f *Factory) NewClusterMetadataStore() (p.ClusterMetadataStore, error)
  • func (f *Factory) NewExecutionStore(shardID int32) (p.ExecutionStore, error)
  • func (f *Factory) NewHistoryStore() (p.HistoryStore, error)
  • func (f *Factory) NewMetadataStore() (p.MetadataStore, error)
  • func (f *Factory) NewQueue(queueType p.QueueType) (p.Queue, error)
  • func (f *Factory) NewShardStore() (p.ShardStore, error)
  • func (f *Factory) NewTaskStore() (p.TaskStore, error)
  • func (f *Factory) NewVisibilityStore() (p.VisibilityStore, error)
• type TestCluster
  • func NewTestCluster(pluginName string, dbName string, username string, password string, ...) *TestCluster
  • func (s *TestCluster) Config() config.Persistence
  • func (s *TestCluster) CreateDatabase()
  • func (s *TestCluster) DatabaseName() string
  • func (s *TestCluster) DropDatabase()
  • func (s *TestCluster) LoadSchema(schemaFile string)
  • func (s *TestCluster) SetupTestDatabase()
  • func (s *TestCluster) TearDownTestDatabase()

Constants

const (
	// NOTE: transaction ID is *= -1 in DB
	MinTxnID = math.MaxInt64
)

Functions

func NewSQLAdminDB

func NewSQLAdminDB(
	dbKind sqlplugin.DbKind,
	cfg *config.SQL,
	r resolver.ServiceResolver,
) (sqlplugin.AdminDB, error)

NewSQLAdminDB returns a AdminDB

func NewSQLDB

func NewSQLDB(
	dbKind sqlplugin.DbKind,
	cfg *config.SQL,
	r resolver.ServiceResolver,
) (sqlplugin.DB, error)

NewSQLDB creates a returns a reference to a logical connection to the underlying SQL database. The returned object is to tied to a single SQL database and the object can be used to perform CRUD operations on the tables in the database

func NewSQLExecutionStore

func NewSQLExecutionStore(
	db sqlplugin.DB,
	logger log.Logger,
	shardID int32,
) (p.ExecutionStore, error)

NewSQLExecutionStore creates an instance of ExecutionStore

func NewSQLVisibilityStore

func NewSQLVisibilityStore(
	db sqlplugin.DB,
	logger log.Logger,
) (p.VisibilityStore, error)

NewSQLVisibilityStore creates an instance of ExecutionStore

func RegisterPlugin

func RegisterPlugin(pluginName string, plugin sqlplugin.Plugin)

RegisterPlugin will register a SQL plugin

func VerifyCompatibleVersion

func VerifyCompatibleVersion(
	cfg config.Persistence,
	r resolver.ServiceResolver,
	checkVisibility bool,
) error

VerifyCompatibleVersion ensures that the installed version of temporal and visibility is greater than or equal to the expected version.

Types

type Factory

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

Factory vends store objects backed by MySQL

func NewFactory

func NewFactory(
	cfg config.SQL,
	r resolver.ServiceResolver,
	clusterName string,
	logger log.Logger,
) *Factory

NewFactory returns an instance of a factory object which can be used to create datastores backed by any kind of SQL store

func (*Factory) Close

func (f *Factory) Close()

Close closes the factory

func (*Factory) NewClusterMetadataStore

func (f *Factory) NewClusterMetadataStore() (p.ClusterMetadataStore, error)

NewClusterMetadataStore returns a new ClusterMetadata store

func (*Factory) NewExecutionStore

func (f *Factory) NewExecutionStore(shardID int32) (p.ExecutionStore, error)

NewExecutionStore returns an ExecutionStore for a given shardID

func (*Factory) NewHistoryStore

func (f *Factory) NewHistoryStore() (p.HistoryStore, error)

NewHistoryStore returns a new history store

func (*Factory) NewMetadataStore

func (f *Factory) NewMetadataStore() (p.MetadataStore, error)

NewMetadataStore returns a new metadata store

func (*Factory) NewQueue

func (f *Factory) NewQueue(queueType p.QueueType) (p.Queue, error)

NewQueue returns a new queue backed by sql

func (*Factory) NewShardStore

func (f *Factory) NewShardStore() (p.ShardStore, error)

NewShardStore returns a new shard store

func (*Factory) NewTaskStore

func (f *Factory) NewTaskStore() (p.TaskStore, error)

NewTaskStore returns a new task store

func (*Factory) NewVisibilityStore

func (f *Factory) NewVisibilityStore() (p.VisibilityStore, error)

NewVisibilityStore returns a visibility store

type TestCluster

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

TestCluster allows executing cassandra operations in testing.

func NewTestCluster

func NewTestCluster(
	pluginName string,
	dbName string,
	username string,
	password string,
	host string,
	port int,
	schemaDir string,
	logger log.Logger,
) *TestCluster

NewTestCluster returns a new SQL test cluster

func (*TestCluster) Config

func (s *TestCluster) Config() config.Persistence

Config returns the persistence config for connecting to this test cluster

func (*TestCluster) CreateDatabase

func (s *TestCluster) CreateDatabase()

CreateDatabase from PersistenceTestCluster interface

func (*TestCluster) DatabaseName

func (s *TestCluster) DatabaseName() string

DatabaseName from PersistenceTestCluster interface

func (*TestCluster) DropDatabase

func (s *TestCluster) DropDatabase()

DropDatabase from PersistenceTestCluster interface

func (*TestCluster) LoadSchema

func (s *TestCluster) LoadSchema(schemaFile string)

LoadSchema from PersistenceTestCluster interface

func (*TestCluster) SetupTestDatabase

func (s *TestCluster) SetupTestDatabase()

SetupTestDatabase from PersistenceTestCluster interface

func (*TestCluster) TearDownTestDatabase

func (s *TestCluster) TearDownTestDatabase()

TearDownTestDatabase from PersistenceTestCluster interface