Superset datasets List

Superset datasets List

Certified

List Superset datasets

Retrieves datasets configured in Apache Superset. Pages through all results and returns them according to the selected fetchType.

yaml
type: io.kestra.plugin.superset.datasets.List

List all datasets

yaml
id: list_datasets
namespace: company.team
tasks:
  - id: list
    type: io.kestra.plugin.superset.datasets.List
    url: "{{ secret('SUPERSET_URL') }}"
    username: "{{ secret('SUPERSET_USER') }}"
    password: "{{ secret('SUPERSET_PASSWORD') }}"
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-superset --compatible-for $KESTRA_VERSION

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

Properties

The Superset password

Password associated with the Superset username. Always store this value in a Kestra secret.

The Superset API base URL

Base URL of the Apache Superset API, including the /api/v1 path suffix (for example https://superset.example.com/api/v1).

The Superset username

Username used to authenticate against Apache Superset via POST /security/login.

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
DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

How to return the output data

Controls how datasets are returned: FETCH (all items in output, default), FETCH_ONE (first item only), or STORE (written as an Amazon Ion file in internal storage).

Defaultdb

Authentication provider

Superset authentication provider passed to /security/login. Supported values include db (default), ldap, oauth, and oid.

First retrieved dataset (when FETCH_ONE)

Definitions
idinteger

Dataset ID

schemastring

Schema name

table_namestring

Table name

The retrieved datasets (when FETCH)

Definitions
idinteger

Dataset ID

schemastring

Schema name

table_namestring

Table name

The total count of datasets retrieved

Formaturi

URI of stored datasets in Kestra internal storage (when STORE)