Contact Free trial Login

Apache Cassandra Connector 4.0 Reference - Mule 4

Support Category: Select

Anypoint Connector for Cassandra (Cassandra Connector) implements the DataStax Java Driver for Apache Cassandra 3.1.

Configurations


Config

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Connection authentication types to provide to this configuration.

x

Expiration Policy

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

Connection Types

Connection
Parameters
Name Type Description Default Value Required

Host

String

Host name or IP address

Endpoint identification algorithm

Enumeration, one of:

  • HTTPS

  • LDAPS

The endpoint identification algorithm used by clients to validate the server host name. The default value is an empty string, which means that the algorithm is disabled. Clients, including client connections created by the broker for inter-broker communication, verify that the broker host name matches the host name in the broker’s certificate.

HTTPS

Port

String

Port

9042

Cassandra Keyspace

String

Cassandra keyspace

Cassandra Cluster Name

String

Cassandra cluster name

Cassandra Cluster Nodes

String

Cassandra cluster nodes (IP or host address and port separated by commas, for example, host1:port1, host2:port2). If the port is not specified, the connector uses the default port, 9042. When you specify this parameter, the host and port from the general settings are ignored.

Username

String

Username for authentication.

Password

String

Password for authentication. If the password is null or all white spaces, the connector won’t use authentication. In this case, 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 a schema agreement before returning from a DDL query.

0

Compression

Enumeration, one of:

  • LZ4

  • NONE

  • SNAPPY

The compression to use for the transport.

TLS Configuration

TLS

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.

Operations

Add New Table Column

<cassandra-db:add-new-column>

Adds a new column

Parameters

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

The keyspace that contains the table to use

Alter Column Input

POJO defining the name of the new column and its data type

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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. To check compatibility, see CQL type compatibility.

Parameters

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

POJO defining the name of the column to change and the new data type

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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

Configuration

String

The name of the configuration to use.

x

Input

Operation input containing the keyspace name and the replication details

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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 you don’t specify a keyspace, the connector uses the keyspace used for login.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Table Input

The Create Table Input operation, which specifies the table name, keyspace name, and list of columns.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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

Configuration

String

The name of the configuration to use.

x

Table

String

The name of the table

x

Keyspace Name

String

The keyspace that contains the table to use

Entities

Array of String

The columns to delete

x

Where Clause

Object

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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

Configuration

String

The name of the configuration to use.

x

Table

String

The name of the table

x

Keyspace Name

String

The keyspace that contains the table to use

Where Clause

Object

The Where clause for the Delete operation

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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

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

The keyspace that contains the table to use

Column Name

String

The name of the column to remove

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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

Configuration

String

The name of the configuration to use.

x

Keyspace Name

String

The name of the keyspace to drop

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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 form the specified keyspace or from the keyspace used for login if no keyspace is specified as an operation parameter.

Parameters

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

The keyspace that contains the table to drop

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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 specified raw input query

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Cql Input

CQL query input that describes the parametrized query to execute along with the query parameters

#[payload]

Target Variable

String

Name of the variable in which to store the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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:UNPREPARED

  • CASSANDRA-DB:UNRESOLVED_USER_TYPE

  • CASSANDRA-DB:UNSUPPORTED_FEATURE

  • CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION

  • CASSANDRA-DB:WRITE_FAILURE

  • CASSANDRA-DB:WRITE_TIMEOUT

Get All Table Names From Keyspace

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

Returns all table names from the specified keyspace

Parameters

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 on the operation

Target Variable

String

Name of the variable in which to store the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of String

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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:UNPREPARED

  • CASSANDRA-DB:UNRESOLVED_USER_TYPE

  • CASSANDRA-DB:UNSUPPORTED_FEATURE

  • CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION

  • CASSANDRA-DB:WRITE_FAILURE

  • CASSANDRA-DB:WRITE_TIMEOUT

Insert Entity

<cassandra-db:insert>

Executes the Insert Entity operation

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table

String

The name of the table in which to insert the entity

x

Keyspace Name

String

The keyspace that contains the table to use

Entity To Insert

Object

The entity to insert

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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

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

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 name of the column

x

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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: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

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

Name of the variable in which to store the operation’s output

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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:UNPREPARED

  • CASSANDRA-DB:UNRESOLVED_USER_TYPE

  • CASSANDRA-DB:UNSUPPORTED_FEATURE

  • CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION

  • CASSANDRA-DB:WRITE_FAILURE

  • CASSANDRA-DB:WRITE_TIMEOUT

Update Entity

<cassandra-db:update>

Executes the update entity operation

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table

String

The name of the table in which to update the entity

x

Keyspace Name

String

The keyspace that contains the table to drop

Entity To Update

Object

The entity to update

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • CASSANDRA-DB:ALREADY_EXISTS

  • CASSANDRA-DB:AUTHENTICATION

  • CASSANDRA-DB:BOOTSTRAPPING

  • CASSANDRA-DB:BUSY_CONNECTION

  • CASSANDRA-DB:BUSY_POOL

  • CASSANDRA-DB:CASSANDRA_EXECUTION

  • 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_TLS_CONFIGURATION

  • CASSANDRA-DB:INVALID_TYPE

  • CASSANDRA-DB:NO_HOST_AVAILABLE

  • 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: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:UNPREPARED

  • CASSANDRA-DB:UNRESOLVED_USER_TYPE

  • CASSANDRA-DB:UNSUPPORTED_FEATURE

  • CASSANDRA-DB:UNSUPPORTED_PROTOCOL_VERSION

  • CASSANDRA-DB:WRITE_FAILURE

  • CASSANDRA-DB:WRITE_TIMEOUT

Types

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location (which is resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which is resolved relative to the current classpath and file system, if possible) of the keystore.

Type

String

The type of store used.

Alias

String

When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot be reached or is busy.

Custom Ocsp Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

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

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often, in milliseconds, to reconnect

Expiration Policy

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Max Idle Time 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

Keyspace Name

String

Next Data Center

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 Column Input

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