PluginsMySQLTasks

Queries​Queries

yaml
type: "io.kestra.plugin.jdbc.mysql.Queries"

Query a MySQL database.

Examples

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

yaml
id: send_multiple_queries
namespace: test.queries
tasks:
  - id: test_queries_insert
    type: io.kestra.plugin.jdbc.mysql.Queries
    fetchType: FETCH
    url: jdbc:mysql://mysql:3306/kestra
    username: "${{secret('MYSQL_USERNAME')}}"
    password: "${{secret('MYSQL_PASSWORD')}}"
    sql: "{{ read('populate.sql') }}"

  - id: test_queries_select
    type: io.kestra.plugin.jdbc.mysql.Queries
    fetchType: FETCH
    url: jdbc:mysql://mysql:3306/kestra
    username: root
    password: mysql_passwd
    sql: |
      SELECT firstName, lastName FROM employee;
      SELECT brand FROM laptop;

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.

fetch

  • 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

  • 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

parameters

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

Parameters

A map of parameters to bind to the SQL queries. The keys should match the parameter placeholders in the SQL string, e.g., .

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

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.

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.

transaction

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

username

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

The database user.

Outputs

outputs

Definitions

io.kestra.plugin.jdbc.AbstractJdbcBaseQuery-Output

  • row
    • Type: object
    • Dynamic: ❌
    • Required: ❓
  • rows
    • Type: array
    • SubType: object
    • Dynamic: ❌
    • Required: ❓
  • size
    • Type: integer
    • Dynamic: ❌
    • Required: ❓
  • uri
    • Type: string
    • Dynamic: ❌
    • Required: ❓
    • Format: uri