org.mule.modules

mule-module-cassandradb

config

Namespace	http://www.mulesoft.org/schema/mule/cassandradb
Schema Location	http://www.mulesoft.org/schema/mule/cassandradb/current/mule-cassandradb.xsd (View Schema)
Schema Version	3.2
Minimum Mule Version	3.2

Module Overview

Connector allows the user to interact with any Cassandra DB. The Apache Cassandra database is the right choice when you need scalability and high availability without compromising performance. Cassandra's ColumnFamily data model offers the convenience of column indexes with the performance of log-structured updates, strong support for materialized views, and powerful built-in caching.

Summary

Configuration
<cassandradb:config> Configure an instance of this module

Message Processors
<cassandradb:add> Increments a CounterColumn consisting of (name, value) at the given ColumnParent.
<cassandradb:batch-mutable> Executes the specified mutations on the keyspace.
<cassandradb:describe-cluster-name> Gets the name of the cluster.
<cassandradb:describe-keyspace> Gets information about the specified keyspace.
<cassandradb:describe-keyspaces> Gets a list of all the keyspaces configured for the cluster.
<cassandradb:describe-partitioner> Gets the name of the partitioner for the cluster.
<cassandradb:describe-ring> Gets the token ring; a map of ranges to host addresses.
<cassandradb:describe-schema-versions> For each schema version present in the cluster, returns a list of nodes at that version.
<cassandradb:describe-snitch> Gets the name of the snitch used for the cluster.
<cassandradb:describe-version> Gets the Thrift API version.
<cassandradb:execute-cql-query> Executes a CQL (Cassandra Query Language) statement and returns a CqlResult containing the results.
<cassandradb:get> Get Column or SuperColumn by the path
<cassandradb:get-count> Counts the columns present in column_parent within the predicate.
<cassandradb:get-indexed-slices> Like get_range_slices, returns a list of slices, but uses IndexClause instead of KeyRange.
<cassandradb:get-range-slices> Replaces get_range_slice.
<cassandradb:get-row> Get Column or SuperColumn by the path
<cassandradb:get-slice> Get the group of columns contained by column_parent (either a ColumnFamily name or a ColumnFamily/SuperColumn name pair) specified by the given SlicePredicate (start, finish, reversed and count) parameters.
<cassandradb:insert> Insert a Column consisting of (name, value, timestamp, ttl) at the given ColumnParent.
<cassandradb:insert-from-map> Insert object into the database
<cassandradb:multiget-count> A combination of multiget_slice and get_count.
<cassandradb:multiget-slice> Retrieves slices for column_parent and predicate on each of the given keys in parallel.
<cassandradb:remove> Remove data from the row specified by key at the granularity specified by column_path, and the given timestamp.
<cassandradb:remove-counter> Remove a counter from the row specified by key at the granularity specified by column_path.
<cassandradb:set-query-keyspace> Set the keyspace to use for subsequent requests.
<cassandradb:system-add-column-family-from-object> Adds a column family.
<cassandradb:system-add-column-family-from-object-with-simple-names> Adds a column family.
<cassandradb:system-add-column-family-with-params> Adds a column family to the current keyspace.
<cassandradb:system-add-keyspace-from-object> Creates a new keyspace and any column families defined with it.
<cassandradb:system-add-keyspace-with-params> Creates a new keyspace with the provided name with all the defaults values
<cassandradb:system-drop-column-family> Drops a column family.
<cassandradb:system-drop-keyspace> Drops a keyspace.
<cassandradb:system-update-column-family> Updates properties of a ColumnFamily.
<cassandradb:system-update-keyspace> Updates properties of a keyspace.
<cassandradb:truncate> Removes all the rows from the given column family.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:cassandradb="http://www.mulesoft.org/schema/mule/cassandradb"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/cassandradb
               http://www.mulesoft.org/schema/mule/cassandradb/current/mule-cassandradb.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description	Java Type	MIME Type	Encoding
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
	consistencyLevel	ONE	Optional. Consistency Level.
xs:string	host	localhost	Optional. Host name or IP address
xs:string	keyspace		Cassandra keyspace
xs:int	port	9160	Optional. Port (default is 9160)

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <cassandradb:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
username		A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password		A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <cassandradb:config>
         <reconnect count="5" frequency="1000"/>
    </cassandradb:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<cassandradb:add>

Increments a CounterColumn consisting of (name, value) at the given ColumnParent. Note that a SuperColumn cannot directly contain binary values -- it can only contain sub-Columns.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
rowKey	Key of the row	String	/	UTF-8
columnParent	Column Parent of the CounterColum	String	/	UTF-8
counterName	Name of the column	String	/	UTF-8
counterValue	Value of the counter	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
TException	Generic exception class for Thrift.

<cassandradb:batch-mutable>

Executes the specified mutations on the keyspace. content is a Map<string, Map<string, List<Mutation>>>; the outer map maps the key to the inner map, which maps the column family to the Mutation; can be read as: Map<key : string, Map<column_family : string, List<Mutation>>>. To be more specific, the outer map key is a row key, the inner map key is the column family name. A Mutation specifies either columns to insert or columns to delete. See Mutation and Deletion above for more details.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:content>	#[payload]	Optional. A Map<ByteBuffer, Map<String, List<Mutation>>>	Map

Exception Payloads

Payload Class	Description
Exception	Exception

<cassandradb:describe-cluster-name>

Gets the name of the cluster.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
String	the cluster name

Exception Payloads

Payload Class	Description
TException	Generic exception class for Thrift.

<cassandradb:describe-keyspace>

Gets information about the specified keyspace.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
keyspace	Name of the keyspace	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
Object	A KsDef instance

Exception Payloads

Payload Class	Description
NotFoundException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
TException	Generic exception class for Thrift.

<cassandradb:describe-keyspaces>

Gets a list of all the keyspaces configured for the cluster. (Equivalent to calling describe_keyspace(k) for k in keyspaces.)

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
List	A list of KsDef

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
TException	Generic exception class for Thrift.

<cassandradb:describe-partitioner>

Gets the name of the partitioner for the cluster.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
String	Partitioner name

Exception Payloads

Payload Class	Description
TException	Generic exception class for Thrift.

<cassandradb:describe-ring>

Gets the token ring; a map of ranges to host addresses. Represented as a set of TokenRange instead of a map from range to list of endpoints, because you can't use Thrift structs as map keys: https://issues.apache.org/jira/browse/THRIFT-162 for the same reason, we can't return a set here, even though order is neither important nor predictable.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
keyspace	Keyspace name	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
List	A list of TokenRange

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
TException	Generic exception class for Thrift.

<cassandradb:describe-schema-versions>

For each schema version present in the cluster, returns a list of nodes at that version. Hosts that do not respond will be under the key DatabaseDescriptor.INITIAL_VERSION. The cluster is all on the same version if the size of the map is 1.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
Map	A map of type Map>

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
TException	Generic exception class for Thrift.

<cassandradb:describe-snitch>

Gets the name of the snitch used for the cluster.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
String	String with the name of the snitch

Exception Payloads

Payload Class	Description
TException	Generic exception class for Thrift.

<cassandradb:describe-version>

Gets the Thrift API version.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
String	API Version string representation

Exception Payloads

Payload Class	Description
TException	Generic exception class for Thrift.

<cassandradb:execute-cql-query>

Executes a CQL (Cassandra Query Language) statement and returns a CqlResult containing the results. For more information about CQL please visit: http://cassandra.apache.org/doc/cql/CQL.html

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
query		CQL Statement to be executed	String	/	UTF-8
compression	NONE	Optional. Compression level, by default we use NONE	Compression	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password		Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
Object	CqlResult containing the results of the execution

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
SchemaDisagreementException	Schemas are not in agreement across all nodes
TException	Generic exception class for Thrift.

<cassandradb:get>

Get Column or SuperColumn by the path

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
rowKey	The row key	String	/	UTF-8
columnPath	Path to the column - must be in the form of ColumnFamily:SuperColumn:Column. If you don't need a SuperColumn	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:column-serializers>		Optional. Serializers for each column	List<ColumnSerializer>

Returns

Return Type	Description
Object	the result as a JSON node

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
TException	Generic exception class for Thrift.
NotFoundException	A specific column was requested that does not exist.

<cassandradb:get-count>

Counts the columns present in column_parent within the predicate.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
rowKey		The row key	String	/	UTF-8
columnParent		Path to the column - must be a name of the ColumnFamily or ColumnFamily:SuperColumn pair	String	/	UTF-8
start		Optional. The column name to start the slice with. This attribute is not required, though there is no default value, and can be safely set to '', i.e., an empty byte array, to start with the first column name. Otherwise, it must a valid value under the rules of the Comparator defined for the given ColumnFamily.	String	/	UTF-8
finish		Optional. The column name to stop the slice at. This attribute is not required, though there is no default value, and can be safely set to an empty byte array to not stop until 'count' results are seen. Otherwise, it must also be a valid value to the ColumnFamily Comparator.	String	/	UTF-8
reversed	false	Optional. Whether the results should be ordered in reversed order. Similar to ORDER BY blah DESC in SQL.	boolean	/
count	100	Optional. How many columns to return. Similar to LIMIT in SQL. May be arbitrarily large, but Thrift will materialize the whole result into memory before returning it to the client, so be aware that you may be better served by iterating through slices by passing the last value of one call in as the 'start' of the next instead of increasing 'count' arbitrarily large.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password		Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
int	Count of register that met the conditions

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
TException	Generic exception class for Thrift.

<cassandradb:get-indexed-slices>

Like get_range_slices, returns a list of slices, but uses IndexClause instead of KeyRange. To use this method, the underlying ColumnFamily of the ColumnParent must have been configured with a column_metadata attribute, specifying at least the name and index_type attributes. See CfDef and ColumnDef above for the list of attributes. Note: the IndexClause must contain one IndexExpression with an EQ operator on a configured index column. Other IndexExpression structs may be added to the IndexClause for non-indexed columns to further refine the results of the EQ expression.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
columnParent		Path to the column - must be a name of the ColumnFamily or ColumnFamily:SuperColumn pair	String	/	UTF-8
start		Optional. The column name to start the slice with. This attribute is not required, though there is no default value, and can be safely set to '', i.e., an empty byte array, to start with the first column name. Otherwise, it must a valid value under the rules of the Comparator defined for the given ColumnFamily.	String	/	UTF-8
finish		Optional. The column name to stop the slice at. This attribute is not required, though there is no default value, and can be safely set to an empty byte array to not stop until 'count' results are seen. Otherwise, it must also be a valid value to the ColumnFamily Comparator.	String	/	UTF-8
reversed	false	Optional. Whether the results should be ordered in reversed order. Similar to ORDER BY blah DESC in SQL.	boolean	/
count	100	Optional. How many columns to return. Similar to LIMIT in SQL. May be arbitrarily large, but Thrift will materialize the whole result into memory before returning it to the client, so be aware that you may be better served by iterating through slices by passing the last value of one call in as the 'start' of the next instead of increasing 'count' arbitrarily large.	int	/
clauseCount	100	Optional. The number of results to which the index query will be constrained	int	/
clauseStartKey		Start the index query at the specified key - can be set to '', i.e., an empty byte array, to start with the first key	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password		Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:expression-list>		The list of IndexExpression objects which must contain one EQ IndexOperator among the expressions	List<IndexExpresion>

Returns

Return Type	Description
Object	List of objects KeySlice

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
TException	Generic exception class for Thrift.

<cassandradb:get-range-slices>

Replaces get_range_slice. Returns a list of slices for the keys within the specified KeyRange. Unlike get_key_range, this applies the given predicate to all keys in the range, not just those with undeleted matching data. Note that when using RandomPartitioner, keys are stored in the order of their MD5 hash, making it impossible to get a meaningful range of keys between two endpoints.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
columnParent		Path to the column - must be a name of the ColumnFamily or ColumnFamily:SuperColumn pair	String	/	UTF-8
start		Optional. The column name to start the slice with. This attribute is not required, though there is no default value, and can be safely set to '', i.e., an empty byte array, to start with the first column name. Otherwise, it must a valid value under the rules of the Comparator defined for the given ColumnFamily.	String	/	UTF-8
finish		Optional. The column name to stop the slice at. This attribute is not required, though there is no default value, and can be safely set to an empty byte array to not stop until 'count' results are seen. Otherwise, it must also be a valid value to the ColumnFamily Comparator.	String	/	UTF-8
reversed	false	Optional. Whether the results should be ordered in reversed order. Similar to ORDER BY blah DESC in SQL.	boolean	/
count	100	Optional. How many columns to return. Similar to LIMIT in SQL. May be arbitrarily large, but Thrift will materialize the whole result into memory before returning it to the client, so be aware that you may be better served by iterating through slices by passing the last value of one call in as the 'start' of the next instead of increasing 'count' arbitrarily large.	int	/
startKey		Optional. The first key in the inclusive KeyRange.	String	/	UTF-8
endKey		Optional. The last key in the inclusive KeyRange.	String	/	UTF-8
startToken		Optional. The first token in the exclusive KeyRange.	String	/	UTF-8
endToken		Optional. The last token in the exclusive KeyRange.	String	/	UTF-8
keyRangeCount	100	Optional. The total number of keys to permit in the KeyRange.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password		Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
Object	List of objects KeySlice

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
TException	Generic exception class for Thrift.

<cassandradb:get-row>

Get Column or SuperColumn by the path

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
rowKey	The row key	String	/	UTF-8
columnPath	Path to the column	ColumnPath	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:column-serializers>		Optional. Serializers for each column	List<ColumnSerializer>

Returns

Return Type	Description
Object	the result as a JSON node

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
TException	Generic exception class for Thrift.
NotFoundException	A specific column was requested that does not exist.

<cassandradb:get-slice>

Get the group of columns contained by column_parent (either a ColumnFamily name or a ColumnFamily/SuperColumn name pair) specified by the given SlicePredicate (start, finish, reversed and count) parameters.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
rowKey		The row key	String	/	UTF-8
columnParent		Path to the column - must be a name of the ColumnFamily or ColumnFamily:SuperColumn pair	String	/	UTF-8
start		Optional. The column name to start the slice with. This attribute is not required, though there is no default value, and can be safely set to '', i.e., an empty byte array, to start with the first column name. Otherwise, it must a valid value under the rules of the Comparator defined for the given ColumnFamily.	String	/	UTF-8
finish		Optional. The column name to stop the slice at. This attribute is not required, though there is no default value, and can be safely set to an empty byte array to not stop until 'count' results are seen. Otherwise, it must also be a valid value to the ColumnFamily Comparator.	String	/	UTF-8
reversed	false	Optional. Whether the results should be ordered in reversed order. Similar to ORDER BY blah DESC in SQL.	boolean	/
count	100	Optional. How many columns to return. Similar to LIMIT in SQL. May be arbitrarily large, but Thrift will materialize the whole result into memory before returning it to the client, so be aware that you may be better served by iterating through slices by passing the last value of one call in as the 'start' of the next instead of increasing 'count' arbitrarily large.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password		Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:column-serializers>		Optional. Serializers for each column	List<ColumnSerializer>

Returns

Return Type	Description
Object	the result as a JSON node

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
TException	Generic exception class for Thrift.

<cassandradb:insert>

Insert a Column consisting of (name, value, timestamp, ttl) at the given ColumnParent. Note that a SuperColumn cannot directly contain binary values -- it can only contain sub-Columns. Only one sub-Column may be inserted at a time, as well. Any number of columns may be inserted at the same time. When inserting or updating columns in a column family, the client application specifies the row key to identify which column records to update. The row key is similar to a primary key in that it must be unique for each row within a column family. However, unlike a primary key, inserting a duplicate row key will not result in a primary key constraint violation - it will be treated as an UPSERT (update the specified columns in that row if they exist or insert them if they do not). For more details check: http://www.datastax.com/docs/0.8/dml/about_writes

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
rowKey		The row key	String	/	UTF-8
columnParent		The ColumnParent	String	/	UTF-8
columnName		The name of the column	String	/	UTF-8
columnValue		The value of the column	String	/	UTF-8
ttl	0	Optional. An optional, positive delay (in seconds) after which the Column will be automatically deleted.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password		Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
TException	Generic exception class for Thrift.
TimedOutException	Exception
UnavailableException	Not all the replicas required could be created and/or read.
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.

<cassandradb:insert-from-map>

Insert object into the database

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:content>	#[payload]	Optional. Content to be inserted into the database. Must be an instance of Map in the following format: { "ToyStores" : { - Column Family "Ohio Store" : { - RowKey "Transformer" : { - SuperColumn "Price" : "29.99", - Column "Section" : "Action Figures" } "GumDrop" : { "Price" : "0.25", "Section" : "Candy" } "MatchboxCar" : { "Price" : "1.49", "Section" : "Vehicles" } } "New York Store" : { "JawBreaker" : { "Price" : "4.25", "Section" : "Candy" } "MatchboxCar" : { "Price" : "8.79", "Section" : "Vehicles" } } } } * @param password A password	Map

Returns

Return Type	Description
Map	Same content

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
TException	Generic exception class for Thrift.
TimedOutException	Time out of the request
UnavailableException	Not all the replicas required could be created and/or read.
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.Why contains an associated error message.

<cassandradb:multiget-count>

A combination of multiget_slice and get_count.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
columnParent		Path to the column - must be a name of the ColumnFamily or ColumnFamily:SuperColumn pair	String	/	UTF-8
start		Optional. The column name to start the slice with. This attribute is not required, though there is no default value, and can be safely set to '', i.e., an empty byte array, to start with the first column name. Otherwise, it must a valid value under the rules of the Comparator defined for the given ColumnFamily.	String	/	UTF-8
finish		Optional. The column name to stop the slice at. This attribute is not required, though there is no default value, and can be safely set to an empty byte array to not stop until 'count' results are seen. Otherwise, it must also be a valid value to the ColumnFamily Comparator.	String	/	UTF-8
reversed	false	Optional. Whether the results should be ordered in reversed order. Similar to ORDER BY blah DESC in SQL.	boolean	/
count	100	Optional. How many columns to return. Similar to LIMIT in SQL. May be arbitrarily large, but Thrift will materialize the whole result into memory before returning it to the client, so be aware that you may be better served by iterating through slices by passing the last value of one call in as the 'start' of the next instead of increasing 'count' arbitrarily large.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password		Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:row-keys>		A list of keys used for	List<String>

Returns

Return Type	Description
Object	A map of keys and integers

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
TException	Generic exception class for Thrift.

<cassandradb:multiget-slice>

Retrieves slices for column_parent and predicate on each of the given keys in parallel. Keys are a list of the keys to get slices for. This is similar to getRangeSlices, except it operates on a set of non-contiguous keys instead of a range of keys.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
columnParent		Path to the column - must be a name of the ColumnFamily or ColumnFamily:SuperColumn pair	String	/	UTF-8
start		Optional. The column name to start the slice with. This attribute is not required, though there is no default value, and can be safely set to '', i.e., an empty byte array, to start with the first column name. Otherwise, it must a valid value under the rules of the Comparator defined for the given ColumnFamily.	String	/	UTF-8
finish		Optional. The column name to stop the slice at. This attribute is not required, though there is no default value, and can be safely set to an empty byte array to not stop until 'count' results are seen. Otherwise, it must also be a valid value to the ColumnFamily Comparator.	String	/	UTF-8
reversed	false	Optional. Whether the results should be ordered in reversed order. Similar to ORDER BY blah DESC in SQL.	boolean	/
count	100	Optional. How many columns to return. Similar to LIMIT in SQL. May be arbitrarily large, but Thrift will materialize the whole result into memory before returning it to the client, so be aware that you may be better served by iterating through slices by passing the last value of one call in as the 'start' of the next instead of increasing 'count' arbitrarily large.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password		Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:row-keys>		A list of keys used for	List<String>
<cassandradb:column-serializers>		Optional. Serializers for each column	List<ColumnSerializer>

Returns

Return Type	Description
Object	A map of keys and ColumnOrSuperColumn

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
TException	Generic exception class for Thrift.

<cassandradb:remove>

Remove data from the row specified by key at the granularity specified by column_path, and the given timestamp. Note that all the values in column_path besides column_path.column_family are truly optional: you can remove the entire row by just specifying the ColumnFamily, or you can remove a SuperColumn or a single Column by specifying those levels too. Note that the timestamp is needed, so that if the commands are replayed in a different order on different nodes, the same result is produced.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
rowKey	The row key	String	/	UTF-8
columnPath	Path to the column - must be in the form of ColumnFamily:SuperColumn:Column	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Exception Payloads

Payload Class	Description
Exception	IOException

<cassandradb:remove-counter>

Remove a counter from the row specified by key at the granularity specified by column_path. Note that all the values in column_path besides column_path.column_family are truly optional: you can remove the entire row by just specifying the ColumnFamily, or you can remove a SuperColumn or a single Column by specifying those levels too. Note that counters have limited support for deletes: if you remove a counter, you must wait to issue any following update until the delete has reached all the nodes and all of them have been fully compacted.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
rowKey	Key of the row	String	/	UTF-8
columnPath	Column that will be affected by the remove counter	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Exception Payloads

Payload Class	Description
UnsupportedEncodingException	Exception
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TimedOutException	Exception
TException	Generic exception class for Thrift.

<cassandradb:set-query-keyspace>

Set the keyspace to use for subsequent requests.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
value	New value that will be used to all following requests	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
TException	Generic exception class for Thrift.

<cassandradb:system-add-column-family-from-object>

Adds a column family. This method will throw an exception if a column family with the same name is already associated with the keyspace. Column names in metadata need to be ByteBuffer. You can achieve this by usin the CassandraDBUtils like in the next example

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
cfDefinition	An instance of CfDef	CfDef	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
String	The new Schema version ID.

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
SchemaDisagreementException	Schemas are not in agreement across all nodes
TException	Generic exception class for Thrift.

<cassandradb:system-add-column-family-from-object-with-simple-names>

Adds a column family. This method will throw an exception if a column family with the same name is already associated with the keyspace. This method also recieves a list of string to be used as column names

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
cfDefinition	An instance of CfDef	CfDef	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:column-names>		A list that contains the columns names for columns defined in column_metadata	List<String>

Returns

Return Type	Description
String	The new Schema version ID.

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
SchemaDisagreementException	Schemas are not in agreement across all nodes
TException	Generic exception class for Thrift.
UnsupportedEncodingException	Exception

<cassandradb:system-add-column-family-with-params>

Adds a column family to the current keyspace. This method will throw an exception if a column family with the same name is already associated with the keyspace.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
columnFamilyName		The name of the column to be added	String	/	UTF-8
comparatorType	BytesType	Optional. Validator to use to validate and compare column names in this column family. For Standard column families it applies to columns, for Super column families applied to super columns.Default is BytesType, which is a straight forward lexical comparison of the bytes in each column. Supported values are: AsciiType BooleanType BytesType CounterColumnType (distributed counter column) DateType DoubleType FloatType Int32Type IntegerType (a generic variable-length integer type) LexicalUUIDType LongType UTF8Type CompositeType (should be used with sub-types specified e.g. 'CompositeType(UTF8Type, Int32Type)' quotes are important (!) in this case) It is also valid to specify the fully-qualified class name to a class that extends org.apache.cassandra.db.marshal.AbstractType.	String	/	UTF-8
keyValidationClass	BytesType	Optional. Validator to use for keys. Default is BytesType which applies no validation. Supported values are: AsciiType BooleanType BytesType DateType DoubleType FloatType Int32Type IntegerType (a generic variable-length integer type) LexicalUUIDType LongType UTF8Type It is also valid to specify the fully-qualified class name to a class that extends org.apache.cassandra.db.marshal.AbstractType.	String	/	UTF-8
defaultValidationClass	BytesType	Optional. Validator to use for values in columns which are not listed in the column_metadata. Default is BytesType which applies no validation. Supported values are: AsciiType BooleanType BytesType CounterColumnType (distributed counter column) DateType DoubleType FloatType Int32Type IntegerType (a generic variable-length integer type) LexicalUUIDType LongType UTF8Type CompositeType (should be used with sub-types specified e.g. 'CompositeType(UTF8Type, Int32Type)' quotes are important (!) in this case) It is also valid to specify the fully-qualified class name to a class that extends org.apache.cassandra.db.marshal.AbstractType.	String	/	UTF-8
keyspace		Optional. The name of the keyspace. If null, current keyspace will be used	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password		Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:column-metadata>		Optional. A list with the column definitions. If null, a dynamic column family will be created. For more details check http://www.datastax.com/docs/1.0/ddl/column_family	List<ColumnDef>

Returns

Return Type	Description
String	The new Schema version ID.

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
SchemaDisagreementException	Schemas are not in agreement across all nodes
TException	Generic exception class for Thrift.

<cassandradb:system-add-keyspace-from-object>

Creates a new keyspace and any column families defined with it. Callers are not required to first create an empty keyspace and then create column families for it.

This will create a keyspace named MyKeyspace with no column families

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
keyspaceDefinition	The keyspace definition that will be added	KsDef	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
String	The new schema version ID.

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
SchemaDisagreementException	Schemas are not in agreement across all nodes
TException	Generic exception class for Thrift.

<cassandradb:system-add-keyspace-with-params>

Creates a new keyspace with the provided name with all the defaults values

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
keyspaceName	The keyspace name	String	/	UTF-8
strategyClass	Optional. The name of the class that handles the Replication Strategy.	ReplicationStrategy	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<cassandradb:column-names>		Optional. List of the column names the keyspace will have	List<String>
<cassandradb:strategy-options>		Optional. Map containing the configuration for the strategy class selected.	Map<String, String>

Returns

Return Type	Description
Object	The new schema version ID.

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
SchemaDisagreementException	Schemas are not in agreement across all nodes
TException	Generic exception class for Thrift.

<cassandradb:system-drop-column-family>

Drops a column family. Creates a snapshot and then submits a 'graveyard' compaction during which the abandoned files will be deleted.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
columnFamily	The name of the column family to be drop	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
String	The new schema version ID.

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
SchemaDisagreementException	Schemas are not in agreement across all nodes
TException	Generic exception class for Thrift.

<cassandradb:system-drop-keyspace>

Drops a keyspace. Creates a snapshot and then submits a 'graveyard' compaction during which the abandoned files will be deleted.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
keyspace	Name of the keyspace to be dropped	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
Object	The new schema version ID.

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
SchemaDisagreementException	Schemas are not in agreement across all nodes
TException	Generic exception class for Thrift.

<cassandradb:system-update-column-family>

Updates properties of a ColumnFamily.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
columnFamily	CfDef with new settings	CfDef	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
String	The new schema version ID.

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
SchemaDisagreementException	Schemas are not in agreement across all nodes
TException	Generic exception class for Thrift.

<cassandradb:system-update-keyspace>

Updates properties of a keyspace.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
keyspaceDef	New keyspace to be applied for update	KsDef	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Returns

Return Type	Description
String	The new schema version ID.

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
SchemaDisagreementException	Schemas are not in agreement across all nodes
TException	Generic exception class for Thrift.

<cassandradb:truncate>

Removes all the rows from the given column family.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
columnFamily	Column Family	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username. NOTE: Please use a dummy username if you have disabled authentication	String	/	UTF-8
password	Optional. A password. NOTE: Leave empty if not required. If specified, the connector will try to login with this credentials	String	/	UTF-8

Exception Payloads

Payload Class	Description
InvalidRequestException	Invalid request could mean keyspace or column family does not exist, required parameters are missing, or a parameter is malformed.
UnavailableException	Not all the replicas required could be created and/or read.
TException	Generic exception class for Thrift.