Cassandra Connector Reference - Mule 4

Configurations

Config

Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	Connection	The connection types that can be provided to this configuration.	x
Expiration Policy	ExpirationPolicy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges instances as needed.

Name

Type

Description

Default Value

Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges instances as needed.

Connection Types

Connection

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value
Host	String	Host name or IP address	localhost
Port	String	Port (default is 9042)	9042
Keyspace	String	Cassandra keyspace
Cluster Name	String	Cassandra cluster name
Cluster Nodes	String	Cassandra cluster nodes are supported. These addresses are the IP or host address and port number separated by comma. Format: `host1:port1, host2:port2`, for example: `127.0.0.1:9160, 127.0.0.2:9160`. If the port is not specified, the default 9042 is used. When you specify this parameter, the host and port from general settings are ignored.
Username	String
Password	String	The password to use for authentication. If the password is null or white spaces only, the connector doesn’t use authentication and the username must also be empty.
Protocol Version	Enumeration, one of: V1 V2 V3 V4	Version of the native protocol supported by the driver.
Max Schema Agreement Wait Seconds	Number	The maximum time to wait for schema agreement before returning from a DDL query.	0
Compression	Enumeration, one of: NONE SNAPPY LZ4	The compression to use for the transport.
SSL	Boolean	Enables the use of SSL for the cluster.	false
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

Host name or IP address

localhost

Port

String

Port (default is 9042)

9042

Keyspace

String

Cassandra keyspace

Cluster Name

String

Cassandra cluster name

Cluster Nodes

String

Cassandra cluster nodes are supported. These addresses are the IP or host address and port number separated by comma. Format: host1:port1, host2:port2, for example: 127.0.0.1:9160, 127.0.0.2:9160. If the port is not specified, the default 9042 is used. When you specify this parameter, the host and port from general settings are ignored.

Username

String

Password

String

The password to use for authentication. If the password is null or white spaces only, the connector doesn’t use authentication and the username must also be empty.

Protocol Version

Enumeration, one of:

V1
V2
V3
V4

Version of the native protocol supported by the driver.

Max Schema Agreement Wait Seconds

Number

The maximum time to wait for schema agreement before returning from a DDL query.

0

Compression

Enumeration, one of:

NONE
SNAPPY
LZ4

The compression to use for the transport.

SSL

Boolean

Enables the use of SSL for the cluster.

false

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Associated Operations

addNewColumn
changeColumnType
createKeyspace
createTable
deleteColumnsValue
deleteRows
dropColumn
dropKeyspace
dropTable
executeCQLQuery
getTableNamesFromKeyspace
insert
renameColumn
select
update

Operations

Add New Column

<cassandra-db:add-new-column>

Adds a new column.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Table	String	The name of the table to use for the operation.		x
Keyspace Name	String	(optional) The keyspace that contains the table to use.
Alter Column Input	AlterColumnInput	POJO defining the name of the new column and its DataType	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Table

String

The name of the table to use for the operation.

x

Keyspace Name

String

(optional) The keyspace that contains the table to use.

Alter Column Input

AlterColumnInput

POJO defining the name of the new column and its DataType

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Change Column Type

<cassandra-db:change-column-type>

Changes the type of a column.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Table	String	The name of the table to use for the operation.		x
Keyspace Name	String	(optional) The keyspace that contains the table to use.
Alter Column Input	AlterColumnInput	POJO defining the name of the column to be changed and the new DataType.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Table

String

The name of the table to use for the operation.

x

Keyspace Name

String

(optional) The keyspace that contains the table to use.

Alter Column Input

AlterColumnInput

POJO defining the name of the column to be changed and the new DataType.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Create Keyspace

<cassandra-db:create-keyspace>

Creates a new keyspace.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Input	CreateKeyspaceInput	Operation input containing the keyspace name and the replication details.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Input

CreateKeyspaceInput

Operation input containing the keyspace name and the replication details.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Create Table

<cassandra-db:create-table>

Creates a table(column family) in a specific keyspace. If no keyspace is specified, the keyspace used for login is used.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Create Table Input	CreateTableInput	Describes the table name, the keyspace name, and the list of columns.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Create Table Input

CreateTableInput

Describes the table name, the keyspace name, and the list of columns.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Delete Columns Value

<cassandra-db:delete-columns-value>

Deletes values from an object specified by the where clause.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Table	String	The name of the table.		x
Keyspace Name	String	(optional) The keyspace that contains the table to use.
Entities	Array of String	Operation input: Columns to delete.		x
Where Clause	Object		`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Table

String

The name of the table.

x

Keyspace Name

String

(optional) The keyspace that contains the table to use.

Entities

Array of String

Operation input: Columns to delete.

x

Where Clause

Object

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Delete Rows

<cassandra-db:delete-rows>

Deletes an entire record.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Table	String	The name of the table.		x
Keyspace Name	String	(optional) The keyspace that contains the table to use.
Where Clause	Object	Operation input: the where clause for the delete operation.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Table

String

The name of the table.

x

Keyspace Name

String

(optional) The keyspace that contains the table to use.

Where Clause

Object

Operation input: the where clause for the delete operation.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Drop Column

<cassandra-db:drop-column>

Removes a column.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Table	String	The name of the table to use for the operation.		x
Keyspace Name	String	(optional) The keyspace that contains the table to use.
Column Name	String	The name of the column to remove.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Table

String

The name of the table to use for the operation.

x

Keyspace Name

String

(optional) The keyspace that contains the table to use.

Column Name

String

The name of the column to remove.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Drop Keyspace

<cassandra-db:drop-keyspace>

Drops the entire keyspace.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Keyspace Name	String	The name of the keyspace to drop.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Keyspace Name

String

The name of the keyspace to drop.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Drop Table

<cassandra-db:drop-table>

Drops an entire table from the specified keyspace, or from the keyspace used for login if none is specified as an operation parameter.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Table Name	String	The name of the table to drop.	`#[payload]`
Keyspace Name	String	(optional) The keyspace which contains the table to drop.
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Table Name

String

The name of the table to drop.

#[payload]

Keyspace Name

String

(optional) The keyspace which contains the table to drop.

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Execute CQL Query

<cassandra-db:execute-cql-query>

Executes the raw input query provided.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Cql Input	CQLQueryInput	Describes the parameterized query to execute along with the parameters.	`#[payload]`
Target Variable	String	The name of a variable in which the output of the operation is stored.
Target Value	String	An expression to evaluate against the operation’s output. The outcome of the expression is stored in the target variable.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Cql Input

CQLQueryInput

Describes the parameterized query to execute along with the parameters.

#[payload]

Target Variable

String

The name of a variable in which the output of the operation is stored.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of the Object.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Get Table Names From Keyspace

<cassandra-db:get-table-names-from-keyspace>

Returns all the table names from the specified keyspace.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Keyspace Name	String	The name of the keyspace to use in the operation.
Target Variable	String	The name of a variable in which the output of the operation is stored.
Target Value	String	An expression to evaluate against the operation’s output. The outcome of the expression is stored in the target variable.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Keyspace Name

String

The name of the keyspace to use in the operation.

Target Variable

String

The name of a variable in which the output of the operation is stored.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of String

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Insert

<cassandra-db:insert>

Executes the insert entity operation.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Table	String	The table name in which the entity is inserted.		x
Keyspace Name	String	(optional) The keyspace that contains the table to use.
Entity To Insert	Object	The entity to insert.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Table

String

The table name in which the entity is inserted.

x

Keyspace Name

String

(optional) The keyspace that contains the table to use.

Entity To Insert

Object

The entity to insert.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Rename Column

<cassandra-db:rename-column>

Renames a column.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Table	String	The name of the table to use for the operation.		x
Keyspace Name	String	(optional) The keyspace that contains the table to use.
Old Column Name	String	The name of the column to change.	`#[payload]`
New Column Name	String	The new value for the name of the column.		x
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Table

String

The name of the table to use for the operation.

x

Keyspace Name

String

(optional) The keyspace that contains the table to use.

Old Column Name

String

The name of the column to change.

#[payload]

New Column Name

String

The new value for the name of the column.

x

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Select

<cassandra-db:select>

Executes a select query.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Query	String	The query to execute.	`#[payload]`
Parameters	Array of Any	The query parameters
Target Variable	String	The name of a variable in which the output of the operation is stored.
Target Value	String	An expression to evaluate against the operation’s output. The outcome of the expression is stored in the target variable.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Query

String

The query to execute.

#[payload]

Parameters

Array of Any

The query parameters

Target Variable

String

The name of a variable in which the output of the operation is stored.

Target Value

String

An expression to evaluate against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of the Object.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Update

<cassandra-db:update>

Executes the update entity operation.

Parameters

Name Type Description Default Value Required

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Table	String	The table name in which the entity is updated.		x
Keyspace Name	String	(optional) The keyspace which contains the table to drop.
Entity To Update	Object	The entity to update.	`#[payload]`
Reconnection Strategy	reconnect reconnect-forever	A retry strategy in case of connectivity errors.

Configuration

String

The name of the configuration to use.

x

Table

String

The table name in which the entity is updated.

x

Keyspace Name

String

(optional) The keyspace which contains the table to drop.

Entity To Update

Object

The entity to update.

#[payload]

Reconnection Strategy

reconnect
reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

config

Throws

CASSANDRA-DB:ALREADY_EXISTS
CASSANDRA-DB:AUTHENTICATION
CASSANDRA-DB:BOOTSTRAPPING
CASSANDRA-DB:BUSY_CONNECTION
CASSANDRA-DB:BUSY_POOL
CASSANDRA-DB:CassandraException
CASSANDRA-DB:CassandraExecution
CASSANDRA-DB:CODEC_NOT_FOUND
CASSANDRA-DB:CONNECTION
CASSANDRA-DB:CONNECTIVITY
CASSANDRA-DB:DRIVER_INTERNAL_ERROR
CASSANDRA-DB:FRAME_TOO_LONG
CASSANDRA-DB:FUNCTION_EXECUTION
CASSANDRA-DB:INVALID_CONFIGURATION_IN_QUERY
CASSANDRA-DB:INVALID_QUERY
CASSANDRA-DB:INVALID_TYPE
CASSANDRA-DB:NO_HOST_AVAILABLE
CASSANDRA-DB:OPERATION_FAILED
CASSANDRA-DB:OPERATION_NOT_APPLIED
CASSANDRA-DB:OPERATION_TIMED_OUT
CASSANDRA-DB:OVERLOADED
CASSANDRA-DB:PAGING_STATE
CASSANDRA-DB:PROTOCOL_ERROR
CASSANDRA-DB:QUERY_CONSISTENCY
CASSANDRA-DB:QUERY_ERROR
CASSANDRA-DB:QUERY_EXECUTION
CASSANDRA-DB:QUERY_VALIDATION
CASSANDRA-DB:READ_FAILURE
CASSANDRA-DB:READ_TIMEOUT
CASSANDRA-DB:RETRY_EXHAUSTED
CASSANDRA-DB:SERVER_ERROR
CASSANDRA-DB:SYNTAX_ERROR
CASSANDRA-DB:TRACE_RETRIEVAL
CASSANDRA-DB:TRANSPORT
CASSANDRA-DB:TRUNCATE
CASSANDRA-DB:UNAUTHORIZED
CASSANDRA-DB:UNAVAILABLE
CASSANDRA-DB:UNKNOWN
CASSANDRA-DB:UNPREPARED
CASSANDRA-DB:UNRESOLVED_USER_TYPE
CASSANDRA-DB:UNSUPPORTED_FEATURE
CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION
CASSANDRA-DB:WRITE_FAILURE
CASSANDRA-DB:WRITE_TIMEOUT

Types

Reconnection

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Reconnection Strategy	reconnect reconnect-forever	The reconnection strategy to use

Field

Type

Description

Default Value

Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

reconnect
reconnect-forever

The reconnection strategy to use

Reconnect

Field	Type	Description	Default Value
Frequency	Number	How often to reconnect (in milliseconds).
Count	Number	The number of reconnection attempts to make.
blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.	true

Field

Type

Description

Default Value

Required

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often in milliseconds to reconnect.
blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.	true

Field

Type

Description

Default Value

Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Expiration Policy

Field Type Description Default Value Required

Field	Type	Description	Default Value	Required
Max Idle Time	Number	A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.
Time Unit	Enumeration, one of: DAYS HOURS MICROSECONDS MILLISECONDS MINUTES NANOSECONDS SECONDS	A time unit that qualifies the `maxIdleTime` attribute.

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

DAYS
HOURS
MICROSECONDS
MILLISECONDS
MINUTES
NANOSECONDS
SECONDS

A time unit that qualifies the maxIdleTime attribute.

Alter Column Input

Field

Type

Description

Default Value

Required

Column

String

Type

Enumeration, one of:

ASCII
BIGINT
BLOB
BOOLEAN
COUNTER
DATE
DECIMAL
DOUBLE
FLOAT
INET
INT
SMALLINT
TEXT
TIME
TIMESTAMP
TIMEUUID
TINYINT
UUID
VARCHAR
VARINT

Create Keyspace Input

Field

Type

Description

Default Value

Required

First Data Center

DataCenter

Keyspace Name

String

Next Data Center

DataCenter

Replication Factor

Number

Replication Strategy Class

Enumeration, one of:

SimpleStrategy
NetworkTopologyStrategy

Data Center

Field

Type

Description

Default Value

Required

Name

String

Value

Number

Create Table Input

Field

Type

Description

Default Value

Required

Columns

Array of ColumnInput

Keyspace Name

String

Table Name

String

Column Input

Field

Type

Description

Default Value

Required

Name

String

Primary Key

Boolean

Type

Enumeration, one of:

ASCII
BIGINT
BLOB
BOOLEAN
COUNTER
DATE
DECIMAL
DOUBLE
FLOAT
INET
INT
SMALLINT
TEXT
TIME
TIMESTAMP
TIMEUUID
TINYINT
UUID
VARCHAR
VARINT

CQL Query Input

Field

Type

Description

Default Value

Required

Cql Query

String

Parameters

Array of Any