com.stratio.deep.config

Interface ICassandraDeepJobConfig<T>

All Superinterfaces:

IDeepJobConfig<T,ICassandraDeepJobConfig<T>>, Serializable

public interface ICassandraDeepJobConfig<T>
extends IDeepJobConfig<T,ICassandraDeepJobConfig<T>>

Defines the public methods that each Stratio Deep Cassandra configuration object should implement.

Method Summary

Methods

Modifier and Type	Method and Description
ICassandraDeepJobConfig<T>	batchSize(int batchSize) Sets the batch size used to write to Cassandra.
ICassandraDeepJobConfig<T>	bisectFactor(int bisectFactor) Sets the token range bisect factor.
ICassandraDeepJobConfig<T>	columnFamily(String columnFamily) Sets the cassandra CF from which data will be read from.
ICassandraDeepJobConfig<T>	cqlPort(Integer port) Sets cassandra host rpcPort.
ICassandraDeepJobConfig<T>	createTableOnWrite(Boolean createTableOnWrite) Whether or not to create the output column family on write. .
int	getBatchSize() Returns the batch size used for writing objects to the underying Cassandra datastore.
int	getBisectFactor()
String	getColumnFamily() Returns the name of the configured column family.
Integer	getCqlPort() CQL port where the remote Cassandra cluster is listening to.
Boolean	getIsWriteConfig() Returns whether this configuration config is suitable for writing out data to the datastore.
String	getKeyspace() Returns the name of the keyspace.
String	getPartitionerClassName() Returns the partitioner class name.
String	getReadConsistencyLevel() Returns the configured read consistency level.
Integer	getRpcPort() RPC port where the remote Cassandra cluster is listening to.
com.datastax.driver.core.Session	getSession() Returns the session opened to the cassandra server.
String	getTable() Returns the name of the configured column family.
String	getWriteConsistencyLevel() Returns the configured write consistency level.
Boolean	isCreateTableOnWrite() Returns whether or not in this configuration object we specify to automatically create the output column family.
ICassandraDeepJobConfig<T>	keyspace(String keyspace) Sets Cassandra Keyspace.
ICassandraDeepJobConfig<T>	partitioner(String partitionerClassName) Let's the user specify an alternative partitioner class.
ICassandraDeepJobConfig<T>	readConsistencyLevel(String level) Sets read consistency level.
ICassandraDeepJobConfig<T>	rpcPort(Integer port) Sets cassandra host rpcPort.
ICassandraDeepJobConfig<T>	session(com.datastax.driver.core.Session session) Sets the session to use.
ICassandraDeepJobConfig<T>	table(String table) Sets the underlying datastore table or collection from which data will be read from.
ICassandraDeepJobConfig<T>	writeConsistencyLevel(String level) Sets write consistency level.

Methods inherited from interface com.stratio.deep.config.IDeepJobConfig

columnDefinitions, filterByField, getAdditionalFilters, getEntityClass, getHost, getInputColumns, getPageSize, getPassword, getUsername, host, initialize, inputColumns, pageSize, password, username

Method Detail

getPartitionerClassName

String getPartitionerClassName()

Returns the partitioner class name.

Returns:

the partitioner class name.

partitioner

ICassandraDeepJobConfig<T> partitioner(String partitionerClassName)

Let's the user specify an alternative partitioner class. The default partitioner is org.apache.cassandra.dht.Murmur3Partitioner.

Parameters:

partitionerClassName - the partitioner class name.

Returns:

this object.

getSession

com.datastax.driver.core.Session getSession()

Returns the session opened to the cassandra server.

Returns:

the Session opened by this configuration object to the cassandra server.

getKeyspace

String getKeyspace()

Returns the name of the keyspace.

Returns:

the name of the configured keyspace.

getRpcPort

Integer getRpcPort()

RPC port where the remote Cassandra cluster is listening to. Defaults to 9160.

Returns:

the thrift port.

getCqlPort

Integer getCqlPort()

CQL port where the remote Cassandra cluster is listening to. Defaults to 9042.

Returns:

the cql port.

keyspace

ICassandraDeepJobConfig<T> keyspace(String keyspace)

Sets Cassandra Keyspace.

Parameters:

keyspace - the keyspace to use.

Returns:

this object.

rpcPort

ICassandraDeepJobConfig<T> rpcPort(Integer port)

Sets cassandra host rpcPort.

Parameters:

port - the thrift port number.

Returns:

this object.

cqlPort

ICassandraDeepJobConfig<T> cqlPort(Integer port)

Sets cassandra host rpcPort.

Parameters:

port - the cql port number.

Returns:

this object.

readConsistencyLevel

ICassandraDeepJobConfig<T> readConsistencyLevel(String level)

Sets read consistency level.
Can be one of those consistency levels defined in ConsistencyLevel.
Defaults to ConsistencyLevel.LOCAL_ONE.

Parameters:

level - the read consistency level to use.

Returns:

this configuration object.

writeConsistencyLevel

ICassandraDeepJobConfig<T> writeConsistencyLevel(String level)

Sets write consistency level.
Can be one of those consistency levels defined in ConsistencyLevel.
Defaults to ConsistencyLevel.LOCAL_ONE.

Parameters:

level - the write consistency level to use.

Returns:

this configuration object.

getReadConsistencyLevel

String getReadConsistencyLevel()

Returns the configured read consistency level.

Returns:

the read consistency level.

getWriteConsistencyLevel

String getWriteConsistencyLevel()

Returns the configured write consistency level.

Returns:

the write consistency level.

bisectFactor

ICassandraDeepJobConfig<T> bisectFactor(int bisectFactor)

Sets the token range bisect factor. The provided number must be a power of two. Defaults to 1.

Parameters:

bisectFactor - the bisect factor to use.

Returns:

this configuration object.

getBisectFactor

int getBisectFactor()

Returns:

the configured bisect factor.

table

ICassandraDeepJobConfig<T> table(String table)

Sets the underlying datastore table or collection from which data will be read from.

Parameters:

table - the table name.

Returns:

this configuration object.

getTable

String getTable()

Returns the name of the configured column family. Column family name is case sensitive.

Returns:

the table name.

columnFamily

ICassandraDeepJobConfig<T> columnFamily(String columnFamily)

Sets the cassandra CF from which data will be read from. Column family name is case sensitive.

Parameters:

columnFamily - the table name data will be fetched from.

Returns:

this configuration object.

getIsWriteConfig

Boolean getIsWriteConfig()

Returns whether this configuration config is suitable for writing out data to the datastore.

Returns:

true if this configuratuon object is suitable for writing to cassandra, false otherwise.

batchSize

ICassandraDeepJobConfig<T> batchSize(int batchSize)

Sets the batch size used to write to Cassandra.

Returns:

this object.

getBatchSize

int getBatchSize()

Returns the batch size used for writing objects to the underying Cassandra datastore.

Returns:

the batch size.

isCreateTableOnWrite

Boolean isCreateTableOnWrite()

Returns whether or not in this configuration object we specify to automatically create the output column family.

Returns:

true if this configuration object has been configured to create missing tables on writes.

createTableOnWrite

ICassandraDeepJobConfig<T> createTableOnWrite(Boolean createTableOnWrite)

Whether or not to create the output column family on write.
.

Defaults to FALSE.

Parameters:

createTableOnWrite - a boolean that tells this configuration obj to create missing tables on write.

Returns:

this configuration object.

getColumnFamily

String getColumnFamily()

Returns the name of the configured column family.

Returns:

the configured column family.

session

ICassandraDeepJobConfig<T> session(com.datastax.driver.core.Session session)

Sets the session to use. If a session is not provided, this object will open a new one.

Parameters:

session - the session to use.