Metabase Databases SyncSchema

Metabase Databases SyncSchema

Certified

Trigger Metabase database schema sync

Triggers a schema synchronization (POST /api/database/{id}/sync_schema) for a database. Metabase runs it asynchronously, the task does not wait for it to finish.

yaml
type: io.kestra.plugin.metabase.databases.SyncSchema

Sync database schema after a data warehouse load

yaml
id: metabase_sync_schema
namespace: company.team

tasks:
  - id: sync
    type: io.kestra.plugin.metabase.databases.SyncSchema
    url: "{{ secret('METABASE_URL') }}"
    apiKey: "{{ secret('METABASE_API_KEY') }}"
    databaseId: 3
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-metabase --compatible-for $KESTRA_VERSION

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

Properties

Database ID

The ID of the Metabase database to act on.

Metabase server URL

Base URL of the Metabase instance, for example https://metabase.example.com or http://localhost: 3000.

Metabase API key

API key sent in the x-api-key header. Requires Metabase v0.47 or later. Set exactly one authentication mode: apiKey, sessionToken, or both username and password.

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

Metabase password

Password used to open a session through POST /api/session. Must be set together with username.

DefaultPT1M

HTTP request timeout

Connect and read timeout for each HTTP request made to Metabase. Defaults to 60 seconds. Does not limit the task duration.

Metabase session token

Session token sent in the X-Metabase-Session header. Set exactly one authentication mode: apiKey, sessionToken, or both username and password.

Metabase username

Username or email used to open a session through POST /api/session. Must be set together with password. The session is closed with DELETE /api/session when the task ends.