Package: cstar-migrate
Cassandra schema migration tool, a fork ofcassandra-migrate.InstallationRunpython-mpip installcstar-migrate.ReasoningUnlike other available tools, this one:Written in Python for easy installationDoes not requirecqlsh, just the Cassandra Python driverSupports baselining existing database to given versionsSupports partial advancementSupports locking for concurrent instances using Lightweight TransactionsVerifies stored migrations against configured migrationsStores content, checksum, date and state of every migrationSupports deploying with different keyspace configurations for different environmentsSupports cql and python scripts migrationsConfigurationDatabases are configured through YAML files. For example:keyspace:cstarprofiles:prod:replication:class:SimpleStrategyreplication_factor:3migrations_path:./migrationsWhere themigrationsfolder (relative to the config file). contains.cqlor.pyfiles. The files are loaded in lexical order.The default convention is to name them in the form:001_my_migration.{cql| py}.
A custom naming scheme can be specified with thenew_migration_nameoption.For example# Default migration namesnew_migration_name:"{next_version:03d}_{desc}"# Date-based migration namesnew_migration_name:"{date:YYYYMMDDHHmmss}_{desc}"# Custom initial migration content for cql scriptsnew_cql_migration_text:|/* Cassandra migration for keyspace {keyspace}.Version {next_version} - {date}{full_desc} */# Custom initial migration content for python scriptsnew_python_migration_text:|# Cassandra migration for keyspace {keyspace}.# Version {next_version} - {date}# {full_desc} */def execute(session, **kwargs):"""Main method for your migration. Do not rename this method.Raise an exception of any kind to abort the migration."""print("Cassandra session: ", session)new_migration_nameis a new-style Python format string, which can use the
following parameters:next_version: Number of the newly generated migration (as anint).desc: filename-clean description of the migration, as specified
by the user.full_desc: unmodified description, possibly containing special characters.date: current date in UTC. Pay attention to the choice of formatting,
otherwise you might include spaces in the file name. The above example should
be a good starting point.keyspace: name of the configured keyspace.The format string shouldnotcontain the .cql or .py extensions, as it they
added automatically.new_cql_migraton_textdefines the initial content of CQL migration files.new_python_migraton_textdefines the initial content of Python migration
files.ProfilesProfiles can be defined in the configuration file. They can configure
thereplicationanddurable_writesparameters forCREATE KEYSPACE. A defaultdevprofile is implicitly defined
using a replication factor of 1.UsageCommon parameters:-H HOSTS, --hosts HOSTS
                      Comma-separated list of contact points
-p PORT, --port PORT
                      Connection port
-u USER, --user USER
                      Connection username
-P PASSWORD, --password PASSWORD
                      Connection password
-c CONFIG_FILE, --config-file CONFIG_FILE
                      Path to configuration file
-l PROTOCOL_VERSION, --protocol-version PROTOCOL_VERSION
                      Connection protocol version
-m PROFILE, --profile PROFILE
                      Name of keyspace profile to use
-s SSL_CERT, --ssl-cert SSL_CERT
                      File path of .pem or .crt containing certificate of
                      the cassandra host you are connecting to (or the
                      certificate of the CA that signed the host
                      certificate). If this option is provided, cassandra-
                      migrate will use ssl to connect to the cluster. If
                      this option is not provided, the -k and -t options
                      will be ignored.
-k SSL_CLIENT_PRIVATE_KEY, --ssl-client-private-key SSL_CLIENT_PRIVATE_KEY
                      File path of the .key file containing the private key
                      of the host on which the cstar-migrate command is
                      run. This option must be used in conjuction with the
                      -t option. This option is ignored unless the -s option
                      is provided.
-t SSL_CLIENT_CERT, --ssl-client-cert SSL_CLIENT_CERT
                      File path of the .crt file containing the public
                      certificate of the host on which the cstar-migrate
                      command is run. This certificate (or the CA that
                      signed it) must be trusted by the cassandra host that
                      migrations are run against. This option must be used
                      in conjuction with the -k option. This option is
                      ignored unless the -s option is provided.
-y, --assume-yes
                      Automatically answer "yes" for all questionsmigrateAdvances a database to the latest (or chosen) version of migrations.
Creates the keyspace and migrations table if necessary.Migrate will refuse to run if a previous attempt failed. To override
that after cleaning up any leftovers (as Cassandra has no DDL
transactions), use the--forceoption.Examples:# Migrate to the latest database version using the default configuration file,
# connecting to Cassandra in the local machinecstar-migrate-H127.0.0.1migrate# Migrate to version 2 using a specific config filecstar-migrate-cmydb.ymlmigrate2# Migrate to a version by namecstar-migratemigrate002_my_changes.cql# Force migration after a failurecstar-migratemigrate2--forceresetReset the database by dropping an existing keyspace, then running a migration.Examples:# Reset the database to the latest versioncstar-migratereset# Reset the database to a specifis versioncstar-migratereset3clearClear the database by dropping an existing keyspace.Example:# Clear the databasecstar-migrateclearbaselineAdvance an existing database version without actually running the
migrations.Useful for starting to manage a pre-existing database without recreating
it from scratch.Examples:# Baseline the existing database to the latest versioncstar-migratebaseline# Baseline the existing database to a specific versioncstar-migratebaseline5statusPrint the current status of the database.Example:cstar-migratestatusgenerateGenerate a new migration file with the appropriate name and a basic header
template, in the configuredmigrations_path.When running the command interactively, the file will be opened by the default
editor. The newly-generated file name will be printed to stdout.To generate a Python script, specify the--pythonoption.See the configuration section for details on migration naming.Examples:cstar-migrategenerate"My migration description"cstar-migrategenerate"My migration description"--python