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_snowflake(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
Identifier of the integration to use.
table_name
string
required
The name of the table you want to upload data to.
database
string
required
The name of the database you want to upload data to.
schema
string
required
The name of the schema within the database you want to upload data to.
if_exists
string
default:"fail"
The preferred method for handling existing tables.
  • ‘Fail’ if there is another table with the same name. The default value is ‘fail’ to prevent you from accidentally losing your data or compromising a table’s structure in your database.
  • ‘Replace’ if you want to override the existing table. Keep in mind this option deletes your previous data.
  • ‘Append’ if you want to append the dataset’s rows to the table.
Values must be one of the following:
  • fail
  • replace
  • append
I