cassandra

package
v4.17.0-clickv2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 15, 2024 License: MIT Imports: 12 Imported by: 0

README

Cassandra / ScyllaDB

  • Drop() method will not work on Cassandra 2.X because it rely on system_schema table which comes with 3.X
  • Other methods should work properly but are not tested
  • The Cassandra driver (gocql) does not natively support executing multiple statements in a single query. To allow for multiple statements in a single migration, you can use the x-multi-statement param. There are two important caveats:
    • This mode splits the migration text into separately-executed statements by a semi-colon ;. Thus x-multi-statement cannot be used when a statement in the migration contains a string with a semi-colon.
    • The queries are not executed in any sort of transaction/batch, meaning you are responsible for fixing partial migrations.

ScyllaDB

  • No additional configuration is required since it is a drop-in replacement for Cassandra.
  • The Drop() method` works for ScyllaDB 5.1

Usage

cassandra://host:port/keyspace?param1=value&param2=value2

URL Query Default value Description
x-migrations-table schema_migrations Name of the migrations table
x-multi-statement false Enable multiple statements to be ran in a single migration (See note above)
port 9042 The port to bind to
consistency ALL Migration consistency
protocol Cassandra protocol version (3 or 4)
timeout 1 minute Migration timeout
connect-timeout 600ms Initial connection timeout to the cluster
username nil Username to use when authenticating.
password nil Password to use when authenticating.
sslcert Cert file location. The file must contain PEM encoded data.
sslkey Key file location. The file must contain PEM encoded data.
sslrootcert The location of the root certificate file. The file must contain PEM encoded data.
sslmode Whether or not to use SSL (disable|require|verify-ca|verify-full)
disable-host-lookup false Disable initial host lookup.

timeout is parsed using time.ParseDuration(s string)

Upgrading from v1

  1. Write down the current migration version from schema_migrations
  2. DROP TABLE schema_migrations
  3. Download and install the latest migrate version.
  4. Force the current migration version with migrate force <current_version>.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrNilConfig     = errors.New("no config")
	ErrNoKeyspace    = errors.New("no keyspace provided")
	ErrDatabaseDirty = errors.New("database is dirty")
	ErrClosedSession = errors.New("session is closed")
)
View Source
var DefaultMigrationsTable = "schema_migrations"
View Source
var (
	DefaultMultiStatementMaxSize = 10 * 1 << 20 // 10 MB
)

Functions

func WithInstance

func WithInstance(session *gocql.Session, config *Config) (database.Driver, error)

Types

type Cassandra

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

func (*Cassandra) Close

func (c *Cassandra) Close() error

func (*Cassandra) Drop

func (c *Cassandra) Drop() error

func (*Cassandra) Lock

func (c *Cassandra) Lock() error

func (*Cassandra) Open

func (c *Cassandra) Open(url string) (database.Driver, error)

func (*Cassandra) Run

func (c *Cassandra) Run(migration io.Reader) error

func (*Cassandra) SetVersion

func (c *Cassandra) SetVersion(version int, dirty bool) error

func (*Cassandra) Unlock

func (c *Cassandra) Unlock() error

func (*Cassandra) Version

func (c *Cassandra) Version() (version int, dirty bool, err error)

Return current keyspace version

type Config

type Config struct {
	MigrationsTable       string
	KeyspaceName          string
	MultiStatementEnabled bool
	MultiStatementMaxSize int
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL