PluginsSingerTasksTaps

PipelinewiseMongoDb​Pipelinewise​Mongo​Db

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

A Singer tap to fetch data from a MongoDB database.

Full documentation can be found here

Properties

authDatabase

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

The database name to authenticate on.

database

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

The database name.

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.

awaitTimeMs

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 1000

The maximum amount of time in milliseconds waits for new data changes before exiting.

For LOG_BASED only.

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

includeSchemaInStream

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

Forces the stream names to take the form <database_name>_<collection_name> instead of <collection_name>.

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.

replicaSet

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

The name of replica set.

ssl

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

If ssl is enabled.

sslVerify

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: true

Default SSL verify mode.

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.

updateBufferSize

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 1

The size of the buffer that holds detected update operations in memory.

For LOG_BASED only, the buffer is flushed once the size is reached.

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: ❌