Query
type: "io.kestra.plugin.databricks.sql.Query"
Execute a SQL query on a Databricks cluster.
See Retrieve the connection details in the Databricks documentation to discover how to retrieve the needed configuration properties. We're using the Databricks JDBC driver to execute a Query, see https://docs.databricks.com/integrations/jdbc-odbc-bi.html#jdbc-driver-capabilities for its capabilities.
Examples
id: sqlQuery
type: io.kestra.plugin.databricks.sql.Query
accessToken: <your-accessToken>
host: <your-host>
httpPath: <your-httpPath>
sql: SELECT 1
Properties
host
- Type: string
- Dynamic: ✔️
- Required: ✔️
Databricks host.
httpPath
- Type: string
- Dynamic: ✔️
- Required: ✔️
Databricks cluster HTTP Path.
To retrieve the HTTP Path, go to your Databricks cluster, click on Advanced options then, click on JDBC/ODBC. See Retrieve the connection details for more details.
sql
- Type: string
- Dynamic: ✔️
- Required: ✔️
SQL query to be executed.
accessToken
- Type: string
- Dynamic: ✔️
- Required: ❌
Databricks access token.
catalog
- Type: string
- Dynamic: ✔️
- Required: ❌
properties
- Type: object
- SubType: string
- Dynamic: ❌
- Required: ❌
schema
- Type: string
- Dynamic: ✔️
- Required: ❌
timeZoneId
- Type: string
- Dynamic: ❌
- Required: ❌
The time zone id to use for date/time manipulation. Default value is the worker default zone id.
Outputs
size
- Type: integer
- Dynamic: ❓
- Required: ❌
The number of fetched rows.
uri
- Type: string
- Dynamic: ❓
- Required: ❌
- Format:
uri
The URI of the result file in Kestra's internal storage (.ion file i.e. Amazon Ion text format).
Metrics
fetch.size
- Type: counter