cassandra

README

Using the cassandra schema tool

This package contains the tooling for temporal cassandra operations.

For localhost development

For the very first time run:

make

then run:

make install-schema

to create schema in your cassandra instance.

For production

Create the binaries

• Run make
• You should see an executable temporal-cassandra-tool

Do one time database creation and schema setup for a new cluster

This uses Cassandra's SimpleStratagey for replication. For production, we recommend using a replication factor of 3 with NetworkTopologyStrategy.

temporal-cassandra-tool --ep $CASSANDRA_SEEDS create -k $KEYSPACE --rf $RF

See https://www.ecyrd.com/cassandracalculator for an easy way to determine how many nodes and what replication factor you will want to use. Note that Temporal by default uses LOCAL_QUORUM and LOCAL_SERIAL for read and write consistency.

./temporal-cassandra-tool -ep 127.0.0.1 -k temporal setup-schema -v 0.0 -- this sets up just the schema version tables with initial version of 0.0
./temporal-cassandra-tool -ep 127.0.0.1 -k temporal update-schema -d ./schema/cassandra/temporal/versioned -- upgrades your schema to the latest version

./temporal-cassandra-tool -ep 127.0.0.1 -k temporal_visibility setup-schema -v 0.0 -- this sets up just the schema version tables with initial version of 0.0 for visibility
./temporal-cassandra-tool -ep 127.0.0.1 -k temporal_visibility update-schema -d ./schema/cassandra/visibility/versioned -- upgrades your schema to the latest version for visibility

Update schema as part of a release

You can only upgrade to a new version after the initial setup done above.

./temporal-cassandra-tool -ep 127.0.0.1 -k temporal update-schema -d ./schema/cassandra/temporal/versioned -v x.x    -- executes the upgrade to version x.x

./temporal-cassandra-tool -ep 127.0.0.1 -k temporal_visibility update-schema -d ./schema/cassandra/visibility/versioned -v x.x    -- executes the upgrade to version x.x

Documentation

Index

• func RunTool(args []string) error
• type CQLClientConfig
• type CQLClientTestSuite
  • func (s *CQLClientTestSuite) SetupSuite()
  • func (s *CQLClientTestSuite) SetupTest()
  • func (s *CQLClientTestSuite) TearDownSuite()
  • func (s *CQLClientTestSuite) TestCQLClient()
  • func (s *CQLClientTestSuite) TestParseCQLFile()
• type SetupSchemaConfig
• type SetupSchemaTestSuite
  • func (s *SetupSchemaTestSuite) SetupSuite()
  • func (s *SetupSchemaTestSuite) TearDownSuite()
  • func (s *SetupSchemaTestSuite) TestCreateKeyspace()
  • func (s *SetupSchemaTestSuite) TestSetupSchema()
• type UpdateSchemaTestSuite
  • func (s *UpdateSchemaTestSuite) SetupSuite()
  • func (s *UpdateSchemaTestSuite) TearDownSuite()
  • func (s *UpdateSchemaTestSuite) TestDryrun()
  • func (s *UpdateSchemaTestSuite) TestUpdateSchema()
  • func (s *UpdateSchemaTestSuite) TestVisibilityDryrun()
• type VersionTestSuite
  • func (s *VersionTestSuite) SetupTest()
  • func (s *VersionTestSuite) TestVerifyCompatibleVersion()

Functions

func RunTool

func RunTool(args []string) error

RunTool runs the temporal-cassandra-tool command line tool

Types

type CQLClientConfig

type CQLClientConfig struct {
	Hosts    string
	Port     int
	User     string
	Password string
	Keyspace string
	Timeout  int

	Datacenter               string
	Consistency              string
	TLS                      *auth.TLS
	DisableInitialHostLookup bool
	AddressTranslator        *config.CassandraAddressTranslator
	// contains filtered or unexported fields
}

CQLClientConfig contains the configuration for cql client

type CQLClientTestSuite

type CQLClientTestSuite struct {
	test.DBTestBase
}

func (*CQLClientTestSuite) SetupSuite

func (s *CQLClientTestSuite) SetupSuite()

func (*CQLClientTestSuite) SetupTest

func (s *CQLClientTestSuite) SetupTest()

func (*CQLClientTestSuite) TearDownSuite

func (s *CQLClientTestSuite) TearDownSuite()

func (*CQLClientTestSuite) TestCQLClient

func (s *CQLClientTestSuite) TestCQLClient()

func (*CQLClientTestSuite) TestParseCQLFile

func (s *CQLClientTestSuite) TestParseCQLFile()

type SetupSchemaConfig

type SetupSchemaConfig struct {
	CQLClientConfig
	schema.SetupConfig
}

SetupSchemaConfig contains the configuration params needed to setup schema tables

type SetupSchemaTestSuite

type SetupSchemaTestSuite struct {
	test.SetupSchemaTestBase
	// contains filtered or unexported fields
}

func (*SetupSchemaTestSuite) SetupSuite

func (s *SetupSchemaTestSuite) SetupSuite()

func (*SetupSchemaTestSuite) TearDownSuite

func (s *SetupSchemaTestSuite) TearDownSuite()

func (*SetupSchemaTestSuite) TestCreateKeyspace

func (s *SetupSchemaTestSuite) TestCreateKeyspace()

func (*SetupSchemaTestSuite) TestSetupSchema

func (s *SetupSchemaTestSuite) TestSetupSchema()

type UpdateSchemaTestSuite

type UpdateSchemaTestSuite struct {
	test.UpdateSchemaTestBase
}

func (*UpdateSchemaTestSuite) SetupSuite

func (s *UpdateSchemaTestSuite) SetupSuite()

func (*UpdateSchemaTestSuite) TearDownSuite

func (s *UpdateSchemaTestSuite) TearDownSuite()

func (*UpdateSchemaTestSuite) TestDryrun

func (s *UpdateSchemaTestSuite) TestDryrun()

func (*UpdateSchemaTestSuite) TestUpdateSchema

func (s *UpdateSchemaTestSuite) TestUpdateSchema()

func (*UpdateSchemaTestSuite) TestVisibilityDryrun

func (s *UpdateSchemaTestSuite) TestVisibilityDryrun()

type VersionTestSuite

type VersionTestSuite struct {
	*require.Assertions // override suite.Suite.Assertions with require.Assertions; this means that s.NotNil(nil) will stop the test, not merely log an error
	suite.Suite
}

func (*VersionTestSuite) SetupTest

func (s *VersionTestSuite) SetupTest()

func (*VersionTestSuite) TestVerifyCompatibleVersion

func (s *VersionTestSuite) TestVerifyCompatibleVersion()