pluginsplugin-sodatasksio.kestra.plugin.soda.scan

Scan

yaml

type: "io.kestra.plugin.soda.Scan"

Run a Soda scan

Examples

Run a scan on BigQuery

yaml

id: "scan"
type: "io.kestra.plugin.soda.Scan"
configuration:
  data_source kestra:
    type: bigquery
    connection:
      project_id: kestra-unit-test
      dataset: demo
      account_info_json: |
        {{ secret('GCP_CREDS') }}
checks:
  checks for orderDetail:
  - row_count > 0
  - max(unitPrice):
      warn: when between 1 and 250
      fail: when > 250
  checks for territory:
  - row_count > 0
  - failed rows:
      name: Failed rows query test
      fail condition: regionId = 4
requirements:
 - soda-core-bigquery

Properties

`checks`

Type: object
Dynamic: ✔️
Required: ✔️

The checks file

`configuration`

Type: object
Dynamic: ✔️
Required: ✔️

The configuration file

`requirements`

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

List of python dependencies to add to the python execution process

Python dependencies list to setup in the virtualenv, in the same format than requirements.txt. It must at least provides dbt.

`runner`

Type: string
Dynamic: ❌
Required: ✔️
Default: DOCKER
Possible Values:
- PROCESS
- DOCKER

Runner to use

`docker`

Type: DockerOptions
Dynamic: ❌
Required: ❌
Default: {image=sodadata/soda-core, pullPolicy=ALWAYS}

Docker options for the DOCKER runner

`env`

Type: object
SubType: string
Dynamic: ✔️
Required: ❌

Additional environment variables for the current process.

`inputFiles`

Type: object
SubType: string
Dynamic: ✔️
Required: ❌

Input files are extra files that will be available in the dbt working directory.

You can define the files as map or a JSON string. Each file can be defined inlined or can reference a file from Kestra's internal storage.

`variables`

Type: object
Dynamic: ✔️
Required: ❌

The variables to pass

`verbose`

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

Whether to enable verbose logging

Outputs

`exitCode`

Type: integer
Default: 0

The exit code of the whole execution

`stdErrLineCount`

Type: integer
Default: 0

The standard error line count

`stdOutLineCount`

Type: integer
Default: 0

The standard output line count

Definitions

`Metric`

`identity`

Type: string
Dynamic: ❓
Required: ❌

`metricName`

Type: string
Dynamic: ❓
Required: ❌

`DeviceRequest`

`capabilities`

Type: array
SubType: array
Dynamic: ❌
Required: ❌

A list of capabilities; an OR list of AND lists of capabilities.

`count`

Type: integer
Dynamic: ❌
Required: ❌

A request for devices to be sent to device drivers

`deviceIds`

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

A request for devices to be sent to device drivers

`driver`

Type: string
Dynamic: ✔️
Required: ❌

A request for devices to be sent to device drivers

`options`

Type: object
SubType: string
Dynamic: ❌
Required: ❌

Driver-specific options, specified as key/value pairs.

These options are passed directly to the driver.

`Credentials`

`auth`

Type: string
Dynamic: ✔️
Required: ❌

The registry auth.

The auth field is a base64-encoded authentication string of username:password or a token.

`identityToken`

Type: string
Dynamic: ✔️
Required: ❌

The identity token.

`password`

Type: string
Dynamic: ✔️
Required: ❌

The registry password.

`registry`

Type: string
Dynamic: ✔️
Required: ❌

The registry url.

if not defined, the registry will be extracted from the image name.

`registryToken`

Type: string
Dynamic: ✔️
Required: ❌

The registry token.

`username`

Type: string
Dynamic: ✔️
Required: ❌

The registry username.

`Memory`

`kernelMemory`

Type: string
Dynamic: ✔️
Required: ❌

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4m. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See --kernel-memory details.

`memory`

Type: string
Dynamic: ✔️
Required: ❌

The maximum amount of memory resources the container can use.

That is, you must set the value to at least 6 megabytes.

`memoryReservation`

Type: string
Dynamic: ✔️
Required: ❌

Allows you to specify a soft limit smaller than --memory which is activated when Docker detects contention or low memory on the host machine.

If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.

`memorySwap`

Type: string
Dynamic: ✔️
Required: ❌

The amount of memory this container is allowed to swap to disk

If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap is the amount of combined memory and swap that can be used, while memory is only the amount of physical memory that can be used.

`memorySwappiness`

Type: string
Dynamic: ✔️
Required: ❌

The amount of memory this container is allowed to swap to disk

By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100, to tune this percentage.

`oomKillDisable`

Type: boolean
Dynamic: ❌
Required: ❌

By default, if an out-of-memory (OOM) error occurs, the kernel kills processes in a container.

To change this behavior, use the oomKillDisable option. Only disable the OOM killer on containers where you have also set the memory option. If the memory flag is not set, the host can run out of memory, and the kernel may need to kill the host system’s processes to free the memory.

`DockerOptions`

`image`

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

Docker image to use

`config`

Type: object
Dynamic: ✔️
Required: ❌

Docker config file

Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json

`cpu`

Type: Cpu
Dynamic: ❌
Required: ❌

Limits the CPU usage to a given maximum threshold value.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

`credentials`

Type: Credentials
Dynamic: ✔️
Required: ❌

Credentials for a private container registry.

`deviceRequests`

Type: array
SubType: DeviceRequest
Dynamic: ❌
Required: ❌

A list of device requests to be sent to device drivers

`entryPoint`

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

Docker entrypoint to use

`extraHosts`

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

Extra hostname mappings to the container network interface configuration

`host`

Type: string
Dynamic: ✔️
Required: ❌

Docker api uri

`memory`

Type: Memory
Dynamic: ❌
Required: ❌

Limits memory usage to a given maximum threshold value.

Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.

`networkMode`

Type: string
Dynamic: ✔️
Required: ❌

Docker network mode to use e.g. host, none, etc.

`pullPolicy`

Type: object
Dynamic: ❓
Required: ❌

`shmSize`

Type: string
Dynamic: ✔️
Required: ❌

Size of /dev/shm in bytes.

The size must be greater than 0. If omitted the system uses 64MB.

`user`

Type: string
Dynamic: ✔️
Required: ❌

User within the container

`volumes`

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

List of volumes to mount

Must be a valid mount expression as string, example : /home/user:/app

Volumes mount are disabled by default for security reasons; you must enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled to true