org.cognitor.cassandra.migration.spring

Class CassandraMigrationConfigurationProperties

java.lang.Object

org.cognitor.cassandra.migration.spring.CassandraMigrationConfigurationProperties

@ConfigurationProperties(prefix="cassandra.migration")
public class CassandraMigrationConfigurationProperties
extends Object

Configuration properties for the cassandra migration library. These values should be set a properties file that is used inside the application, e.g. application.properties.

Author:

Patrick Kranz

Constructor Summary

Constructors

Constructor and Description
CassandraMigrationConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
com.datastax.driver.core.ConsistencyLevel	getConsistencyLevel()
String	getKeyspaceName()
String	getScriptLocation()
ScriptCollectorStrategy	getStrategy()
String	getTablePrefix()
boolean	hasKeyspaceName()
void	setConsistencyLevel(com.datastax.driver.core.ConsistencyLevel consistencyLevel) Sets the consistency level which should be used to execute the schema migrations.
void	setKeyspaceName(String keyspaceName) Sets the name of the keyspace that should be migrated.
void	setScriptLocation(String scriptLocation) The location where the scripts reside on the classpath.
void	setStrategy(ScriptCollectorStrategy strategy) Sets the strategy that should be used when scripts are collected from the repository.
CassandraMigrationConfigurationProperties	setTablePrefix(String tablePrefix)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CassandraMigrationConfigurationProperties

public CassandraMigrationConfigurationProperties()

Method Detail

getScriptLocation

public String getScriptLocation()

Returns:

The location of the migration scripts. Never null.

setScriptLocation

public void setScriptLocation(String scriptLocation)

The location where the scripts reside on the classpath. The default is MigrationRepository.DEFAULT_SCRIPT_PATH which points to cassandra/migration on the classpath.

Parameters:

scriptLocation - the location of the migration scripts. Must not be null.

Throws:

IllegalArgumentException - when scriptLocation is null or empty

getKeyspaceName

public String getKeyspaceName()

Returns:

the name of the keyspace. Can be null if it was not set before.

setKeyspaceName

public void setKeyspaceName(String keyspaceName)

Sets the name of the keyspace that should be migrated. This setting is required in order for the migration to work.

Parameters:

keyspaceName - the name of the keyspace to be migrated

getStrategy

public ScriptCollectorStrategy getStrategy()

Returns:

the strategy to use for collecting scripts inside the repository.

setStrategy

public void setStrategy(ScriptCollectorStrategy strategy)

Sets the strategy that should be used when scripts are collected from the repository.

Parameters:

strategy - the collector strategy. This setting is optional.

hasKeyspaceName

public boolean hasKeyspaceName()

Returns:

true if a keyspace name was provided, false otherwise

getConsistencyLevel

public com.datastax.driver.core.ConsistencyLevel getConsistencyLevel()

Returns:

the consistency level to be used for schema migrations

setConsistencyLevel

public void setConsistencyLevel(com.datastax.driver.core.ConsistencyLevel consistencyLevel)

Sets the consistency level which should be used to execute the schema migrations. Default is ConsistencyLevel.QUORUM

Parameters:

consistencyLevel - the consistency level to be used for migrations

getTablePrefix

public String getTablePrefix()

setTablePrefix

public CassandraMigrationConfigurationProperties setTablePrefix(String tablePrefix)