PipelinewiseMysql​Pipelinewise​Mysql

yaml
type: "io.kestra.plugin.singer.taps.PipelinewiseMysql"

A Singer tap to fetch data from a MySQL database.

Full documentation can be found here

Examples

yaml
id: "pipelinewisemysql"
type: "io.kestra.plugin.singer.taps.PipelinewiseMysql"
host: 127.0.0.1
username: root
password: mysql_passwd
port: 63306
streamsConfigurations:
  - stream: Category
    replicationMethod: INCREMENTAL
    replicationKeys: categoryId
    selected: true
  - propertiesPattern:
      - description
    selected: false

Properties

host

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

The database hostname.

port

  • Type: integer
  • Dynamic:
  • Required: ✔️

The database port.

stateName

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Default: singer-state

The name of Singer state file stored in KV Store.

streamsConfigurations

The list of stream configurations

username

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

The database user.

command

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

Override default singer command.

containerImage

  • Type: string
  • Dynamic: ✔️
  • Required:
  • Default: python:3.10.12

The task runner container image, only used if the task runner is container-based.

docker

Deprecated, use 'taskRunner' instead

exportBatchRows

  • Type: integer
  • Dynamic:
  • Required:
  • Default: 50000

Number of rows to export from MySQL in one batch.

filterDbs

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

The list of schemas to extract tables only from particular schemas and to improve data extraction performance.

password

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

The database user's password.

pipPackages

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

Override default pip packages to use a specific version.

sessionSqls

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required:
  • Default: [ "SET @@session.time_zone=\"+0:00\"", "SET @@session.wait_timeout=28800", "SET @@session.net_read_timeout=3600", "SET @@session.innodb_lock_wait_timeout=3600" ]

List of SQL commands to run when a connection made. This allows to set session variables dynamically, like timeouts or charsets.

ssl

  • Type: boolean
  • Dynamic:
  • Required:
  • Default: false

If ssl is enabled.

taskRunner

  • Type: TaskRunner
  • Dynamic:
  • Required:
  • Default: { "type": "io.kestra.plugin.scripts.runner.docker.Docker" }

The task runner to use.

Task runners are provided by plugins, each have their own properties.

Outputs

count

  • Type: integer
  • Required:

raw

  • Type: string
  • SubType: string
  • Required:
  • Format: uri

Definitions

io.kestra.plugin.scripts.runner.docker.Cpu

  • cpus
    • Type: integer
    • Dynamic:
    • Required:

io.kestra.core.models.tasks.runners.TaskRunner

  • type
    • Type: string
    • Dynamic:
    • Required: ✔️
    • Validation RegExp: \p{javaJavaIdentifierStart}\p{javaJavaIdentifierPart}*(\.\p{javaJavaIdentifierStart}\p{javaJavaIdentifierPart}*)*
    • Min length: 1

io.kestra.plugin.scripts.runner.docker.Memory

  • kernelMemory
    • Type: string
    • Dynamic: ✔️
    • Required:
  • memory
    • Type: string
    • Dynamic: ✔️
    • Required:
  • memoryReservation
    • Type: string
    • Dynamic: ✔️
    • Required:
  • memorySwap
    • Type: string
    • Dynamic: ✔️
    • Required:
  • memorySwappiness
    • Type: string
    • Dynamic: ✔️
    • Required:
  • oomKillDisable
    • Type: boolean
    • Dynamic:
    • Required:

io.kestra.plugin.scripts.exec.scripts.models.DockerOptions

  • image
    • Type: string
    • Dynamic: ✔️
    • Required: ✔️
    • Min length: 1
  • config
    • Type:
      • string
      • object
    • Dynamic: ✔️
    • Required:
  • cpu
    • Type: Cpu
    • Dynamic:
    • Required:
  • credentials
  • deviceRequests
  • entryPoint
    • Type: array
    • SubType: string
    • Dynamic: ✔️
    • Required:
  • extraHosts
    • Type: array
    • SubType: string
    • Dynamic: ✔️
    • Required:
  • host
    • Type: string
    • Dynamic: ✔️
    • Required:
  • memory
    • Type: Memory
    • Dynamic:
    • Required:
  • networkMode
    • Type: string
    • Dynamic: ✔️
    • Required:
  • pullPolicy
    • Type: string
    • Dynamic:
    • Required:
    • Default: ALWAYS
    • Possible Values:
      • IF_NOT_PRESENT
      • ALWAYS
      • NEVER
  • shmSize
    • Type: string
    • Dynamic: ✔️
    • Required:
  • user
    • Type: string
    • Dynamic: ✔️
    • Required:
  • volumes
    • Type: array
    • SubType: string
    • Dynamic: ✔️
    • Required:

io.kestra.plugin.scripts.runner.docker.Credentials

  • auth
    • Type: string
    • Dynamic: ✔️
    • Required:
  • identityToken
    • Type: string
    • Dynamic: ✔️
    • Required:
  • password
    • Type: string
    • Dynamic: ✔️
    • Required:
  • registry
    • Type: string
    • Dynamic: ✔️
    • Required:
  • registryToken
    • Type: string
    • Dynamic: ✔️
    • Required:
  • username
    • Type: string
    • Dynamic: ✔️
    • Required:

io.kestra.plugin.scripts.runner.docker.DeviceRequest

  • capabilities
    • Type: array
    • SubType: array
    • Dynamic:
    • Required:
  • count
    • Type: integer
    • Dynamic:
    • Required:
  • deviceIds
    • Type: array
    • SubType: string
    • Dynamic: ✔️
    • Required:
  • driver
    • Type: string
    • Dynamic: ✔️
    • Required:
  • options
    • Type: object
    • SubType: string
    • Dynamic:
    • Required:

io.kestra.plugin.singer.models.StreamsConfiguration

  • propertiesPattern
    • Type: array
    • SubType: string
    • Dynamic:
    • Required:
  • replicationKeys
    • Type: string
    • Dynamic:
    • Required:
  • replicationMethod
    • Type: string
    • Dynamic:
    • Required:
    • Possible Values:
      • FULL_TABLE
      • INCREMENTAL
      • LOG_BASED
  • selected
    • Type: boolean
    • Dynamic:
    • Required:
    • Default: true
  • stream
    • Type: string
    • Dynamic:
    • Required: