DataformCLI

yaml
type: "io.kestra.plugin.dataform.cli.DataformCLI"

Examples

yaml
id: dataform
namespace: company.team
tasks:
  - id: wdir
    type: io.kestra.plugin.core.flow.WorkingDirectory
    tasks:
      - id: clone_repo
        type: io.kestra.plugin.git.Clone
        url: https://github.com/dataform-co/dataform-example-project-bigquery

      - id: transform
        type: io.kestra.plugin.dataform.cli.DataformCLI
        beforeCommands:
          - npm install @dataform/core
          - dataform compile
        env:
          GOOGLE_APPLICATION_CREDENTIALS: "sa.json"
        inputFiles:
          sa.json: "{{ secret('GCP_SERVICE_ACCOUNT_JSON') }}"
          .df-credentials.json: |
            {
              "projectId": "<gcp-project-id>",
              "location": "us"
            }
        commands:
          - dataform run --dry-run

Properties

commands*array

SubTypestring

beforeCommandsarray

SubTypestring

containerImagestring

Defaultdataformco/dataform:latest

envobject

SubTypestring

inputFilesobjectstring

namespaceFiles

Definitions

io.kestra.core.models.tasks.NamespaceFiles

enabledbooleanstring

Defaulttrue

excludearray

SubTypestring

folderPerNamespacebooleanstring

Defaultfalse

ifExistsstring

DefaultOVERWRITE

Possible Values

OVERWRITEFAILWARNIGNORE

includearray

SubTypestring

namespacesarray

SubTypestring

Default["{{flow.namespace}}"]

outputFilesarray

SubTypestring

taskRunner

Definitions

Run a task in a Docker container.

type*object

configstringobject

cpu

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

cpusnumberstring

credentials

Credentials for a private container registry.

authstring

identityTokenstring

passwordstring

registrystring

registryTokenstring

usernamestring

deletebooleanstring

Defaulttrue

deviceRequestsarray

A request for devices to be sent to device drivers.

capabilitiesarray

SubTypearray

countintegerstring

deviceIdsarray

SubTypestring

driverstring

optionsobject

SubTypestring

entryPointarray

SubTypestring

Default

[
  ""
]

extraHostsarray

SubTypestring

fileHandlingStrategystring

DefaultVOLUME

Possible Values

MOUNTVOLUME

hoststring

killGracePeriodstring

DefaultPT0S

Formatduration

memory

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

kernelMemorystring

memorystring

memoryReservationstring

memorySwapstring

memorySwappinessstring

oomKillDisablebooleanstring

networkModestring

portBindingsarray

SubTypestring

privilegedbooleanstring

pullPolicyobject

resumebooleanstring

Defaulttrue

shmSizestring

userstring

versionstring

volumesarray

SubTypestring

waitbooleanstring

Defaulttrue

Task runner that executes a task as a subprocess on the Kestra host.

type*object

versionstring

Task runner that executes a task inside a job in Google Cloud Batch.

region*string

type*object

bucketstring

completionCheckIntervalstring

DefaultPT5S

Formatduration

computeResource

io.kestra.plugin.ee.gcp.runner.Batch-ComputeResource

bootDiskstring

cpustring

memorystring

deletebooleanstring

Defaulttrue

entryPointarray

SubTypestring

impersonatedServiceAccountstring

lifecyclePoliciesarray

io.kestra.plugin.ee.gcp.runner.Batch-LifecyclePolicy

actionstring

Possible Values

ACTION_UNSPECIFIEDRETRY_TASKFAIL_TASKUNRECOGNIZED

actionCondition

io.kestra.plugin.ee.gcp.runner.Batch-LifecyclePolicyAction

exitCodesarray

SubTypeinteger

machineTypestring

Defaulte2-medium

maxCreateJobRetryCountintegerstring

Default2

maxRetryCountinteger

Minimum>= 0

Maximum<= 10

networkInterfacesarray

io.kestra.plugin.ee.gcp.runner.Batch-NetworkInterface

network*string

subnetworkstring

projectIdstring

reservationstring

resumebooleanstring

Defaulttrue

scopesarray

SubTypestring

Default["https://www.googleapis.com/auth/cloud-platform"]

serviceAccountstring

syncWorkingDirectorybooleanstring

Defaultfalse

versionstring

waitForLogIntervalstring

DefaultPT5S

Formatduration

waitUntilCompletionstring

DefaultPT1H

Formatduration

Task runner that executes a task inside a job in Google Cloud Run.

region*string

type*object

bucketstring

completionCheckIntervalstring

DefaultPT5S

Formatduration

deletebooleanstring

Defaulttrue

impersonatedServiceAccountstring

maxRetriesintegerstring

Default3

projectIdstring

resumebooleanstring

Defaulttrue

scopesarray

SubTypestring

Default["https://www.googleapis.com/auth/cloud-platform"]

serviceAccountstring

syncWorkingDirectorybooleanstring

versionstring

vpcAccessConnectorstring

vpcEgressstring

Possible Values

VPC_EGRESS_UNSPECIFIEDALL_TRAFFICPRIVATE_RANGES_ONLYUNRECOGNIZED

waitForLogIntervalstring

DefaultPT5S

Formatduration

waitUntilCompletionstring

DefaultPT1H

Formatduration

Task runner that executes a task inside a job in Azure Batch.

account*string

endpoint*string

poolId*string

type*object

accessKeystring

blobStorage

io.kestra.plugin.ee.azure.storage.blob.models.BlobStorageForBatch

containerName*string

connectionStringstring

endpointstring

sharedKeyAccountAccessKeystring

sharedKeyAccountNamestring

completionCheckIntervalstring

DefaultPT5S

Formatduration

deletebooleanstring

Defaulttrue

registry

io.kestra.plugin.ee.azure.batch.models.ContainerRegistry

identityReference

io.kestra.plugin.ee.azure.batch.models.ComputeNodeIdentityReference

resourceIdstring

passwordstring

registryServerstring

userNamestring

resumebooleanstring

Defaulttrue

streamLogsbooleanstring

Defaultfalse

syncWorkingDirectorybooleanstring

Defaultfalse

versionstring

waitUntilCompletionstring

DefaultPT1H

Formatduration

Task runner that executes a task inside a pod in a Kubernetes cluster.

type*object

config

io.kestra.plugin.ee.kubernetes.models.Connection

apiVersionstring

Defaultv1

caCertDatastring

caCertFilestring

clientCertDatastring

clientCertFilestring

clientKeyAlgostring

DefaultRSA

clientKeyDatastring

clientKeyFilestring

clientKeyPassphrasestring

disableHostnameVerificationbooleanstring

keyStoreFilestring

keyStorePassphrasestring

masterUrlstring

Defaulthttps://kubernetes.default.svc

namespacestring

oauthTokenstring

oauthTokenProvider

io.kestra.plugin.ee.kubernetes.models.OAuthTokenProvider

outputstring

task

passwordstring

trustCertsbooleanstring

trustStoreFilestring

trustStorePassphrasestring

usernamestring

containerDefaultSpecobject

containerSpecobject

deletebooleanstring

Defaulttrue

fileSideCarSpecobject

fileSidecar

Default

{
  "image": "busybox"
}

io.kestra.plugin.ee.kubernetes.runner.SideCar

defaultSpecobject

imagestring

Defaultbusybox

resourcesobject

killed

Defaultfalse

java.util.concurrent.atomic.AtomicBoolean

labelsobject

namespacestring

Defaultdefault

nodeSelectorobject

podSpecobject

pullPolicystring

DefaultALWAYS

Possible Values

IF_NOT_PRESENTALWAYSNEVER

resources

io.kestra.plugin.ee.kubernetes.runner.Kubernetes-Resources

limit

io.kestra.plugin.ee.kubernetes.runner.Kubernetes-Resource

cpustring

memorystring

request

io.kestra.plugin.ee.kubernetes.runner.Kubernetes-Resource

cpustring

memorystring

resumebooleanstring

Defaulttrue

serviceAccountNamestring

syncWorkingDirectorybooleanstring

Defaultfalse

versionstring

waitForLogsstring

DefaultPT30S

Formatduration

waitUntilCompletionstring

DefaultPT1H

Formatduration

waitUntilRunningstring

DefaultPT10M

Formatduration

Task runner that executes a task inside a job in AWS Batch.

computeEnvironmentArn*string

region*string

type*object

accessKeyIdstring

bucketstring

completionCheckIntervalstring

DefaultPT5S

Formatduration

deletebooleanstring

Defaulttrue

endpointOverridestring

executionRoleArnstring

jobQueueArnstring

resources

Default

{
  "request": {
    "memory": "2048",
    "cpu": "1"
  }
}

io.kestra.plugin.ee.aws.runner.Batch-Resources

request*

io.kestra.plugin.ee.aws.runner.Batch-Resource

cpu*string

memory*string

resumebooleanstring

Defaulttrue

secretKeyIdstring

sessionTokenstring

sidecarResources

io.kestra.plugin.ee.aws.runner.Batch-Resources

request*

io.kestra.plugin.ee.aws.runner.Batch-Resource

cpu*string

memory*string

stsEndpointOverridestring

stsRoleArnstring

stsRoleExternalIdstring

stsRoleSessionDurationstring

DefaultPT15M

Formatduration

stsRoleSessionNamestring

syncWorkingDirectorybooleanstring

Defaultfalse

taskRoleArnstring

versionstring

waitUntilCompletionstring

DefaultPT1H

Formatduration

Outputs

exitCodeinteger

Default0

outputFilesobject

SubTypestring

taskRunner

Definitions

io.kestra.core.models.tasks.runners.TaskRunnerDetailResult

varsobject

Core Plugins and tasks

Tasks that provide Kestra's built-in orchestration, I/O, and observability capabilities.

CoreStorageScript

PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Database

SurrealDB

Tasks that run SurrealQL queries against SurrealDB.

Database

DataformCLI

More Plugins in this Category

Core Plugins and tasks

PostgreSQL

SurrealDB

1.1.1