Skip to main content

Usage

The following shows how the step can be used in a recipe.

Examples

  • Signature
General syntax for using the step in a recipe. Shows the inputs and outputs the step is expected to receive and will produce respectively. For futher details see sections below.
export_to_tinybird(ds: dataset, {
    "param": value,
    ...
})

Inputs & Outputs

The following are the inputs expected by the step and the outputs it produces. These are generally columns (ds.first_name), datasets (ds or ds[["first_name", "last_name"]]) or models (referenced by name e.g. "churn-clf").
ds
dataset
required
Dataset to be exported.

Configuration

The following parameters can be used to configure the behaviour of the step by including them in a json object as the last “input” to the step, i.e. step(..., {"param": "value", ...}) -> (output).

Parameters

integration
string
required
Tinybird Integration to be used.
datasource
string
required
Data Source.
if_exists
string
default:"fail"
Configures this step’s behaviour in case the datasource already exists. If you want to override the existing datasource you can use replace, but keep in mind this deletes your previous data. Otherwise if your desired outcome is to append the dataset’s rows to the datasource you can use append.The default value is set to fail to prevent you from accidentally losing data or compromising a datasource’s structure.Values must be one of the following:
  • fail
  • replace
  • append
I