Query

type: "io.kestra.plugin.jdbc.arrowflight.Query"

Query a database through Apache Arrow Flight SQL driver.

Examples

Send a SQL query to a database and fetch a row as outputs using Apache Arrow Flight SQL driver

id: "query"
type: "io.kestra.plugin.jdbc.arrowflight.Query"
url: jdbc:arrow-flight-sql://localhost:31010/?useEncryption=false
username: dremio
password: dremio123
sql: select * FROM departments
fetch: true

Send a sql query to a Dremio coordinator and fetch a row as outputs using Apache Arrow Flight SQL driver

id: "query"
type: "io.kestra.plugin.jdbc.arrowflight.Query"
url: jdbc:arrow-flight-sql://dremio-coordinator:32010/?schema=postgres.public
username: $token
password: samplePersonalAccessToken
sql: select * FROM departments
fetch: true

Properties

url

• Type: string
• Dynamic: ✔️
• Required: ✔️

The JDBC URL to connect to the database

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 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 default zone id.

username

• Type: string
• Dynamic: ✔️
• Required: ❌

The database user

Outputs

row

• Type: object

Map containing the first row of fetched data

Only populated if 'fetchOne' parameter is set to true.

rows

• Type: array
• SubType: object

Lit of map containing rows of fetched data

Only populated if 'fetch' parameter is set to true.

size

• Type: integer

The size of the fetched rows

Only populated if 'store' or 'fetch' parameter is set to true.

uri

• Type: string

The url of the result file on kestra storage (.ion file / Amazon Ion text format)

Only populated if 'store' is set to true.