Query
type: "io.kestra.plugin.cassandra.standard.Query"
Query a Cassandra database with CQL.
Examples
Send a CQL query to a Cassandra database.
id: cassandra_standard_query
namespace: company.team
tasks:
- id: query
type: io.kestra.plugin.cassandra.standard.Query
session:
endpoints:
- hostname: localhost
secureConnection:
truststorePath: path to .crt file
truststorePassword: truststore_password
keystorePath: path to .jks file
keystorePassword: keystore_password
username: cassandra_user
password: cassandra_passwd
cql: SELECT * FROM CQL_KEYSPACE.CQL_TABLE
fetch: true
Properties
cql
- Type: string
- Dynamic: ✔️
- Required: ✔️
CQL query to execute.
session
- Type: CassandraDbSession
- Dynamic: ❌
- Required: ✔️
The session connection properties.
fetch
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
Whether to fetch the data from the query result to the task output.
fetchOne
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
Whether to fetch only one data row from the query result to the task output.
store
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
Whether to store the data from the query result into an ion serialized data file.
Outputs
bytes
- Type: integer
- Required: ❌
The size of the binary response in bytes.
row
- Type: object
- Required: ❌
Map containing the first row of fetched data
Only populated if 'fetchOne' parameter is set to true.
rows
- Type: array
- SubType: object
- Required: ❌
Lit of map containing rows of fetched data
Only populated if 'fetch' parameter is set to true.
size
- Type: integer
- Required: ❌
The size of the fetched rows
Only populated if 'store' or 'fetch' parameter is set to true.
uri
- Type: string
- Required: ❌
- Format:
uri
The url of the result file on kestra storage (.ion file / Amazon Ion text format)
Only populated if 'store' is set to true.
Definitions
io.kestra.plugin.cassandra.standard.CassandraDbSession-SecureConnection
Properties
keystorePassword
- Type: string
- Dynamic: ✔️
- Required: ❌
Password for the keystore file.
keystorePath
- Type: string
- Dynamic: ✔️
- Required: ❌
Path to the keystore file. (*.jks)
truststorePassword
- Type: string
- Dynamic: ✔️
- Required: ❌
Password for the truststore file.
truststorePath
- Type: string
- Dynamic: ✔️
- Required: ❌
Path to the truststore file. (.crt)
io.kestra.plugin.cassandra.standard.CassandraDbSession-Endpoint
Properties
hostname
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Min length:
1
The hostname of the Cassandra server.
port
- Type: integer
- Dynamic: ❌
- Required: ✔️
- Default:
9042
The port of the Cassandra server.
serverName
- Type: string
- Dynamic: ✔️
- Required: ❌
The SNI server name.
In the context of Cloud, this is the string representation of the host ID.
io.kestra.plugin.cassandra.standard.CassandraDbSession
Properties
applicationName
- Type: string
- Dynamic: ✔️
- Required: ❌
The name of the application using the created session.
It will be sent in the STARTUP protocol message, under the key
APPLICATION_NAME
, for each new connection established by the driver. Currently, this information is used by Insights monitoring (if the target cluster does not support Insights, the entry will be ignored by the server).
endpoints
- Type: array
- SubType: CassandraDbSession-Endpoint
- Dynamic: ✔️
- Required: ❌
List of contact endpoints to use for the initial connection to the cluster.
localDatacenter
- Type: string
- Dynamic: ✔️
- Required: ❌
Specifies the datacenter that is considered "local" by the load balancing policy.
password
- Type: string
- Dynamic: ✔️
- Required: ❌
Plaintext authentication password.
secureConnection
- Type: CassandraDbSession-SecureConnection
- Dynamic: ✔️
- Required: ❌
Secure connection details.
username
- Type: string
- Dynamic: ✔️
- Required: ❌
Plaintext authentication username.
Was this page helpful?