Configuration Options

Migration Configuration / Options

Options can be set either programmatically with API, Java VM options / system properties, or configuration file. Refer to Typesafe Config library documentation or refer to reference.conf for a reference configuration.

Cluster

• cassandra.migration.cluster.contactpoints: Comma separated values of node IP addresses. (default=localhost)
• cassandra.migration.cluster.port: CQL native transport port. (default=9042)
• cassandra.migration.cluster.username: Username for password authenticator. (optional)
• cassandra.migration.cluster.password: Password for password authenticator. (optional)
• cassandra.migration.cluster.truststore: Path to truststore.jks for Cassandra client SSL. (optional)
• cassandra.migration.cluster.truststore_password: Password for truststore.jks. (optional)
• cassandra.migration.cluster.keystore: Path to keystore.jks for Cassandra client SSL with certificate authentication. (optional)
• cassandra.migration.cluster.keystore_password: Password for keystore.jks. (optional)

Keyspace

• cassandra.migration.keyspace.name: Name of Cassandra keyspace. (required)
• cassandra.migration.keyspace.consistency: Keyspace write consistency levels for migrations schema tracking. (optional)

Scripts

• cassandra.migration.scripts.locations: Locations of the migration scripts in CSV format. Scripts are scanned in the specified folder recursively. (default=db/migration)
• cassandra.migration.scripts.encoding: The encoding of CQL scripts. (default=UTF-8)
• cassandra.migration.scripts.timeout: The read script timeout duration in seconds for CQL migrations. (default=60)
• cassandra.migration.scripts.allowoutoforder: Allow out of order migration. (default=false)

Migration Version Table

• cassandra.migration.table.prefix: The prefix to be prepended to cassandra_migration_version* table names. (optional)

Migration Target and Versioning

• cassandra.migration.version.target: The target version. Migrations with a higher version number will be ignored. (default=latest)
• cassandra.migration.baseline.version: The version to apply for an existing schema when baseline is run. (optional)
• cassandra.migration.baseline.description: The description to apply for an existing schema when baseline is run. (default=<< Cassandra Baseline >>)