Contact Us 1-800-596-4880
  1. Homepage
  2. Snowflake Connector (1.0)

  3. Snowflake Connector Reference

All Connectors

Snowflake Connector 1.0 Reference

Snowflake Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Snowflake Connection

The connection types to provide to this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Snowflake Connection

Parameters

Name Type Description Default Value Required

Pooling Profile

Snowflake Db Pooling Profile

Provides a way to configure database connection pooling.

Account Name

String

Account name that was provided when registering for the Snowflake account. The account name is in the <OrgId>.<AccountId> format. You can also specify the account name with a cloud region or cloud name, for example, <OrgId>.<AccountId>.<CloudRegion> or <OrgId>.<AccountId>.<CloudRegion>.<CloudName>.

x

Warehouse

String

Name of the Snowflake warehouse to use.

x

Database

String

Snowflake database to connect to.

x

Schema

String

Snowflake database schema to use.

x

User

String

Snowflake database username used to initialize the session.

Password

String

Snowflake database password used to authenticate the user.

Role

String

Role assigned to the user.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Operations

Bulk Delete

<snowflake:bulk-delete>

Enables execution of a single delete statement at various times using different parameter bindings. Using a single database statement has performance advantages compared to executing a single operation at various times.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Input Parameters

Array of Object

A list of maps in which every list item represents a row to delete. The map contains the parameter names as keys and the value the parameter is bound to.

#[payload]

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

Type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a result set. This property is required when streaming is true, in which case a default value of 10 is used.

Max Rows

Number

Sets the limit for the maximum number of rows that any result set object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

SQL String

String

Text of the SQL query to execute.

x

Parameter Types

Array of Parameter Type

Optionally specifies the type of one or more of the parameters in the query. If provided, you’re not required to reference all of the parameters, but you can’t reference a parameter that isn’t present in the input values.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Number

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Bulk Insert

<snowflake:bulk-insert>

Enables execution of a single insert statement at various times using different parameter bindings. Using a single database statement has performance advantages compared to executing a single update operation at various times.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Input Parameters

Array of Object

A list of maps in which every list item represents a row to insert. The map contains the parameter names as keys and the value the parameter is bound to.

#[payload]

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

Type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a result set. This property is required when streaming is true, in which case a default value of 10 is used.

Max Rows

Number

Sets the limit for the maximum number of rows that any result set object generated by the message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

SQL String

String

Text of the SQL query to execute.

x

Parameter Types

Array of Parameter Type

Allows you to optionally specify the type of one or more of the parameters in the query. If provided, you’re not required to reference all of the parameters, but you can’t reference a parameter that isn’t present in the input values.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Number

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Bulk Update

<snowflake:bulk-update>

Enables execution of a single update statement at various times using different parameter bindings. Using a single database statement has performance advantages compared to executing a single update operation at various times.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Input Parameters

Array of Object

A list of maps in which every list item represents a row to update. The map contains the parameter names as keys and the value the parameter is bound to.

#[payload]

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a result set. This property is required when streaming is true, in which case a default value (10) is used.

Max Rows

Number

Sets the limit for the maximum number of rows that any result set object generated by the message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

SQL String

String

Text of the SQL query to execute.

x

Parameter Types

Array of Parameter Type

Enables you to optionally specify the type of one or more of the parameters in the query. If provided, you’re not required to reference all of the parameters, but you can’t reference a parameter that isn’t present in the input values.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Number

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Copy Into Location

<snowflake:copy-into-location>

Unloads data from a table (or query) into one or more files.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Location

One of:

Specifies the internal or external location where the files containing the data to load are staged.

x

Table Query Source

One of:

Specifies the table or query used as the source of the data to unload.

x

File Format

One of:

Specifies the format of the data files to load.

Include Header

Boolean

Specifies whether to include the table column headings in the output files.

false

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

Type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Overwrite

Boolean

Boolean that specifies whether the COPY command overwrites existing files with matching names in the location where the files are stored.

false

Single

Boolean

Boolean that specifies whether to generate a single file or multiple files. If false, a filename prefix must be included in the path.

false

Max File Size

Number

Number (> 0) that specifies the upper size limit (in bytes) of each file to generate in parallel per thread.

16000000

Include Query Id

Boolean

Boolean that specifies whether to uniquely identify unloaded files by including a universally unique identifier (UUID) in the filenames of unloaded data files.

false

Detailed Output

Boolean

Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.

false

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Copy Into Table

<snowflake:copy-into-table>

Loads data from staged files to an existing table. The files must already be staged in one of the following locations:

  • Named internal stage (or table/user stage). Files can be staged using the PUT command.

  • Named external stage that references an external location (Amazon S3, Google Cloud Storage, or Microsoft Azure).

  • External location (Amazon S3, Google Cloud Storage, or Microsoft Azure).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Destination Table Name

String

Specifies the name of the table into which data is loaded.

x

Location

One of:

Specifies the internal or external location where the files containing the data to be loaded are staged.

x

Files

Array of String

Specifies a list of one or more files to load from a staged internal or external location.

Pattern

String

Specifies the file names or paths to match based on a regex pattern.

File Format

One of:

Specifies the format of the data files to load.

Validation Mode

One of:

Specifies that the load operation should only validate data and return the results based on validation options rather than loading data into the specified table.

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

Type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

On Error

String

Action to perform when an error is seen while loading data from a file.

Size Limit

Number

Maximum size in bytes of data to load with a given copy statement.

Purge

Boolean

Specifies whether to remove the data files from the stage automatically after the data is loaded successfully.

false

Return Failed Only

Boolean

Specifies whether to return only files that have failed to load in the statement result.

false

Match By Column Name

Enumeration, one of:

  • CASE_SENSITIVE

  • CASE_INSENSITIVE

  • NONE

Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.

NONE

Enforce Length

Boolean

Specifies whether to truncate text strings that exceed the target column length.

true

Truncate Columns

Boolean

Specifies whether to truncate text strings that exceed the target column length.

false

Force

Boolean

If true, loads all files, regardless of whether they’ve been loaded previously and have not changed since they were loaded.

false

Load Uncertain Files

Boolean

Specifies to load files for which the load status is unknown.

false

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Copy Into Table With Transformation

<snowflake:copy-into-table-with-transformation>

Loads data from staged files to an existing table. The files must already be staged in one of the following locations:

  • Named internal stage (or table/user stage). Files can be staged using the PUT command.

  • Named external stage that references an external location (Amazon S3, Google Cloud Storage, or Microsoft Azure).

  • External location (Amazon S3, Google Cloud Storage, or Microsoft Azure).

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Destination Table Name

String

Specifies the name of the table into which data is loaded.

x

Column Names

Array of String

Specifies an explicit list of table columns (separated by commas) into which you want to insert data.

Transformation Select SQL

String

Specifies an explicit set of fields or columns (separated by commas) to load from the staged data files.

x

Stage Name

String

Specifies the internal or external location where the files containing the data to be loaded are staged.

x

Stage Alias

String

Specifies an optional alias for the FROM value (for example d in COPY INTO t1 (c1) FROM (SELECT d.$1 FROM @mystage/file1.csv.gz d));).

Files

Array of String

Specifies a list of one or more files to load from a staged internal or external location.

Pattern

String

Specifies the file names or paths to match based on a regular expression pattern.

File Format

One of:

Specifies the format of the data files to load.

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

Type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

On Error

String

Action to perform when an error is seen while loading data from a file.

Size Limit

Number

Maximum size in bytes of data to be loaded with a given copy statement.

Purge

Boolean

Specifies whether to remove the data files from the stage automatically after the data is loaded successfully.

false

Return Failed Only

Boolean

Specifies whether to return only files that have failed to load in the statement result.

false

Match By Column Name

Enumeration, one of:

  • CASE_SENSITIVE

  • CASE_INSENSITIVE

  • NONE

Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.

NONE

Enforce Length

Boolean

Specifies whether to truncate text strings that exceed the target column length.

true

Truncate Columns

Boolean

Specifies whether to truncate text strings that exceed the target column length.

false

Force

Boolean

If true, loads all files, regardless of whether they’ve been loaded previously and have not changed since they were loaded.

false

Load Uncertain Files

Boolean

Specifies to load files for which the load status is unknown.

false

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Create Pipe

<snowflake:create-pipe>

Creates a new pipe in the system for defining the COPY INTO <table> statement used by Snowpipe to load data from an ingestion queue into tables.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Pipe Name

String

Specifies the identifier for the pipe; must be unique for the schema in which the pipe is created.

x

Copy Statement

String

Specifies the statement used to load data from queued files into a Snowflake table. This statement serves as the text/definition for the pipe and is displayed in the SHOW PIPES output.

x

Replace Existing Pipe

Boolean

Specifies if an already existing pipe should be overwritten by the one being created.

false

If Not Exists

Boolean

Specifies if the pipe should be created if there isn’t already an existing pipe with the same name.

false

Auto Ingest

One of:

Specifies whether data should be automatically loaded from the specified external stage and optional path when event notifications are received from a configured message service.

Comment

String

Specifies a comment for the pipe.

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Create Stage

<snowflake:create-stage>

Creates a new named stage to use for loading data from files into Snowflake tables and unloading data from tables into files.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Stage Location

One of:

Snowflake internal or external location to create the stage.

x

If Not Exists

Boolean

Specifies if the stage should not be created if there is already an existing stage with the same name.

false

Replace Already Existing Stage

Boolean

Specifies if an already existing stage should be overwritten by the one being created.

false

Is Temporary

Boolean

Specifies whether or not the stage being created is temporary.

false

File Format

One of:

Specifies the type of files for the stage.

Comment

String

Specifies a comment for the stage.

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

On Error

String

Action to perform when an error is seen while loading data from a file.

Size Limit

Number

Maximum size in bytes of data to load with a given copy statement.

Purge

Boolean

Specifies whether to remove the data files from the stage automatically after the data is loaded successfully.

false

Return Failed Only

Boolean

Specifies whether to return only files that have failed to load in the statement result.

false

Match By Column Name

Enumeration, one of:

  • CASE_SENSITIVE

  • CASE_INSENSITIVE

  • NONE

Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.

NONE

Enforce Length

Boolean

Specifies whether to truncate text strings that exceed the target column length.

true

Truncate Columns

Boolean

Specifies whether to truncate text strings that exceed the target column length.

false

Force Load

Boolean

If true, loads all files, regardless of whether they’ve been loaded previously and have not changed since they were loaded.

false

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Create Task

<snowflake:create-task>

Creates a new named external stage to use for:

  • Loading data from files into Snowflake tables

  • Unloading data from tables into files

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Task Name

String

Specifies the name of the task; must be unique for the schema in which the task is created.

x

Warehouse Name

String

Specifies the name of the warehouse.

x

Sql

String

Specifies the query to run.

x

Replace Existing Task

Boolean

Specifies if an existing task should be overwritten by the one being created.

false

If Not Exists

Boolean

Specifies if the task should be created if there isn’t already an existing task with the same name.

false

Session Parameters

Object

Specifies the session parameters to set for the session when the task runs.

Run Timeout

Number

Specifies a time limit in milliseconds on a single task run before it times out.

Copy Grants

Boolean

Specifies whether access permissions from the original task should be retained when cloning or replacing an existing task.

false

Comment

String

Specifies a comment for the task.

After Task

String

Specifies the name of a predecessor task which would trigger the created task whenever the predecessor task is run.

When

String

SQL expression to determine whether a task should run.

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Schedule Option Cron Expression

Schedule Option Cron Expression

Specifies a cron expression and time zone for periodically running the task. Supports a subset of standard cron utility syntax.

Schedule Option Time Interval

Schedule Option Time Interval

Specifies an interval (in minutes) of wait time inserted between runs of the task. Accepts positive integers only.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Delete

<snowflake:delete>

Removes data from a table using an optional WHERE clause and/or additional tables.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a result set. This property is required when streaming is true, in which case a default value of 10 is used.

Max Rows

Number

Sets the limit for the maximum number of rows that any result set object generated by the message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

SQL String

String

Text of the SQL query to execute.

x

Parameter Types

Array of Parameter Type

Optionally specify the type of one or more of the parameters in the query. If provided, you’re not required to reference all of the parameters, but you can’t reference a parameter that isn’t present in the input values.

Input Parameters

Object

Map in which keys are the name of an input parameter to set on the JDBC prepared statement. Reference each parameter in the SQL text using a colon as the prefix, for example where ID = :myParamName. The map’s values will contain the actual assignation for each parameter.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Execute Ddl

<snowflake:execute-ddl>

Data Definition Language (DDL) commands are used to create, manipulate, and modify objects in Snowflake, such as users, virtual warehouses, databases, schemas, tables, views, columns, functions, and stored procedures.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

SQL String

String

SQL DDL statement to execute.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a result set. This property is required when streaming is true, in which case a default value of 10 is used.

Max Rows

Number

Sets the limit for the maximum number of rows that any result set object generated by the message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Execute Script

<snowflake:execute-script>

Executes a SQL script in one single database statement. The script is executed as provided by the user, without any parameter binding.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

SQL Query Text

String

Script Path

String

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a result set. This property is required when streaming is true, in which case a default value of 10 is used.

Max Rows

Number

Sets the limit for the maximum number of rows that any result set object generated by the message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Number

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

Insert

<snowflake:insert>

Updates a table by inserting one or more rows into the table. The values inserted into each column in the table can be explicitly specified or they can be the results of a query.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a result set. This property is required when streaming is true, in which case a default value of 10 is used.

Max Rows

Number

Sets the limit for the maximum number of rows that any result set object generated by the message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

SQL String

String

Text of the SQL query to execute.

x

Parameter Types

Array of Parameter Type

Optionally specify the type of one or more of the parameters in the query. If provided, you’re not required to reference all of the parameters, but you can’t reference a parameter that isn’t present in the input values.

Input Parameters

Object

Map in which keys are the name of an input parameter to set on the JDBC prepared statement. Reference each parameter in the SQL text using a colon as the prefix, for example where ID = :myParamName. The map’s values will contain the actual assignation for each parameter.

Auto Generate Keys

Boolean

Indicates when to make auto-generated keys available for retrieval.

false

Auto Generated Keys Column Indexes

Array of Number

List of column indexes that indicates which auto-generated keys to make available for retrieval.

Auto Generated Keys Column Names

Array of String

List of column names that indicates which auto-generated keys to make available for retrieval.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Statement Result

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

Insert Multi Table

<snowflake:insert-multi-table>

Updates multiple tables by inserting one or more rows with column values (from a query) into the tables. Supports both unconditional and conditional inserts.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Insert Into Multi Table Parameters

One of:

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

Type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

Merge

<snowflake:merge>

Inserts, updates, and deletes values in a table based on values in a second table or a subquery.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Target Table

String

Specifies the table to merge.

x

Source

String

Specifies the table or subquery to join with the target table.

x

Join Expr

String

Specifies the expression on which to join the target table and source.

x

Match Clauses

Array of One of:

Specifies a list of clauses and actions to perform when a match occurs or does not occur.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

Type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Select

<snowflake:select>

SELECT can be used in both a statement and a clause within a SELECT statement. As a statement, the SELECT statement is the most commonly executed SQL statement; it queries the database and retrieves a set of rows. As a clause, SELECT defines the set of columns returned by a query.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

Type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a result set. This property is required when streaming is true, in which case a default value of 10 is used.

Max Rows

Number

Sets the limit for the maximum number of rows that any result set object generated by the message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

SQL String

String

Text of the SQL query to execute.

x

Parameter Types

Array of Parameter Type

Optionally specify the type of one or more of the parameters in the query. If provided, you’re not required to reference all of the parameters, but you can’t reference a parameter that isn’t present in the input values.

Input Parameters

Object

Map in which keys are the name of an input parameter to set on the JDBC prepared statement. Reference each parameter in the SQL text using a colon as the prefix, for example where ID = :myParamName. The map’s values will contain the actual assignation for each parameter.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Stored Procedure

<snowflake:stored-procedure>

Invokes a stored procedure on the database. When the stored procedure returns one or more result set instances, streaming is automatically applied to avoid preemptive consumption of such results, which can lead to performance and memory issues.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a result set. This property is required when streaming is true, in which case a default value of 10 is used.

Max Rows

Number

Sets the limit for the maximum number of rows that any result set object generated by the message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

SQL String

String

Text of the SQL query to execute.

x

Parameter Types

Array of Parameter Type

Optionally specify the type of one or more of the parameters in the query. If provided, you’re not required to reference all of the parameters, but you can’t reference a parameter that isn’t present in the input values.

Input Parameters

Object

Map in which keys are the name of an input parameter to set on the JDBC prepared statement. Reference each parameter in the SQL text using a colon as the prefix, for example where ID = :myParamName. The map’s values will contain the actual assignation for each parameter.

Auto Generate Keys

Boolean

Indicates when to make auto-generated keys available for retrieval.

false

Auto Generated Keys Column Indexes

Array of Number

List of column indexes that indicates which auto-generated keys to make available for retrieval.

Auto Generated Keys Column Names

Array of String

List of column names that indicates which auto-generated keys should be made available for retrieval.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Update

<snowflake:update>

Updates specified rows in the target table with new values.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

Type of joining action that operations can perform for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Indicates how many rows to fetch from the database when rows are read from a resultSet. This property is required when streaming is true, in which case a default value of 10 is used.

Max Rows

Number

Sets the limit for the maximum number of rows that any Result set object generated by the message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

SQL String

String

Text of the SQL query to execute.

x

Parameter Types

Array of Parameter Type

Optionally specify the type of one or more of the parameters in the query. If provided, you’re not required to reference all of the parameters, but you can’t reference a parameter that’s not present in the input values.

Input Parameters

Object

Map in which keys are the name of an input parameter to set on the JDBC prepared statement. Reference each parameter in the SQL text using a colon as the prefix, for example where ID = :myParamName. The map’s values will contain the actual assignation for each parameter.

Auto Generate Keys

Boolean

Indicates when to make auto-generated keys available for retrieval.

false

Auto Generated Keys Column Indexes

Array of Number

List of column indexes that indicates which auto-generated keys to make available for retrieval.

Auto Generated Keys Column Names

Array of String

List of column names that indicates which auto-generated keys to make available for retrieval.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Statement Result

For Configurations

Throws

  • SNOWFLAKE:RETRY_EXHAUSTED

  • SNOWFLAKE:CONNECTIVITY

  • SNOWFLAKE:NOT_FOUND

  • SNOWFLAKE:QUERY_EXECUTION

  • SNOWFLAKE:INVALID_CREDENTIALS

  • SNOWFLAKE:INVALID_INPUT

  • SNOWFLAKE:CANNOT_LOAD_DRIVER

  • SNOWFLAKE:UNKNOWN_SNOWFLAKE_ERROR

  • SNOWFLAKE:DATABASE

Types

Snowflake Db Pooling Profile

Field Type Description Default Value Required

Max Pool Size

Number

Maximum number of connections a pool maintains at any given time

5

Min Pool Size

Number

Minimum number of connections a pool maintains at any given time

0

Acquire Increment

Number

Determines how many connections at a time to try to acquire when the pool is exhausted

1

Prepared Statement Cache Size

Number

Determines how many statements are cached per pooled connection. Setting this to zero will disable statement caching

5

Max Wait

Number

The amount of time a client trying to obtain a connection waits for it to be acquired when the pool is exhausted. Zero (default) means wait indefinitely

0

Max Wait Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A #maxWait.

SECONDS

Max Idle Time

Number

Determines how many seconds a Connection can remain pooled but unused before being discarded. Zero means idle connections never expire.

0

Additional Properties

Object

Reconnection

Reconnection strategy to use.

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector operation source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Parameter Type

Field Type Description Default Value Required

Key

String

The name of the input parameter.

x

Type Classifier

Type Classifier

x

Type Classifier

Field Type Description Default Value Required

Type

Enumeration, one of:

  • BIT

  • TINYINT

  • SMALLINT

  • INTEGER

  • BIGINT

  • FLOAT

  • REAL

  • DOUBLE

  • NUMERIC

  • DECIMAL

  • CHAR

  • VARCHAR

  • LONGVARCHAR

  • DATE

  • TIME

  • TIMESTAMP

  • BINARY

  • VARBINARY

  • LONGVARBINARY

  • NULL

  • OTHER

  • JAVA_OBJECT

  • DISTINCT

  • STRUCT

  • ARRAY

  • BLOB

  • CLOB

  • REF

  • DATALINK

  • BOOLEAN

  • ROWID

  • NCHAR

  • NVARCHAR

  • LONGNVARCHAR

  • NCLOB

  • SQLXML

  • UNKNOWN

Custom Type

String

Schedule Option Cron Expression

Field Type Description Default Value Required

Cron Expression

String

Specifies a cron expression that identifies when to repeat runs of the task.

x

Time Zone

String

Specifies the time zone to use for the cron expression.

x

Schedule Option Time Interval

Field Type Description Default Value Required

Time Interval In Minutes

Number

Specifies a time interval in minutes to wait between periodic runs of the task. Also supports num M syntax.

x

Statement Result

Field Type Description Default Value Required

Affected Rows

Number

Generated Keys

Object

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Repeatable In Memory Stream

When streaming in this mode, Mule does not use the disk to buffer the contents. If you exceed the buffer size, the message fails.

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

Maximum amount of memory to use. If more than what is specified is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Avro

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • GZIP

  • BZ2

  • BROTLI

  • ZSTD

  • DEFLATE

  • RAW_DEFLATE

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Trim Space

Boolean

false

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.

File Format Options CSV

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • GZIP

  • BZ2

  • BROTLI

  • ZSTD

  • DEFLATE

  • RAW_DEFLATE

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Record Delimiter

String

One or more single-byte or multibyte characters that separate records in an input file or unloaded file.

x

Field Delimiter

String

One or more single-byte or multibyte characters that separate records in an input file or unloaded file.

,

File Extension

String

Skip Header Count

Number

0

Skip Blank Lines

Boolean

Specifies whether to skip any blank lines encountered in data, instead of resulting in an end-of-record error.

false

Date Format

String

Auto

Time Format

String

Auto

Timestamp Format

String

Auto

Binary Format

Enumeration, one of:

  • HEX

  • BASE64

  • UTF8

HEX

Escape Character

String

Escape Unenclosed Field Character

String

Specifies a single character used as the escape character for unenclosed field values only.

Trim Space

Boolean

false

Field Optionally Enclosed By

String

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.

x

Error On Column Count Mismatch

Boolean

Specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.

true

Replace Invalid Characters

Boolean

Specifies whether to replace invalid UTF-8 characters with a default Unicode character instead of resulting in an error.

false

Validate UTF8

Boolean

true

Empty Field As Null

Boolean

When set to false, allows empty strings to be loaded in tables without enclosing the field values in quotes.

true

Skip Byte Order Mark

Boolean

Specifies whether to skip any byte order mark information from input files so that they wouldn’t cause errors or be merged into the first table column.

true

Encoding

Enumeration, one of:

  • BIG5

  • EUCJP

  • EUCKR

  • GB18030

  • IBM420

  • IBM424

  • ISO2022CN

  • ISO2022JP

  • ISO2022KR

  • ISO88591

  • ISO88592

  • ISO88595

  • ISO88596

  • ISO88597

  • ISO88598

  • ISO88599

  • KOI8R

  • SHIFTJIS

  • UTF8

  • UTF16

  • UTF16BE

  • UTF16LE

  • UTF32

  • UTF32BE

  • UTF32LE

  • WINDOWS1250

  • WINDOWS1251

  • WINDOWS1252

  • WINDOWS1253

  • WINDOWS1254

  • WINDOWS1255

  • WINDOWS1256

UTF8

File Format Options JSON

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • GZIP

  • BZ2

  • BROTLI

  • ZSTD

  • DEFLATE

  • RAW_DEFLATE

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Date Format

String

Auto

Time Format

String

Auto

Timestamp Format

String

Auto

Binary Format

Enumeration, one of:

  • HEX

  • BASE64

  • UTF8

HEX

Trim Space

Boolean

false

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.

File Extension

String

Enable Octal

Boolean

false

Allow Duplicate

Boolean

false

Strip Outer Array

Boolean

false

Strip Null Values

Boolean

Specifies that the JSON parser should remove object fields or array elements containing null values.

false

Replace Invalid Characters

Boolean

Specifies whether to replace invalid UTF-8 characters with a default Unicode character instead of resulting in an error.

false

Ignore UTF8 Errors

Boolean

Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.

false

Skip Byte Order Mark

Boolean

Specifies whether to skip any byte order mark information from input files so that they won’t cause errors or be merged into the first table column.

true

ORC

Field Type Description Default Value Required

Trim Space

Boolean

false

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.

Parquet

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • LZO

  • SNAPPY

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Binary As Text

Boolean

Specifies whether to interpret columns with no defined logical data type as UTF-8 text when set to true, or binary data when set to false.

true

Trim Space

Boolean

false

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.

XML

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • GZIP

  • BZ2

  • BROTLI

  • ZSTD

  • DEFLATE

  • RAW_DEFLATE

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Ignore UTF8 Errors

Boolean

Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.

false

Preserve Space

Boolean

Specifies whether the XML parser preserves leading and trailing spaces in element content.

false

Strip Outer Element

Boolean

Specifies whether the XML parser strips out the outer XML element, exposing second-level elements as separate documents.

false

Disable Snowflake Data

Boolean

Specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.

false

Disable Auto Convert

Boolean

Specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.

false

Skip Byte Order Mark

Boolean

Specifies whether to skip any byte order mark information from input files so that they won’t cause errors or be merged into the first table column.

true

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.

File Format Definition By Name

Field Type Description Default Value Required

File Format Name

String

Specifies an existing named file format to use for loading and unloading data into or from the table. The named file format determines the format type (CSV, JSON, PARQUET), as well as any other format options, for the data files.

x

File Format Definition By Type Options

Field Type Description Default Value Required

Format Type Options

One of:

Specifies the type of files loaded and unloaded into or from the table. If a format type is specified, additional format-specific options can be specified.

x

True

Field Type Description Default Value Required

Sns Topic

String

Required only when configuring AUTO_INGEST for Amazon S3 stages using Amazon Simple Notification Service (SNS). Specifies the Amazon Resource Name (ARN) for the SNS topic for your S3 bucket. The CREATE PIPE statement subscribes the Amazon Simple Queue Service (SQS) queue to the specified SNS topic. The pipe copies files to the ingest queue triggered by event notifications via the SNS topic.

Integration

String

Required only when configuring AUTO_INGEST for Google Cloud Storage or Microsoft Azure stages. Specifies the existing notification integration used to access the storage queue.

Validation Mode Return Errors

Field Type Description Default Value Required

Validation Error Type

Enumeration, one of:

  • RETURN_ERRORS

  • RETURN_ALL_ERRORS

x

Validation Mode Return Max Rows

Field Type Description Default Value Required

Max Rows

Number

x

Snowflake Location

Field Type Description Default Value Required

Stage Name

String

Files are unloaded to the specified Snowflake location (internal/external stage, table, path):

  • [namespace.]int_stage_name[/path] = Files are unloaded to the specified named internal stage.

  • [namespace.]ext_stage_name[/path] = Files are unloaded to the specified named external stage.

  • [namespace.]%table_name[/path] = Files are unloaded to the stage for the specified table.

  • ~[/path] = Files are unloaded to the stage for the current user.

x

External Location

Field Type Description Default Value Required

External Location Provider

One of:

External system to integrate with Snowflake

x

Internal Stage Location

Field Type Description Default Value Required

Stage Name

String

Internal stage name.

x

External Stage Location

Field Type Description Default Value Required

Stage Name

String

External stage name.

x

External Location Provider

One of:

External system to integrate with Snowflake

x

Microsoft Azure

Field Type Description Default Value Required

Url

String

URL for the Microsoft Azure.

x

Microsoft Azure Storage Integration Credentials

One of:

Security credentials for connecting to Microsoft Azure.

x

Encryption

One of:

Required only for loading from or unloading into encrypted files; not required if storage location and files are unencrypted.

Google Cloud Storage

Field Type Description Default Value Required

Url

String

URL for the Google Cloud Storage.

x

Storage Integration Name

String

Name of the storage integration used to delegate authentication responsibility for external cloud storage.

x

Encryption

One of:

Required only for loading from/unloading into encrypted files; not required if storage location and files are unencrypted.

Amazon S3

Field Type Description Default Value Required

Url

String

URL for the Amazon S3.

x

Amazon S3 Storage Integration Credentials

One of:

The security credentials for connecting to AWS and accessing the private/protected S3 bucket where the files to load/unload are staged.

x

Encryption

One of:

Required only for loading from/unloading into encrypted files; not required if storage location and files are unencrypted.

AWS CSE

Field Type Description Default Value Required

Master Key

String

Specifies the client-side master key used to encrypt the files in the bucket. The master key must be a 128-bit or 256-bit key in Base64-encoded form. Client-side encryption (requires a MASTER_KEY value). Currently, the client-side master key you provide can only be a symmetric key.

x

Aws Sse Kms

Field Type Description Default Value Required

Kms Key Id

String

Optionally specifies the ID for the AWS KMS-managed key used to encrypt files unloaded into the bucket. If no value is provided, your default KMS key ID is used to encrypt files on unload. Note that this value is ignored for data loading.

Gcs Sse Mks

Field Type Description Default Value Required

Kms Key Id

String

Key for Gcs Sse Mks encryption algorithm.

Azure Cse

Field Type Description Default Value Required

Master Key

String

Specifies the client-side master key used to encrypt files. The master key must be a 128-bit or 256-bit key in Base64-encoded form.

x

Amazon S3 Storage Integration

Field Type Description Default Value Required

Storage Integration Name

String

Name of the storage integration used to delegate authentication responsibility for external cloud storage.

x

Amazon S3 Key Credentials

Field Type Description Default Value Required

Aws Key Id

String

AWS Key Id.

x

Aws Key Secret

String

AWS Key Secret.

x

Aws Token

String

AWS Token.

Amazon S3 Role Credentials

Field Type Description Default Value Required

Aws Role

String

AWS Role.

x

Microsoft Azure Storage Integration

Field Type Description Default Value Required

Storage Integration Name

String

Name of the storage integration used to delegate authentication responsibility for external cloud storage.

x

Microsoft Azure Key Credentials

Field Type Description Default Value Required

Azure Sas Token

String

Specifies the SAS (shared access signature) token for connecting to Azure and accessing the private container where the files containing data are staged. Credentials are generated by Azure.

x

Table

Field Type Description Default Value Required

Table Name

String

Specifies the name of the table from which data is unloaded.

x

Query

Field Type Description Default Value Required

Sql

String

SELECT statement that returns data to be unloaded into files. You can limit the number of rows returned by specifying a LIMIT / FETCH clause in the query.

x

Validation Mode

Boolean

Execute COPY in validation mode to return the result of a query and view the data that will be unloaded from the orderstiny table if COPY is executed in normal mode: copy into @my_stage from (select * from orderstiny limit 5) validation_mode='RETURN_ROWS';

false

Definition By Name For Copy Into Location

Field Type Description Default Value Required

File Format Name

String

Specifies an existing named file format to use for unloading data from the table. The named file format determines the format type (CSV, JSON, PARQUET), as well as any other format options, for the data files.

x

Definition By Type For Copy Into Location

Field Type Description Default Value Required

File Format Options For Copy Into Location

One of:

Specifies the type of files unloaded from the table. If a format type is specified, additional format-specific options can be specified.

x

Csv For Copy Into Location

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • GZIP

  • BZ2

  • BROTLI

  • ZSTD

  • DEFLATE

  • RAW_DEFLATE

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Record Delimiter

String

One or more single-byte or multibyte characters that separate records in an input file or unloaded file.

Field Delimiter

String

One or more single-byte or multibyte characters that separate fields in an input file or unloaded file.

File Extension

String

String that specifies the extension for files unloaded to a stage. Accepts any extension. The user is responsible for specifying a valid file extension that can be read by the desired software or service.

Date Format

String

Auto

Time Format

String

Auto

Timestamp Format

String

Auto

Binary Format

Enumeration, one of:

  • HEX

  • BASE64

  • UTF8

HEX

Escape Character

String

NONE

Escape Unenclosed Field Character

String

Field Optionally Enclosed By

String

NONE

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.

Empty Field As Null

Boolean

Used in combination with emptyFieldAsNull when set as false allows empty strings to be loaded in tables without enclosing the field values in quotes.

true

Json For Copy Into Location

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • GZIP

  • BZ2

  • BROTLI

  • ZSTD

  • DEFLATE

  • RAW_DEFLATE

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

File Extension

String

Parquet For Copy Into Location

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • LZO

  • SNAPPY

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Definition By Name For Copy Into Table

Field Type Description Default Value Required

File Format Name

String

Specifies an existing named file format to use for loading data into the table. The named file format determines the format type (CSV, JSON, PARQUET), as well as any other format options, for the data files.

x

Definition By Type For Copy Into Table

Field Type Description Default Value Required

File Format Options For Copy Into Table

One of:

Specifies the type of files loaded into the table. If a format type is specified, additional format-specific options can be specified.

x

Avro For Copy Into Table

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • GZIP

  • BZ2

  • BROTLI

  • ZSTD

  • DEFLATE

  • RAW_DEFLATE

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Trim Space

Boolean

false

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.

Csv For Copy Into Table

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • GZIP

  • BZ2

  • BROTLI

  • ZSTD

  • DEFLATE

  • RAW_DEFLATE

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Record Delimiter

String

One or more single-byte or multibyte characters that separate records in an input file or unloaded file.

Field Delimiter

String

One or more single-byte or multibyte characters that separate records in an input file or unloaded file.

Skip Header Count

Number

0

Skip Blank Lines

Boolean

Specifies whether to skip any blank lines encountered in data, instead of resulting in an end-of-record error.

false

Date Format

String

Auto

Time Format

String

Auto

Timestamp Format

String

Auto

Binary Format

Enumeration, one of:

  • HEX

  • BASE64

  • UTF8

HEX

Escape Character

String

Escape Unenclosed Field Character

String

Specifies a single character used as the escape character for unenclosed field values only.

Trim Space

Boolean

false

Field Optionally Enclosed By

String

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.

Error On Column Count Mismatch

Boolean

Specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.

true

Replace Invalid Characters

Boolean

Specifies whether to replace invalid UTF-8 characters with a default Unicode character instead of resulting in an error.

false

Validate UTF8

Boolean

true

Empty Field As Null

Boolean

Used in combination with emptyFieldAsNull when set as false allows empty strings to be loaded in tables without enclosing the field values in quotes.

true

Skip Byte Order Mark

Boolean

Specifies whether to skip any byte order mark information from input files so that they wouldn’t cause errors or be merged into the first table column.

true

Encoding

Enumeration, one of:

  • BIG5

  • EUCJP

  • EUCKR

  • GB18030

  • IBM420

  • IBM424

  • ISO2022CN

  • ISO2022JP

  • ISO2022KR

  • ISO88591

  • ISO88592

  • ISO88595

  • ISO88596

  • ISO88597

  • ISO88598

  • ISO88599

  • KOI8R

  • SHIFTJIS

  • UTF8

  • UTF16

  • UTF16BE

  • UTF16LE

  • UTF32

  • UTF32BE

  • UTF32LE

  • WINDOWS1250

  • WINDOWS1251

  • WINDOWS1252

  • WINDOWS1253

  • WINDOWS1254

  • WINDOWS1255

  • WINDOWS1256

UTF8

Json For Copy Into Table

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • GZIP

  • BZ2

  • BROTLI

  • ZSTD

  • DEFLATE

  • RAW_DEFLATE

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Date Format

String

Auto

Time Format

String

Auto

Timestamp Format

String

Auto

Binary Format

Enumeration, one of:

  • HEX

  • BASE64

  • UTF8

HEX

Trim Space

Boolean

false

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.

Enable Octal

Boolean

false

Allow Duplicate

Boolean

false

Strip Outer Array

Boolean

false

Strip Null Values

Boolean

Specifies that the JSON parser should remove object fields or array elements containing null values.

false

Ignore UTF8 Errors

Boolean

Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.

false

Skip Byte Order Mark

Boolean

Specifies whether to skip any byte order mark information from input files so that they wouldn’t cause errors or be merged into the first table column.

true

Orc For Copy Into Table

Field Type Description Default Value Required

Trim Space

Boolean

false

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.

Parquet For Copy Into Table

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • SNAPPY

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Binary As Text

Boolean

Specifies whether to interpret columns with no defined logical data type as UTF-8 text when set to True, or binary data when set to False.

true

Trim Space

Boolean

false

Null Ifs

Array of String

Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.

Xml For Copy Into Table

Field Type Description Default Value Required

Compression

Enumeration, one of:

  • AUTO

  • GZIP

  • BZ2

  • BROTLI

  • ZSTD

  • DEFLATE

  • RAW_DEFLATE

  • NONE

Specifies a compression algorithm to use for compressing the unloaded data files.

AUTO

Ignore UTF8 Errors

Boolean

Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.

false

Preserve Space

Boolean

Specifies whether the XML parser preserves leading and trailing spaces in element content.

false

Strip Outer Element

Boolean

Specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.

false

Disable Snowflake Data

Boolean

Specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.

false

Disable Auto Convert

Boolean

Specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.

false

Skip Byte Order Mark

Boolean

Specifies whether to skip any byte order mark information from input files so that they wouldn’t cause errors or be merged into the first table column.

true

Conditional

Field Type Description Default Value Required

Execution Mode

Enumeration, one of:

  • ALL

  • FIRST

x

Conditions

Array of Condition Statement

x

Else Into Clause

String

Overwrite

Boolean

false

Subquery

String

x

Condition Statement

Field Type Description Default Value Required

When Condition

String

x

Into Clauses

Array of String

x

Unconditional

Field Type Description Default Value Required

Into Clauses

Array of String

x

Overwrite

Boolean

false

Subquery

String

x

Not Matched Insert Clause

Field Type Description Default Value Required

Column Names

Array of String

Column Values

Array of String

x

Case Predicate

String

Matched Update Clause

Field Type Description Default Value Required

Update Expression

String

x

Case Predicate

String

Matched Delete Clause

Field Type Description Default Value Required

Case Predicate

String
Back to top
View on GitHub