Query

yaml

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

Query a MySQL database.

Examples

Send a SQL query to a MySQL Database and fetch a row as output.

yaml

id: mysql_query
namespace: company.team

tasks:
  - id: query
    type: io.kestra.plugin.jdbc.mysql.Query
    url: jdbc:mysql://127.0.0.1:3306/
    username: mysql_user
    password: mysql_password
    sql: select * from mysql_types
    fetchType: FETCH_ONE

Load a csv file into a MySQL table.

yaml

id: mysql_query
namespace: company.team

tasks:
  - id: http_download
    type: io.kestra.plugin.core.http.Download
    uri: https://huggingface.co/datasets/kestra/datasets/raw/main/csv/products.csv

  - id: query
    type: io.kestra.plugin.jdbc.mysql.Query
    url: jdbc:mysql://127.0.0.1:3306/
    username: mysql_user
    password: mysql_password
    inputFile: "{{ outputs.http_download.uri }}"
    sql: |
      LOAD DATA LOCAL INFILE '{{ inputFile }}'
      INTO TABLE products
      FIELDS TERMINATED BY ','
      ENCLOSED BY '"'
      LINES TERMINATED BY '\n'
      IGNORE 1 ROWS;

Properties

`fetchType`

Type: string
Dynamic: ❌
Required: ✔️
Default: NONE
Possible Values:
- STORE
- FETCH
- FETCH_ONE
- NONE

The way you want to store data.

FETCH_ONE - output the first row. FETCH - output all rows as output variable. STORE - store all rows to a file. NONE - do nothing.

`url`

Type: string
Dynamic: ✔️
Required: ✔️

The JDBC URL to connect to the database.

`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`

⚠ Deprecated

Type: boolean
Dynamic: ❌
Required: ❌
Default: false

DEPRECATED, please use fetchType: FETCH instead. Whether to fetch the data from the query result to the task output. This parameter is evaluated after fetchOne and store.

`fetchOne`

⚠ Deprecated

Type: boolean
Dynamic: ❌
Required: ❌
Default: false

DEPRECATED, please use fetchType: FETCH_ONE instead. 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.

`inputFile`

Type: string
Dynamic: ✔️
Required: ❌

Add input file to be loaded with LOAD DATA LOCAL.

The file must be from Kestra's internal storage

`password`

Type: string
Dynamic: ✔️
Required: ❌

The database user's password.

`sql`

Type: string
Dynamic: ✔️
Required: ❌

The SQL query to run.

`store`

⚠ Deprecated

Type: boolean
Dynamic: ❌
Required: ❌
Default: false

DEPRECATED, please use fetchType: FETCH_STORE instead. 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.