Query
type: "io.kestra.plugin.jdbc.rockset.Query"
Query a Rockset server.
Examples
Execute a query and fetch results.
tasks:
- id: select
type: io.kestra.plugin.jdbc.rockset.Query
url: jdbc:rockset://
apiKey: "[apiKey]"
apiServer: "[apiServer]"
sql: |
SELECT *
FROM nation
fetch: true
Properties
url
- Type: string
- Dynamic: ✔️
- Required: ✔️
The JDBC URL to connect to the database.
apiKey
- Type: string
- Dynamic: ✔️
- Required: ❌
apiServer
- Type: string
- Dynamic: ✔️
- Required: ❌
autoCommit
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
true
Whether autocommit is enabled.
Sets this connection's auto-commit mode to the given state. If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback. By default, new connections are in auto-commit mode except when you are using
store
property in which case the auto-commit will be disabled.
fetch
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
Whether to fetch the data from the query result to the task output. This parameter is evaluated after fetchOne
and store
.
fetchOne
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
Whether to fetch only one data row from the query result to the task output. This parameter is evaluated before store
and fetch
.
fetchSize
- Type: integer
- Dynamic: ❌
- Required: ❌
- Default:
10000
Number of rows that should be fetched.
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for this ResultSet object. If the fetch size specified is zero, the JDBC driver ignores the value and is free to make its own best guess as to what the fetch size should be. Ignored if
autoCommit
is false.
password
- Type: string
- Dynamic: ✔️
- Required: ❌
The database user's password.
sql
- Type: string
- Dynamic: ✔️
- Required: ❌
The SQL query to run.
store
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
false
Whether to fetch data row(s) from the query result to a file in internal storage. File will be saved as Amazon Ion (text format).
See Amazon Ion documentation This parameter is evaluated after fetchOne
but before fetch
.
timeZoneId
- Type: string
- Dynamic: ❌
- Required: ❌
The time zone id to use for date/time manipulation. Default value is the worker's default time zone id.
username
- Type: string
- Dynamic: ✔️
- Required: ❌
The database user.
Outputs
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: ❌
List of map containing rows of fetched data.
Only populated if
fetch
parameter is set to true.
size
- Type: integer
- Required: ❌
The number of rows fetched.
Only populated if
store
orfetch
parameter is set to true.
uri
- Type: string
- Required: ❌
- Format:
uri
The URI of the result file on Kestra's internal storage (.ion file / Amazon Ion formatted text file).
Only populated if
store
is set to true.
Definitions
Was this page helpful?