Scan Scan

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

Run a soda scan

# Examples

Run a scan on BigQuery

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: |
        { YOUR JSON SERVICE ACCOUNT KEY }
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

# args

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

Python command args

Arguments list to pass to main python script

# checks

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

The checks file

# configuration

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

The configuration file

# dockerOptions

Docker options when using runner DOCKER

# env

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

Additional environnements variable to add for current process.

# exitOnFailed

  • Type: boolean
  • Dynamic:
  • Required: ✔️
  • Default: true

Exit if any non true return value

This tells bash that it should exit the script if any statement returns a non-true return value.
The benefit of using -e is that it prevents errors snowballing into serious issues when they could have been caught earlier.

# files

🔒 Deprecated

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

The list of files that will be uploaded to internal storage,

use outputFiles property instead

# inputFiles

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

Input files are extra files supplied by user that make it simpler organize code.

Describe a files map (that can be a map or a json string) that will be written and usable in execution context. You can reach files using a workingDir variable like 'source /myfile.sh'

# interpreter

  • Type: string
  • Dynamic:
  • Required: ✔️
  • Default: /bin/sh
  • Min length: 1

Interpreter to used

# interpreterArgs

  • Type: array
  • SubType: string
  • Dynamic:
  • Required:
  • Default: [-c]

Interpreter args used

# outputDirs

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

Output dirs list that will be uploaded to internal storage

List of key that will generate temporary directories.
On the command, just can use with special variable named outputDirs.key.
If you add a files with ["myDir"], you can use the special vars echo 1 >> {[ outputDirs.myDir }}/file1.txt and echo 2 >> {[ outputDirs.myDir }}/file2.txt and both files will be uploaded to internal storage. Then you can used them on others tasks using {{ outputs.taskId.files['myDir/file1.txt'] }}

# outputFiles

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

Output file list that will be uploaded to internal storage

List of key that will generate temporary files.
On the command, just can use with special variable named outputFiles.key.
If you add a files with ["first"], you can use the special vars echo 1 >> {[ outputFiles.first }} and you used on others tasks using {{ outputs.task-id.files.first }}

# outputsFiles

🔒 Deprecated

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

Deprecated Output file

use outputFiles

# pythonPath

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

The python interpreter to use

Set the python interpreter path to use

# requirements

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

Requirements are python dependencies to add to the python execution process

Python dependencies list to setup in the virtualenv, in the same format than requirements.txt

# runner

  • Type: Runner
  • Dynamic:
  • Required: ✔️
  • Default: PROCESS

Runner to use

# variables

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

The variables to pass

# verbose

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

Enable verbose logging

# warningOnStdErr

  • Type: boolean
  • Dynamic:
  • Required: ✔️
  • Default: true

Use WARNING state if any stdErr is sent

# Outputs

# exitCode

  • Type: integer
  • Default: 0

The exit code of the whole execution

# result

The scan result

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

# value

  • Type: number
  • Dynamic:
  • Required:

# DockerOptions

# deviceRequests

A list of request for devices to be sent to device drivers

# dockerConfig

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

Docker config file

Full file that can be used to configure private registries, ...

# dockerHost

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

Docker api uri

# entryPoint

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

Docker entrypoint to use

# extraHosts

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

Docker extra host to use

# image

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

Docker image to use

# networkMode

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

Docker network mode to use

# pullImage

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

Is a pull of image must be done before starting the container

Mostly used for local image with registry

# user

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

Docker user to use

# 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 enabled on server configuration with kestra.tasks.scripts.docker.volume-enabled to true

# ScanResult

# automatedMonitoringChecks

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

# checks

  • Type: array
  • SubType: Check
  • Dynamic:
  • Required:

# dataTimestamp

  • Type: string
  • Dynamic:
  • Required:

# defaultDataSource

  • Type: string
  • Dynamic:
  • Required:

# definitionName

  • Type: string
  • Dynamic:
  • Required:

# hasErrors

  • Type: boolean
  • Dynamic:
  • Required:

# hasFailures

  • Type: boolean
  • Dynamic:
  • Required:

# hasWarnings

  • Type: boolean
  • Dynamic:
  • Required:

# metadata

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

# metrics

  • Type: array
  • SubType: Metric
  • Dynamic:
  • Required:

# profiling

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

# scanEndTimestamp

  • Type: string
  • Dynamic:
  • Required:

# scanStartTimestamp

  • Type: string
  • Dynamic:
  • Required:

# DockerOptions-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
  • Dynamic:
  • Required:

# Check

# column

  • Type: string
  • Dynamic:
  • Required:

# dataSource

  • Type: string
  • Dynamic:
  • Required:

# definition

  • Type: string
  • Dynamic:
  • Required:

# identity

  • Type: string
  • Dynamic:
  • Required:

# metrics

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

# name

  • Type: string
  • Dynamic:
  • Required:

# outcome

# table

  • Type: string
  • Dynamic:
  • Required: