Google Cloud Spanner CreateDatabase

Google Cloud Spanner CreateDatabase

Certified

Create a Spanner database

Creates a Spanner database with optional DDL statements.

yaml
type: io.kestra.plugin.gcp.spanner.CreateDatabase

Create a Spanner database with a table

yaml
id: spanner_create_database
namespace: company.team

tasks:
  - id: create_db
    type: io.kestra.plugin.gcp.spanner.CreateDatabase
    projectId: "{{ secret('GCP_PROJECT_ID') }}"
    instanceId: my-instance
    databaseId: my-database
    extraDdl:
      - |
        CREATE TABLE users (
          id INT64 NOT NULL,
          name STRING(256),
          age INT64
        ) PRIMARY KEY (id)
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-gcp --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

The Spanner database ID

The Spanner instance ID

The GCP project ID

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Spanner emulator host (host: port), for local testing only

When set, the task connects to a local Spanner emulator instead of the real Spanner service.

SubTypestring

Optional list of DDL statements to run upon creation

The GCP service account to impersonate

SubTypestring

The GCP scopes to be used

The GCP service account

The database name