# mulesoft Snowflake Connector - Full Documentation

<!-- document id=de3c93563c1384dd70fed7f06a2196ad82cacd86af6c9daa95db9ce4af1dc7c0 url=/mulesoft/current/en-us/snowflake-connector/latest/snowflake-connector-fips-config.md -->

---
product: Snowflake Connector
version: 1.4
is-latest-version: true
---

# Configuring FIPS 140-3 for Snowflake Connector

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Snowflake Connector supports FIPS 140-3 compliant cryptographic operations through integration with
BouncyCastle FIPS (BCFIPS) security provider. Learn how to configure the connector for
FIPS-compliant environments.

## Before You Begin

Make sure you meet these prerequisites for the configuration:

- Mule Runtime 4.10.0 or later

- Snowflake Connector version 1.4.0 or later

- BouncyCastle FIPS libraries v2 or later

- Java 17 or later with FIPS-capable JVM

- Snowflake JDBC Driver - FIPS Edition (required for FIPS environments)

> [!WARNING] FIPS-Certified JDBC driver required:
>
> Snowflake provides a separate FIPS-certified JDBC driver specifically designed for FIPS 140-3
> compliant environments. If you operate in a FIPS environment, you must use the FIPS-certified
> driver instead of the standard Snowflake JDBC driver.
>
> - Standard driver  
>   `snowflake-jdbc-<version>.jar` (for non-FIPS environments)
>
> - FIPS driver  
>   `snowflake-jdbc-fips-<version>.jar` (for FIPS environments)
>
> The FIPS driver is built with FIPS-certified cryptographic libraries and is validated for use in
> regulated environments. Using the standard driver in a FIPS environment doesn’t meet compliance
> requirements.
>
> For more information on obtaining the FIPS-certified driver, see the
> [Snowflake JDBC Driver documentation](https://docs.snowflake.com/en/developer-guide/jdbc/jdbc).

## Understanding FIPS Mode Detection

Snowflake Connector automatically detects FIPS mode by checking the `mule.security.model` system
property. When this property is set to a value starting with `fips140` (for example, `fips140-3`),
the connector operates in FIPS mode with enhanced security controls.

Example:

```bash
-Dmule.security.model=fips140-3
```

## Configure BCFIPS with the Snowflake Connector

Configure BCFIPS using one of these options:

- [Configure BCFIPS in Java Security](#configure-bcfips-in-java-security)

- [Enable Auto-Registration](#enable-auto-registration)

> [!NOTE] FIPS approved algorithms only:
>
> Regardless of which configuration option you choose, you must configure the system property
> `org.bouncycastle.fips.approved_only=true` to ensure that the BCFIPS security provider operates
> exclusively with FIPS-approved algorithms.
>
> The connector doesn’t set this property automatically. This is a JVM-wide configuration that
> affects all applications and processes running in the JVM. The system administrator must set this
> property manually or through your Mule runtime configuration.
>
> Example:
>
> ```bash
> -Dorg.bouncycastle.fips.approved_only=true
> ```
>
> Without this property, BCFIPS may allow non-FIPS-approved algorithms, which could violate
> compliance requirements in regulated environments.

### Configure BCFIPS in Java Security (Recommended)

Use this option for production environments to:

- Manage security configuration from a central location

- Apply consistently across all applications

- Avoid runtime modifications to security infrastructure

- Follow enterprise security governance practices

Follow these steps:

1.  Locate your Java security configuration file:

    $JAVA\_HOME/jre/lib/security/java.security

2.  Add the BCFIPS provider to the security provider list. Insert it at an appropriate position
    (typically position 1 or 2):

    ```properties
    security.provider.1=org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider
    security.provider.2=sun.security.provider.Sun
    # ... other providers
    ```

3.  Make sure the BCFIPS JAR is available in the JVM classpath or the Mule application’s shared
    libraries.

4.  Restart your Mule runtime instance.

### Enable Auto-Registration

Use this option for environments where modifying `java.security` is not feasible, the connector can
automatically register BCFIPS at runtime.

> [!WARNING] Important security considerations:
>
> - Modifies the JVM-wide security provider configuration
>
> - May conflict with existing security providers
>
> - Requires explicit approval from your security or compliance team
>
> - Should only be used when
>   [configuring BCFIPS in Java Security](#configure-bcfips-in-java-security) is not possible

Follow these steps:

1.  Set the auto-registration system property:

    ```bash
    -Dmule.snowflake.fips.bcfips.autoregister=true
    ```

2.  Make sure FIPS mode is enabled:

    ```bash
    -Dmule.security.model=fips140-3
    ```

3.  The connector automatically registers BCFIPS when establishing the first connection.

Example Mule runtime startup:

```bash
java -Dmule.security.model=fips140-3 \
     -Dmule.snowflake.fips.bcfips.autoregister=true \
     -Dorg.bouncycastle.fips.approved_only=true \
     -jar mule-standalone.jar
```

## Understanding Standard (Non-FIPS) Mode

In standard mode (when `mule.security.model` isn’t set or doesn’t start with `fips140`), the
connector automatically handles BCFIPS registration without requiring additional configuration. This
ensures seamless operation for non-regulated environments.

## System Properties Reference

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Property</th><th>Description</th><th>Values</th><th>Default</th><th>Scope</th></tr></thead><tbody><tr><td><p><code>mule.security.model</code></p></td><td><p>Enables FIPS mode detection</p></td><td><p><code>fips140-3</code>, <code>fips140-2</code>, or any value starting with <code>fips140</code></p></td><td><p>Not set (standard mode)</p></td><td><p>Connector</p></td></tr><tr><td><p><code>mule.snowflake.fips.bcfips.autoregister</code></p></td><td><p>Enables automatic BCFIPS registration in FIPS mode</p></td><td><p><code>true</code>, <code>false</code></p></td><td><p><code>false</code></p></td><td><p>Connector</p></td></tr><tr><td><p><code>org.bouncycastle.fips.approved_only</code></p></td><td><p><strong>REQUIRED for FIPS compliance.</strong> Restricts BCFIPS to use only FIPS-approved algorithms</p></td><td><p><code>true</code>, <code>false</code></p></td><td><p><code>false</code></p></td><td><p><strong>JVM-wide</strong></p></td></tr></tbody></table>

> [!WARNING] The `org.bouncycastle.fips.approved_only` property affects the entire JVM and all
> applications running in it. This property isn’t set by the connector and the system administrator
> must configure it manually.

## Migrate Existing Deployments

You need to assess the current configuration and choose the appropriate configuration method.

### Non-FIPS Environments

No action required. The connector maintains full backward compatibility and automatically handles
BCFIPS registration.

### For FIPS Environments

1.  Assess the current configuration:

    - Verify if BCFIPS is already configured in `java.security`

    - Check for existing BouncyCastle provider registrations

    - Identify the Snowflake JDBC driver in use (standard versus FIPS-certified)

2.  Choose the configuration method:

    - Recommended: [Configure BCFIPS in `java.security`](#configure-bcfips-in-java-security)

    - Alternative: [Enable auto-registration](#enable-auto-registration)

3.  Configure FIPS-certified components:

    - Replace standard Snowflake JDBC driver with FIPS-certified driver (`snowflake-jdbc-fips`)

    - Make sure BouncyCastle FIPS libraries version 2.x are available

4.  Update system properties:

    - Add `-Dmule.security.model=fips140-3` (enables FIPS mode detection)

    - Add `-Dorg.bouncycastle.fips.approved_only=true` (Required for FIPS compliance)

    - If using auto-registration, add `-Dmule.snowflake.fips.bcfips.autoregister=true`

5.  Test in Non-Production:

    - Deploy to development or staging environment

    - Verify connectivity and operations

    - Review logs for any security-related warnings

6.  Production deployment:

    - Schedule maintenance window

    - Deploy configuration changes

    - Monitor logs for successful FIPS initialization

    - Validate all Snowflake operations

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Studio to Configure Snowflake Connector](https://docs.mulesoft.com/snowflake-connector/latest/snowflake-connector-studio)

- [Snowflake Connector Reference](https://docs.mulesoft.com/snowflake-connector/latest/snowflake-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=2498c782570f944c92dd5e60ee15a3c12e5376d16572c256ed428471497fe272 url=/mulesoft/current/en-us/snowflake-connector/1.3/index.md -->

---
product: Snowflake Connector
version: 1.3
---

# Snowflake Connector 1.3

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Snowflake (Snowflake Connector) enables you to connect with your Snowflake
instance to load data, run queries in Snowflake tables, and sync data with external business
applications.

For information about compatibility and fixed issues, see the Snowflake Connector Release Notes.

## Before You Begin

To use this connector, you must be familiar with:

- The Snowflake API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have:

- Credentials to access the Snowflake target resource

- Anypoint Platform

- Anypoint Studio version 7.5 or later

## Common Use Cases for the Connector

These are some common use cases for Snowflake Connector:

- Load bulk or continuous data into your Snowflake instance.

- Run queries to insert, delete, update, and merge data in Snowflake tables.

- Sync data:

  - Keep unstructured data (files) in an external data location in sync with unstructured data in
    Snowflake, when the external data location is the source of truth.

  - Keep unstructured data (files) in an external data location in sync with unstructured data in
    Snowflake, when Snowflake is the source of truth.

  - Keep structured data (tables) in an external data location in sync with Snowflake (in tables),
    when the external data location is the source of truth.

  - Keep structured data (tables) in an external data location in sync with Snowflake (in tables),
    when Snowflake is the source of truth.

## Connection Types

Use one of the following Snowflake connection types:

- Key-pair Snowflake Connection  
  Enables you to connect to Snowflake using encrypted or unencrypted private keys.

- Basic Snowflake Connection (To be deprecated)  
  Enables you to connect to Snowflake via user and password.

For information about configuring authentication types, see
[Using Anypoint Studio to Configure Snowflake Connector](https://docs.mulesoft.com/snowflake-connector/1.3/snowflake-connector-studio).

## Next Step

After you complete the prerequisites, you are ready to create an app and configure the connector
using [Anypoint Studio](https://docs.mulesoft.com/snowflake-connector/1.3/snowflake-connector-studio).

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Snowflake Connector Reference](https://docs.mulesoft.com/snowflake-connector/1.3/snowflake-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=6030019d27aec965cd4a7b504bef008f10b26918cdfcae2b1e9bf8b38e5ddde5 url=/mulesoft/current/en-us/snowflake-connector/1.3/snowflake-connector-xml-maven.md -->

---
product: Snowflake Connector
version: 1.3
---

# Snowflake Connector 1.3 - XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:

- If you manually code a Mule runtime engine (Mule) app in XML either from the Anypoint Studio XML
  editor or from a text editor, you can access the connector from your app by adding reference
  statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

- If you add the connector in Studio, Studio automatically populates the XML code with the
  connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `mule` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/snowflake
http://www.mulesoft.org/schema/mule/snowflake/current/mule-snowflake.xsd
```

This example shows how the namespace statements are placed in the XML:

```xml
<mule xmlns:snowflake="http://www.mulesoft.org/schema/mule/snowflake"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/snowflake
	http://www.mulesoft.org/schema/mule/snowflake/current/mule-snowflake.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access
to this connector:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule4-snowflake-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `<version>` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `snowflake`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=531a714ef0fe26851e63d0df542c3c0a3ca394cf37cb47c938ae42afcc088a6b url=/mulesoft/current/en-us/snowflake-connector/1.3/snowflake-connector-examples.md -->

---
product: Snowflake Connector
version: 1.3
---

# Snowflake Connector 1.3 Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example returns all rows of a table based on a watermark.

This example uses variables for some field values. You can either:

- Replace the variables with their values in the code.

- Provide the values for each variable in a properties file and then refer to that file from the
  connector configuration.

If you don’t know how to use a properties file, refer to
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

Before you try the examples, access Anypoint Studio (Studio) and verify that the **Mule Palette**
view displays entries for Snowflake Connector. If not, follow the instructions in
[Add the Connector to Your Mule Project](https://docs.mulesoft.com/snowflake-connector/1.3/snowflake-connector-studio#add-connector-to-project).

## Return All Rows of a Table

This example shows how to use the **On Table Row** source to return rows that contain columns with a
greater watermark value than that of the last watermark processed.

The following screenshot shows the app flow for this example:

![Studio Flow for the On Table Row source](/mulesoft/current/en-us/snowflake-connector/1.3/_images/listener-flow.png)

### Add the On Table Row Source

The **On Table Row** source selects from a table at a regular interval and generates one message per
obtained row.

1.  In the **Mule Palette** view, select **Snowflake** and drag the **On Table Row** source to the
    canvas.

2.  In the Search properties window, click **+** next to the **Connector configuration** field to
    add a global element.

3.  Enter the following values:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>Name of the configuration.</p></td></tr><tr><td><p>Config Ref</p></td><td><p><code>Snowflake_Config</code></p></td></tr><tr><td><p>Table</p></td><td><p><code>USERS</code></p></td></tr><tr><td><p>Watermark Column</p></td><td><p><code>CREATION_DATE</code></p></td></tr><tr><td><p>Id Column</p></td><td><p><code>ID</code></p></td></tr><tr><td><p>Since</p></td><td><p><code>2021-12-14 11:00:00.000</code></p></td></tr></tbody></table>

### Add the Transform Message Component

The **Transform Message** component outputs the rows of the table in JSON format.

1.  In the **Mule Palette** view, select **Core** and drag the **Transform Message** component to
    the right of **On Table Row**.

2.  Click the **Transform Message** component and set the output format to `application/json`.

### Add the Logger Component

The **Logger** component logs the query result to the console.

1.  In the **Mule Palette** view, select **Core** and drag the **Logger** component to the right of
    **Transform Message**.

2.  Enter the following values:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p>Display Name</p></td><td><p><code>Logger</code></p></td></tr><tr><td><p>Message</p></td><td><p><code>payload</code></p></td></tr><tr><td><p>Level</p></td><td><p><code>INFO (Default)</code></p></td></tr></tbody></table>

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:db="http://www.mulesoft.org/schema/mule/db" xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:snowflake="http://www.mulesoft.org/schema/mule/snowflake"
	xmlns:salesforce="http://www.mulesoft.org/schema/mule/salesforce" xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/snowflake http://www.mulesoft.org/schema/mule/snowflake/current/mule-snowflake.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/db http://www.mulesoft.org/schema/mule/db/current/mule-db.xsd">

	<configuration-properties file="mule-app.properties"/>

	<snowflake:snowflake-config name="Snowflake_Config" >
		<snowflake:snowflake-connection accountName="${config.accountName}" warehouse="${config.warehouse}" database="${config.database}" schema="${config.schema}" user="${config.user}" password="${config.password}" role="${config.role}"/>
	</snowflake:snowflake-config>
	<snowflake:snowflake-config name="keyPairWithPasswordConfig" >
        	<snowflake:keypair-connection user="${config.user}"  accountName="${config.accountName}" warehouse="${config.warehouse}" database="${config.database}" schema="${config.schema}" privateKeyFile="${app.home}/rsa_key_encrypted.p8" privateKeyPassword="${config.user.keypair.password}" role="${config.role}"/>
    </snowflake:snowflake-config>
	<flow name="listener-flow" >
		<snowflake:row-listener doc:name="Row Listener" config-ref="Snowflake_Config" table="USERS" watermarkColumn="CREATION_DATE" idColumn="ID" since="2021-12-14 11:00:00.000">
			<scheduling-strategy >
				<fixed-frequency />
			</scheduling-strategy>
		</snowflake:row-listener>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<logger level="INFO" doc:name="Logger" message="#[payload]"/>
	</flow>
</mule>
```

### Steps for Running This Example

1.  Verify that your connector is configured.

2.  Save the project.

3.  The terminal will display the new messages for this source.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=819cd7f21bed4e09b4df9162624ad3113e62865f06c2f7d5a5e4c61f135feb1e url=/mulesoft/current/en-us/snowflake-connector/1.3/snowflake-connector-reference.md -->

---
product: Snowflake Connector
version: 1.3
---

# Snowflake Connector 1.3 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

## Snowflake Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#key-pair-connection">Key-pair Connection</a></p></li><li><p><a href="#snowflake-config_snowflake-connection">Basic Snowflake Connection (To be deprecated)</a></p></li></ul></div></div></td><td><div><div><p>The connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Key-pair Connection

For further details on how to configure key-pair authentication, refer to
[configure key-pair authentication](https://docs.snowflake.com/en/user-guide/key-pair-auth#configuring-key-pair-authentication)
Snowflake documentation.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Pooling Profile</strong></p></td><td><div><div><p><a href="#SnowflakeDbPoolingProfile">Snowflake Db Pooling Profile</a></p></div></div></td><td><div><div><p>Configures database connection pooling.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Account Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Account name provided when registering for the Snowflake account. The account name is in the <code>&lt;OrgId&gt;.&lt;AccountId&gt;</code> format. Specify the account name with a cloud region or cloud name, for example, <code>&lt;OrgId&gt;.&lt;AccountId&gt;.&lt;CloudRegion&gt;</code> or <code>&lt;OrgId&gt;.&lt;AccountId&gt;.&lt;CloudRegion&gt;.&lt;CloudName&gt;</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Warehouse</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the Snowflake warehouse to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Database</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database to connect to.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Schema</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database schema to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>User</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database username used to initialize the session.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Private Key File Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Private key path used to authenticate the user.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Private Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password to decrypt an encrypted private key. Only for encrypted private keys.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Role</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Role assigned to the user.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Basic Snowflake Connection (To be deprecated)

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Pooling Profile</strong></p></td><td><div><div><p><a href="#SnowflakeDbPoolingProfile">Snowflake Db Pooling Profile</a></p></div></div></td><td><div><div><p>Provides a way to configure database connection pooling.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Account Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Account name that was provided when registering for the Snowflake account. The account name is in the <code>&lt;OrgId&gt;.&lt;AccountId&gt;</code> format. You can also specify the account name with a cloud region or cloud name, for example, <code>&lt;OrgId&gt;.&lt;AccountId&gt;.&lt;CloudRegion&gt;</code> or <code>&lt;OrgId&gt;.&lt;AccountId&gt;.&lt;CloudRegion&gt;.&lt;CloudName&gt;</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Warehouse</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the Snowflake warehouse to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Database</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database to connect to.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Schema</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database schema to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>User</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database username used to initialize the session.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database password used to authenticate the user.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Role</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Role assigned to the user.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Supported Operations

- [Bulk Delete](#bulkDelete)

- [Bulk Insert](#bulkInsert)

- [Bulk Update](#bulkUpdate)

- [Copy Into Location](#copyIntoLocation)

- [Copy Into Table](#copyIntoTable)

- [Copy Into Table With Transformation](#copyIntoTableWithTransformation)

- [Create Pipe](#createPipe)

- [Create Stage](#createStage)

- [Create Task](#createTask)

- [Delete](#delete)

- [Execute Ddl](#executeDdl)

- [Execute Script](#executeScript)

- [Insert](#insert)

- [Insert Multi Table](#insertMultiTable)

- [Merge](#merge)

- [Select](#select)

- [Stored Procedure](#storedProcedure)

- [Update](#update)

## Associated Sources

- [On Table Row](#Listener)

## 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can take regarding transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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 (<code>10</code>) is used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Location</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#SnowflakeLocation">Snowflake Location</a></p></li><li><p><a href="#ExternalLocation">External Location</a></p></li></ul></div></div></td><td><div><div><p>Specifies the internal or external location where the files containing the data to load are staged.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Table Query Source</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#table">Table</a></p></li><li><p><a href="#query">Query</a></p></li></ul></div></div></td><td><div><div><p>Specifies the table or query used as the source of the data to unload.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>File Format</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#DefinitionByNameForCopyIntoLocation">Definition By Name For Copy Into Location</a></p></li><li><p><a href="#DefinitionByTypeForCopyIntoLocation">Definition By Type For Copy Into Location</a></p></li></ul></div></div></td><td><div><div><p>Specifies the format of the data files to load.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Include Header</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to include the table column headings in the output files.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Overwrite</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Boolean that specifies whether the COPY command overwrites existing files with matching names in the location where the files are stored.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Single</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Boolean that specifies whether to generate a single file or multiple files. If <code>false</code>, a filename prefix must be included in the path.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max File Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number (&gt; 0) that specifies the upper size limit (in bytes) of each file to generate in parallel per thread.</p></div></div></td><td><div><div><p>16000000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Include Query Id</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Boolean that specifies whether to uniquely identify unloaded files by including a universally unique identifier (UUID) in the filenames of unloaded data files.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Detailed Output</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Destination Table Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of the table into which data is loaded.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Location</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#SnowflakeLocation">Snowflake Location</a></p></li><li><p><a href="#ExternalLocation">External Location</a></p></li></ul></div></div></td><td><div><div><p>Specifies the internal or external location where the files containing the data to be loaded are staged.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Files</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of one or more files to load from a staged internal or external location.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pattern</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the file names or paths to match based on a regex pattern.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>File Format</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#DefinitionByNameForCopyIntoTable">Definition By Name For Copy Into Table</a></p></li><li><p><a href="#DefinitionByTypeForCopyIntoTable">Definition By Type For Copy Into Table</a></p></li></ul></div></div></td><td><div><div><p>Specifies the format of the data files to load.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Validation Mode</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#ValidationModeReturnErrors">Validation Mode Return Errors</a></p></li><li><p><a href="#ValidationModeReturnMaxRows">Validation Mode Return Max Rows</a></p></li></ul></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>On Error</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Action to perform when an error is seen while loading data from a file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Size Limit</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size in bytes of data to load with a given copy statement.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Purge</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to remove the data files from the stage automatically after the data is loaded successfully.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Return Failed Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to return only files that have failed to load in the statement result.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Match By Column Name</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>CASE_SENSITIVE</p></li><li><p>CASE_INSENSITIVE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.</p></div></div></td><td><div><div><p>NONE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enforce Length</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Truncate Columns</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Force</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, loads all files, regardless of whether they’ve been loaded previously and have not changed since they were loaded.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Load Uncertain Files</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies to load files for which the load status is unknown.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Destination Table Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of the table into which data is loaded.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Column Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies an explicit list of table columns (separated by commas) into which you want to insert data.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transformation Select SQL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies an explicit set of fields or columns (separated by commas) to load from the staged data files.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Stage Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the internal or external location where the files containing the data to be loaded are staged.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Stage Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies an optional alias for the FROM value (for example <code>d</code> in <code>COPY INTO t1 (c1) FROM (SELECT d.$1 FROM @mystage/file1.csv.gz d));</code>).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Files</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of one or more files to load from a staged internal or external location.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pattern</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the file names or paths to match based on a regular expression pattern.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>File Format</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#DefinitionByNameForCopyIntoTable">Definition By Name For Copy Into Table</a></p></li><li><p><a href="#DefinitionByTypeForCopyIntoTable">Definition By Type For Copy Into Table</a></p></li></ul></div></div></td><td><div><div><p>Specifies the format of the data files to load.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>On Error</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Action to perform when an error is seen while loading data from a file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Size Limit</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size in bytes of data to be loaded with a given copy statement.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Purge</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to remove the data files from the stage automatically after the data is loaded successfully.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Return Failed Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to return only files that have failed to load in the statement result.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Match By Column Name</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>CASE_SENSITIVE</p></li><li><p>CASE_INSENSITIVE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.</p></div></div></td><td><div><div><p>NONE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enforce Length</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Truncate Columns</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Force</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If true, loads all files, regardless of whether they’ve been loaded previously and have not changed since they were loaded.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Load Uncertain Files</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies to load files for which the load status is unknown.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Pipe Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the identifier for the pipe; must be unique for the schema in which the pipe is created.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Copy Statement</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Replace Existing Pipe</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if an already existing pipe should be overwritten by the one being created.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>If Not Exists</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if the pipe should be created if there isn’t already an existing pipe with the same name.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Ingest</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#true">True</a></p></li><li><p>false</p></li></ul></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Comment</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a comment for the pipe.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Stage Location</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#InternalStageLocation">Internal Stage Location</a></p></li><li><p><a href="#ExternalStageLocation">External Stage Location</a></p></li></ul></div></div></td><td><div><div><p>Snowflake internal or external location to create the stage.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>If Not Exists</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if the stage should not be created if there is already an existing stage with the same name.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Replace Already Existing Stage</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if an already existing stage should be overwritten by the one being created.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Is Temporary</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether or not the stage being created is temporary.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>File Format</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#FileFormatDefinitionByName">File Format Definition By Name</a></p></li><li><p><a href="#FileFormatDefinitionByTypeOptions">File Format Definition By Type Options</a></p></li></ul></div></div></td><td><div><div><p>Specifies the type of files for the stage.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Comment</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a comment for the stage.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>On Error</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Action to perform when an error is seen while loading data from a file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Size Limit</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size in bytes of data to load with a given copy statement.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Purge</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to remove the data files from the stage automatically after the data is loaded successfully.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Return Failed Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to return only files that have failed to load in the statement result.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Match By Column Name</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>CASE_SENSITIVE</p></li><li><p>CASE_INSENSITIVE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.</p></div></div></td><td><div><div><p>NONE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enforce Length</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Truncate Columns</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Force Load</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, loads all files, regardless of whether they’ve been loaded previously and have not changed since they were loaded.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Task Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of the task; must be unique for the schema in which the task is created.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Warehouse Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of the warehouse.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Sql</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the query to run.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Replace Existing Task</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if an existing task should be overwritten by the one being created.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>If Not Exists</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if the task should be created if there isn’t already an existing task with the same name.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Session Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Specifies the session parameters to set for the session when the task runs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Run Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Specifies a time limit in milliseconds on a single task run before it times out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Grants</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether access permissions from the original task should be retained when cloning or replacing an existing task.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Comment</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a comment for the task.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>After Task</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of a predecessor task which would trigger the created task whenever the predecessor task is run.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>When</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>SQL expression to determine whether a task should run.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Schedule Option Cron Expression</strong></p></td><td><div><div><p><a href="#ScheduleOptionCronExpression">Schedule Option Cron Expression</a></p></div></div></td><td><div><div><p>Specifies a cron expression and time zone for periodically running the task. Supports a subset of standard cron utility syntax.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Schedule Option Time Interval</strong></p></td><td><div><div><p><a href="#ScheduleOptionTimeInterval">Schedule Option Time Interval</a></p></div></div></td><td><div><div><p>Specifies an interval (in minutes) of wait time inserted between runs of the task. Accepts positive integers only.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>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 <code>ID = :myParamName</code>. The map’s values will contain the actual assignation for each parameter.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>SQL DDL statement to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL Query Text</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Script Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>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 <code>ID = :myParamName</code>. The map’s values will contain the actual assignation for each parameter.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generate Keys</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates when to make auto-generated keys available for retrieval.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Indexes</strong></p></td><td><div><div><p>Array of Number</p></div></div></td><td><div><div><p>List of column indexes that indicates which auto-generated keys to make available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List of column names that indicates which auto-generated keys to make available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#StatementResult">Statement Result</a></p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Insert Into Multi Table Parameters</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#Conditional">Conditional</a></p></li><li><p><a href="#Unconditional">Unconditional</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Table</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the table to merge.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Source</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the table or subquery to join with the target table.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Join Expr</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the expression on which to join the target table and source.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Match Clauses</strong></p></td><td><div><div><p>Array of One of:</p></div><div><ul><li><p><a href="#NotMatchedInsertClause">Not Matched Insert Clause</a></p></li><li><p><a href="#MatchedUpdateClause">Matched Update Clause</a></p></li><li><p><a href="#MatchedDeleteClause">Matched Delete Clause</a></p></li></ul></div></div></td><td><div><div><p>Specifies a list of clauses and actions to perform when a match occurs or does not occur.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>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 <code>ID = :myParamName</code>. The map’s values will contain the actual assignation for each parameter.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>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 <code>ID = :myParamName</code>. The map’s values will contain the actual assignation for each parameter.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generate Keys</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates when to make auto-generated keys available for retrieval.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Indexes</strong></p></td><td><div><div><p>Array of Number</p></div></div></td><td><div><div><p>List of column indexes that indicates which auto-generated keys to make available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List of column names that indicates which auto-generated keys should be made available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>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 <code>ID = :myParamName</code>. The map’s values will contain the actual assignation for each parameter.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generate Keys</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates when to make auto-generated keys available for retrieval.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Indexes</strong></p></td><td><div><div><p>Array of Number</p></div></div></td><td><div><div><p>List of column indexes that indicates which auto-generated keys to make available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List of column names that indicates which auto-generated keys to make available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#StatementResult">Statement Result</a></p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

## Sources

### On Table Row

`<snowflake:listener>`

Returns all rows of a table based on a watermark.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Transactional Action</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_BEGIN</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Type of joining action that sources can perform for transactions.</p></td><td><p>NONE</p></td><td></td></tr><tr><td><p>Transaction Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>LOCAL</p></li><li><p>XA</p></li></ul></div></div></td><td><p>Type of transaction to create. Availability depends on the Mule runtime version.</p></td><td><p>LOCAL</p></td><td></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines whether to execute this source on only the primary node when running Mule instances in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p>RedeliveryPolicy</p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Table</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the table to select rows from.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Watermark Column</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the column to use for the watermark. Values taken from this column are used to filter the contents of the next poll, so that rows only with a greater watermark value are processed.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Id Column</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the column to consider as the row ID. If provided, this parameter ensures the same row is not processed twice by concurrent polls.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Since</p></td><td><div><div><p>String</p></div></div></td><td><p>Limits the initial amount of registers returned in the results.</p></td><td></td><td></td></tr><tr><td><p>Query Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Query Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Query Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Fetch Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Indicates how many rows to fetch from the database when rows are read from a result set. This parameter is required when streaming is true, in which case a default value (<code>10</code>) is used.</p></td><td></td><td></td></tr><tr><td><p>Max Rows</p></td><td><div><div><p>Number</p></div></div></td><td><p>Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>Object</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Snowflake Configuration](#snowflake-config)

## Types

### Snowflake Db Pooling Profile

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Pool Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of connections a pool maintains at any given time</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Min Pool Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Minimum number of connections a pool maintains at any given time</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Acquire Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Determines how many connections at a time to try to acquire when the pool is exhausted</p></div></div></td><td><div><div><p>1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Prepared Statement Cache Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Determines how many statements are cached per pooled connection. Setting this to zero will disable statement caching</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Wait</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Wait Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A #maxWait.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Determines how many seconds a Connection can remain pooled but unused before being discarded. Zero means idle connections never expire.</p></div></div></td><td><div><div><p>10800</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Additional Properties</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Reconnection strategy to use.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Parameter Type

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the input parameter.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Type Classifier</strong></p></td><td><div><div><p><a href="#TypeClassifier">Type Classifier</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Type Classifier

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BIT</p></li><li><p>TINYINT</p></li><li><p>SMALLINT</p></li><li><p>INTEGER</p></li><li><p>BIGINT</p></li><li><p>FLOAT</p></li><li><p>REAL</p></li><li><p>DOUBLE</p></li><li><p>NUMERIC</p></li><li><p>DECIMAL</p></li><li><p>CHAR</p></li><li><p>VARCHAR</p></li><li><p>LONGVARCHAR</p></li><li><p>DATE</p></li><li><p>TIME</p></li><li><p>TIMESTAMP</p></li><li><p>BINARY</p></li><li><p>VARBINARY</p></li><li><p>LONGVARBINARY</p></li><li><p>NULL</p></li><li><p>OTHER</p></li><li><p>JAVA_OBJECT</p></li><li><p>DISTINCT</p></li><li><p>STRUCT</p></li><li><p>ARRAY</p></li><li><p>BLOB</p></li><li><p>CLOB</p></li><li><p>REF</p></li><li><p>DATALINK</p></li><li><p>BOOLEAN</p></li><li><p>ROWID</p></li><li><p>NCHAR</p></li><li><p>NVARCHAR</p></li><li><p>LONGNVARCHAR</p></li><li><p>NCLOB</p></li><li><p>SQLXML</p></li><li><p>UNKNOWN</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Custom Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Schedule Option Cron Expression

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Cron Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a cron expression that identifies when to repeat runs of the task.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Time Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the time zone to use for the cron expression.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Schedule Option Time Interval

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Time Interval In Minutes</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Specifies a time interval in minutes to wait between periodic runs of the task. Also supports num M syntax.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Statement Result

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Affected Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Generated Keys</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which all these attributes are expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Avro

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### File Format Options CSV

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Record Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate records in an input file or unloaded file.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Field Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate records in an input file or unloaded file.</p></div></div></td><td><div><div><p>,</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>File Extension</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Header Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Blank Lines</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to skip any blank lines encountered in data, instead of resulting in an end-of-record error.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Date Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary Format</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HEX</p></li><li><p>BASE64</p></li><li><p>UTF8</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>HEX</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Unenclosed Field Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a single character used as the escape character for unenclosed field values only.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Field Optionally Enclosed By</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Error On Column Count Mismatch</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Replace Invalid Characters</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to replace invalid UTF-8 characters with a default Unicode character instead of resulting in an error.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Validate UTF8</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Empty Field As Null</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When set to <code>false</code>, allows empty strings to be loaded in tables without enclosing the field values in quotes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BIG5</p></li><li><p>EUCJP</p></li><li><p>EUCKR</p></li><li><p>GB18030</p></li><li><p>IBM420</p></li><li><p>IBM424</p></li><li><p>ISO2022CN</p></li><li><p>ISO2022JP</p></li><li><p>ISO2022KR</p></li><li><p>ISO88591</p></li><li><p>ISO88592</p></li><li><p>ISO88595</p></li><li><p>ISO88596</p></li><li><p>ISO88597</p></li><li><p>ISO88598</p></li><li><p>ISO88599</p></li><li><p>KOI8R</p></li><li><p>SHIFTJIS</p></li><li><p>UTF8</p></li><li><p>UTF16</p></li><li><p>UTF16BE</p></li><li><p>UTF16LE</p></li><li><p>UTF32</p></li><li><p>UTF32BE</p></li><li><p>UTF32LE</p></li><li><p>WINDOWS1250</p></li><li><p>WINDOWS1251</p></li><li><p>WINDOWS1252</p></li><li><p>WINDOWS1253</p></li><li><p>WINDOWS1254</p></li><li><p>WINDOWS1255</p></li><li><p>WINDOWS1256</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>UTF8</p></div></div></td><td><div></div></td></tr></tbody></table>

### File Format Options JSON

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Date Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary Format</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HEX</p></li><li><p>BASE64</p></li><li><p>UTF8</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>HEX</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>File Extension</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable Octal</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Allow Duplicate</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Outer Array</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Null Values</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies that the JSON parser should remove object fields or array elements containing null values.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Replace Invalid Characters</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to replace invalid UTF-8 characters with a default Unicode character instead of resulting in an error.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Ignore UTF8 Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### ORC

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Parquet

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>LZO</p></li><li><p>SNAPPY</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary As Text</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### XML

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Ignore UTF8 Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Preserve Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser preserves leading and trailing spaces in element content.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Outer Element</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser strips out the outer XML element, exposing second-level elements as separate documents.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Disable Snowflake Data</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Disable Auto Convert</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### File Format Definition By Name

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>File Format Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### File Format Definition By Type Options

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Format Type Options</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#Avro">Avro</a></p></li><li><p><a href="#FileFormatOptionsCsv">File Format Options CSV</a></p></li><li><p><a href="#FileFormatOptionsJson">File Format Options JSON</a></p></li><li><p><a href="#ORC">ORC</a></p></li><li><p><a href="#Parquet">Parquet</a></p></li><li><p><a href="#XML">XML</a></p></li></ul></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### True

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Sns Topic</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Integration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Validation Mode Return Errors

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Validation Error Type</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>RETURN_ERRORS</p></li><li><p>RETURN_ALL_ERRORS</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Validation Mode Return Max Rows

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Snowflake Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Stage Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Files are unloaded to the specified Snowflake location (internal/external stage, table, path):</p></div><div><ul><li><p>[namespace.]int_stage_name[/path] = Files are unloaded to the specified named internal stage.</p></li><li><p>[namespace.]ext_stage_name[/path] = Files are unloaded to the specified named external stage.</p></li><li><p>[namespace.]%table_name[/path] = Files are unloaded to the stage for the specified table.</p></li><li><p>~[/path] = Files are unloaded to the stage for the current user.</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### External Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>External Location Provider</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#MicrosoftAzure">Microsoft Azure</a></p></li><li><p><a href="#GoogleCloudStorage">Google Cloud Storage</a></p></li><li><p><a href="#AmazonS3">Amazon S3</a></p></li></ul></div></div></td><td><div><div><p>External system to integrate with Snowflake</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Internal Stage Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Stage Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Internal stage name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### External Stage Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Stage Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>External stage name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>External Location Provider</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#MicrosoftAzure">Microsoft Azure</a></p></li><li><p><a href="#GoogleCloudStorage">Google Cloud Storage</a></p></li><li><p><a href="#AmazonS3">Amazon S3</a></p></li></ul></div></div></td><td><div><div><p>External system to integrate with Snowflake</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Microsoft Azure

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL for the Microsoft Azure.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Microsoft Azure Storage Integration Credentials</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#MicrosoftAzureStorageIntegration">Microsoft Azure Storage Integration</a></p></li><li><p><a href="#MicrosoftAzureKeyCredentials">Microsoft Azure Key Credentials</a></p></li><li><p>MicrosoftAzureNoCredentials</p></li></ul></div></div></td><td><div><div><p>Security credentials for connecting to Microsoft Azure.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Encryption</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#AzureCse">Azure Cse</a></p></li></ul></div></div></td><td><div><div><p>Required only for loading from or unloading into encrypted files; not required if storage location and files are unencrypted.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Google Cloud Storage

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL for the Google Cloud Storage.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Storage Integration Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the storage integration used to delegate authentication responsibility for external cloud storage.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Encryption</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#GcsSseMks">Gcs Sse Mks</a></p></li></ul></div></div></td><td><div><div><p>Required only for loading from/unloading into encrypted files; not required if storage location and files are unencrypted.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Amazon S3

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL for the Amazon S3.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amazon S3 Storage Integration Credentials</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#AmazonS3StorageIntegration">Amazon S3 Storage Integration</a></p></li><li><p><a href="#AmazonS3KeyCredentials">Amazon S3 Key Credentials</a></p></li><li><p><a href="#AmazonS3RoleCredentials">Amazon S3 Role Credentials</a></p></li><li><p>AmazonS3NoCredentials</p></li></ul></div></div></td><td><div><div><p>The security credentials for connecting to AWS and accessing the private/protected S3 bucket where the files to load/unload are staged.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Encryption</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#AwsCse">AWS CSE</a></p></li><li><p>AwsSseS3</p></li><li><p><a href="#AwsSseKms">Aws Sse Kms</a></p></li></ul></div></div></td><td><div><div><p>Required only for loading from/unloading into encrypted files; not required if storage location and files are unencrypted.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### AWS CSE

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Master Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Aws Sse Kms

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Kms Key Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Gcs Sse Mks

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Kms Key Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Key for Gcs Sse Mks encryption algorithm.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Azure Cse

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Master Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Amazon S3 Storage Integration

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Storage Integration Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the storage integration used to delegate authentication responsibility for external cloud storage.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Amazon S3 Key Credentials

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Aws Key Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>AWS Key Id.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Aws Key Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>AWS Key Secret.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Aws Token</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>AWS Token.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Amazon S3 Role Credentials

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Aws Role</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>AWS Role.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Microsoft Azure Storage Integration

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Storage Integration Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the storage integration used to delegate authentication responsibility for external cloud storage.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Microsoft Azure Key Credentials

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Azure Sas Token</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Table Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of the table from which data is unloaded.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Query

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Sql</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Validation Mode</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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';</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

### Definition By Name For Copy Into Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>File Format Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Definition By Type For Copy Into Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>File Format Options For Copy Into Location</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#CsvForCopyIntoLocation">Csv For Copy Into Location</a></p></li><li><p><a href="#JsonForCopyIntoLocation">Json For Copy Into Location</a></p></li><li><p><a href="#ParquetForCopyIntoLocation">Parquet For Copy Into Location</a></p></li></ul></div></div></td><td><div><div><p>Specifies the type of files unloaded from the table. If a format type is specified, additional format-specific options can be specified.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Csv For Copy Into Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Record Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate records in an input file or unloaded file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Field Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate fields in an input file or unloaded file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>File Extension</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Date Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary Format</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HEX</p></li><li><p>BASE64</p></li><li><p>UTF8</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>HEX</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>NONE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Unenclosed Field Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Field Optionally Enclosed By</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>NONE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Empty Field As Null</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Used in combination with emptyFieldAsNull when set as false allows empty strings to be loaded in tables without enclosing the field values in quotes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Json For Copy Into Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>File Extension</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Parquet For Copy Into Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>LZO</p></li><li><p>SNAPPY</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr></tbody></table>

### Definition By Name For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>File Format Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Definition By Type For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>File Format Options For Copy Into Table</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#AvroForCopyIntoTable">Avro For Copy Into Table</a></p></li><li><p><a href="#CsvForCopyIntoTable">Csv For Copy Into Table</a></p></li><li><p><a href="#JsonForCopyIntoTable">Json For Copy Into Table</a></p></li><li><p><a href="#OrcForCopyIntoTable">Orc For Copy Into Table</a></p></li><li><p><a href="#ParquetForCopyIntoTable">Parquet For Copy Into Table</a></p></li><li><p><a href="#XmlForCopyIntoTable">Xml For Copy Into Table</a></p></li></ul></div></div></td><td><div><div><p>Specifies the type of files loaded into the table. If a format type is specified, additional format-specific options can be specified.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Avro For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Csv For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Record Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate records in an input file or unloaded file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Field Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate records in an input file or unloaded file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Header Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Blank Lines</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to skip any blank lines encountered in data, instead of resulting in an end-of-record error.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Date Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary Format</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HEX</p></li><li><p>BASE64</p></li><li><p>UTF8</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>HEX</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Unenclosed Field Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a single character used as the escape character for unenclosed field values only.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Field Optionally Enclosed By</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Error On Column Count Mismatch</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Replace Invalid Characters</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to replace invalid UTF-8 characters with a default Unicode character instead of resulting in an error.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Validate UTF8</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Empty Field As Null</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Used in combination with emptyFieldAsNull when set as false allows empty strings to be loaded in tables without enclosing the field values in quotes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BIG5</p></li><li><p>EUCJP</p></li><li><p>EUCKR</p></li><li><p>GB18030</p></li><li><p>IBM420</p></li><li><p>IBM424</p></li><li><p>ISO2022CN</p></li><li><p>ISO2022JP</p></li><li><p>ISO2022KR</p></li><li><p>ISO88591</p></li><li><p>ISO88592</p></li><li><p>ISO88595</p></li><li><p>ISO88596</p></li><li><p>ISO88597</p></li><li><p>ISO88598</p></li><li><p>ISO88599</p></li><li><p>KOI8R</p></li><li><p>SHIFTJIS</p></li><li><p>UTF8</p></li><li><p>UTF16</p></li><li><p>UTF16BE</p></li><li><p>UTF16LE</p></li><li><p>UTF32</p></li><li><p>UTF32BE</p></li><li><p>UTF32LE</p></li><li><p>WINDOWS1250</p></li><li><p>WINDOWS1251</p></li><li><p>WINDOWS1252</p></li><li><p>WINDOWS1253</p></li><li><p>WINDOWS1254</p></li><li><p>WINDOWS1255</p></li><li><p>WINDOWS1256</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>UTF8</p></div></div></td><td><div></div></td></tr></tbody></table>

### Json For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Date Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary Format</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HEX</p></li><li><p>BASE64</p></li><li><p>UTF8</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>HEX</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable Octal</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Allow Duplicate</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Outer Array</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Null Values</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies that the JSON parser should remove object fields or array elements containing null values.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Ignore UTF8 Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Orc For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Parquet For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>SNAPPY</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary As Text</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Xml For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Ignore UTF8 Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Preserve Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser preserves leading and trailing spaces in element content.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Outer Element</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Disable Snowflake Data</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Disable Auto Convert</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Conditional

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Execution Mode</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALL</p></li><li><p>FIRST</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Conditions</strong></p></td><td><div><div><p>Array of <a href="#ConditionStatement">Condition Statement</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Else Into Clause</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Overwrite</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Subquery</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Condition Statement

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>When Condition</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Into Clauses</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Unconditional

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Into Clauses</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Overwrite</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Subquery</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Not Matched Insert Clause

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Column Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Column Values</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Case Predicate</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Matched Update Clause

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Update Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Case Predicate</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Matched Delete Clause

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Case Predicate</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

<!-- document id=6a5f89d31a67b9320139b0a57c8b011b5734d1bef0df01601af0018f094430a1 url=/mulesoft/current/en-us/snowflake-connector/latest/index.md -->

---
product: Snowflake Connector
version: 1.4
is-latest-version: true
---

# Snowflake Connector 1.4

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Snowflake (Snowflake Connector) enables you to connect with your Snowflake
instance to load data, run queries in Snowflake tables, and sync data with external business
applications.

For information about compatibility and fixed issues, see the Snowflake Connector Release Notes.

## Before You Begin

To use this connector, you must be familiar with:

- The Snowflake API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have:

- Credentials to access the Snowflake target resource

- Anypoint Platform

- Anypoint Studio version 7.5 or later

## Common Use Cases for the Connector

These are some common use cases for Snowflake Connector:

- Load bulk or continuous data into your Snowflake instance.

- Run queries to insert, delete, update, and merge data in Snowflake tables.

- Sync data:

  - Keep unstructured data (files) in an external data location in sync with unstructured data in
    Snowflake, when the external data location is the source of truth.

  - Keep unstructured data (files) in an external data location in sync with unstructured data in
    Snowflake, when Snowflake is the source of truth.

  - Keep structured data (tables) in an external data location in sync with Snowflake (in tables),
    when the external data location is the source of truth.

  - Keep structured data (tables) in an external data location in sync with Snowflake (in tables),
    when Snowflake is the source of truth.

## Connection Types

Use one of the following Snowflake connection types:

- Key-pair Snowflake Connection  
  Enables you to connect to Snowflake using encrypted or unencrypted private keys.

- Basic Snowflake Connection (To be deprecated)  
  Enables you to connect to Snowflake via user and password.

For information about configuring authentication types, see
[Using Anypoint Studio to Configure Snowflake Connector](https://docs.mulesoft.com/snowflake-connector/latest/snowflake-connector-studio).

## Next Step

After you complete the prerequisites, you are ready to create an app and configure the connector
using [Anypoint Studio](https://docs.mulesoft.com/snowflake-connector/latest/snowflake-connector-studio).

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Snowflake Connector Reference](https://docs.mulesoft.com/snowflake-connector/latest/snowflake-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=add91263644ba7e42e9a2a8d52fca4d3c082496a7a9790eda419a2066bf0bc19 url=/mulesoft/current/en-us/snowflake-connector/latest/snowflake-connector-xml-maven.md -->

---
product: Snowflake Connector
version: 1.4
is-latest-version: true
---

# Snowflake Connector 1.4 - XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:

- If you manually code a Mule runtime engine (Mule) app in XML either from the Anypoint Studio XML
  editor or from a text editor, you can access the connector from your app by adding reference
  statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

- If you add the connector in Studio, Studio automatically populates the XML code with the
  connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `mule` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/snowflake
http://www.mulesoft.org/schema/mule/snowflake/current/mule-snowflake.xsd
```

This example shows how the namespace statements are placed in the XML:

```xml
<mule xmlns:snowflake="http://www.mulesoft.org/schema/mule/snowflake"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/snowflake
	http://www.mulesoft.org/schema/mule/snowflake/current/mule-snowflake.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access
to this connector:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule4-snowflake-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `<version>` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `snowflake`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=a9d227d3e79dcc888ec2805a3645232409acca688ab416990740fc62366c766b url=/mulesoft/current/en-us/snowflake-connector/latest/snowflake-connector-examples.md -->

---
product: Snowflake Connector
version: 1.4
is-latest-version: true
---

# Snowflake Connector 1.4 Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following example returns all rows of a table based on a watermark.

This example uses variables for some field values. You can either:

- Replace the variables with their values in the code.

- Provide the values for each variable in a properties file and then refer to that file from the
  connector configuration.

If you don’t know how to use a properties file, refer to
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

Before you try the examples, access Anypoint Studio (Studio) and verify that the **Mule Palette**
view displays entries for Snowflake Connector. If not, follow the instructions in
[Add the Connector to Your Mule Project](https://docs.mulesoft.com/snowflake-connector/latest/snowflake-connector-studio#add-connector-to-project).

## Return All Rows of a Table

This example shows how to use the **On Table Row** source to return rows that contain columns with a
greater watermark value than that of the last watermark processed.

The following screenshot shows the app flow for this example:

![Studio Flow for the On Table Row source](/mulesoft/current/en-us/snowflake-connector/latest/_images/listener-flow.png)

### Add the On Table Row Source

The **On Table Row** source selects from a table at a regular interval and generates one message per
obtained row.

1.  In the **Mule Palette** view, select **Snowflake** and drag the **On Table Row** source to the
    canvas.

2.  In the Search properties window, click **+** next to the **Connector configuration** field to
    add a global element.

3.  Enter the following values:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>Name of the configuration.</p></td></tr><tr><td><p>Config Ref</p></td><td><p><code>Snowflake_Config</code></p></td></tr><tr><td><p>Table</p></td><td><p><code>USERS</code></p></td></tr><tr><td><p>Watermark Column</p></td><td><p><code>CREATION_DATE</code></p></td></tr><tr><td><p>Id Column</p></td><td><p><code>ID</code></p></td></tr><tr><td><p>Since</p></td><td><p><code>2021-12-14 11:00:00.000</code></p></td></tr></tbody></table>

### Add the Transform Message Component

The **Transform Message** component outputs the rows of the table in JSON format.

1.  In the **Mule Palette** view, select **Core** and drag the **Transform Message** component to
    the right of **On Table Row**.

2.  Click the **Transform Message** component and set the output format to `application/json`.

### Add the Logger Component

The **Logger** component logs the query result to the console.

1.  In the **Mule Palette** view, select **Core** and drag the **Logger** component to the right of
    **Transform Message**.

2.  Enter the following values:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p>Display Name</p></td><td><p><code>Logger</code></p></td></tr><tr><td><p>Message</p></td><td><p><code>payload</code></p></td></tr><tr><td><p>Level</p></td><td><p><code>INFO (Default)</code></p></td></tr></tbody></table>

### XML for This Example

Paste this code into the Studio XML editor to quickly load the flow for this example into your Mule
app:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:db="http://www.mulesoft.org/schema/mule/db" xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:snowflake="http://www.mulesoft.org/schema/mule/snowflake"
	xmlns:salesforce="http://www.mulesoft.org/schema/mule/salesforce" xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/snowflake http://www.mulesoft.org/schema/mule/snowflake/current/mule-snowflake.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
http://www.mulesoft.org/schema/mule/db http://www.mulesoft.org/schema/mule/db/current/mule-db.xsd">

	<configuration-properties file="mule-app.properties"/>

	<snowflake:snowflake-config name="Snowflake_Config" >
		<snowflake:snowflake-connection accountName="${config.accountName}" warehouse="${config.warehouse}" database="${config.database}" schema="${config.schema}" user="${config.user}" password="${config.password}" role="${config.role}"/>
	</snowflake:snowflake-config>
	<snowflake:snowflake-config name="keyPairWithPasswordConfig" >
        	<snowflake:keypair-connection user="${config.user}"  accountName="${config.accountName}" warehouse="${config.warehouse}" database="${config.database}" schema="${config.schema}" privateKeyFile="${app.home}/rsa_key_encrypted.p8" privateKeyPassword="${config.user.keypair.password}" role="${config.role}"/>
    </snowflake:snowflake-config>
	<flow name="listener-flow" >
		<snowflake:row-listener doc:name="Row Listener" config-ref="Snowflake_Config" table="USERS" watermarkColumn="CREATION_DATE" idColumn="ID" since="2021-12-14 11:00:00.000">
			<scheduling-strategy >
				<fixed-frequency />
			</scheduling-strategy>
		</snowflake:row-listener>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<logger level="INFO" doc:name="Logger" message="#[payload]"/>
	</flow>
</mule>
```

### Steps for Running This Example

1.  Verify that your connector is configured.

2.  Save the project.

3.  The terminal will display the new messages for this source.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=8354007abad872eeee112fc959ef6088cd7fe61ff77281601a586fc19ca863f6 url=/mulesoft/current/en-us/snowflake-connector/latest/snowflake-connector-reference.md -->

---
product: Snowflake Connector
version: 1.4
is-latest-version: true
---

# Snowflake Connector 1.4 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

## Snowflake Configuration

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><ul><li><p><a href="#key-pair-connection">Key-pair Connection</a></p></li><li><p><a href="#snowflake-config_snowflake-connection">Basic Snowflake Connection (To be deprecated)</a></p></li></ul></div></div></td><td><div><div><p>The connection types to provide to this configuration.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Expiration Policy</strong></p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><div><div><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Key-pair Connection

For further details on how to configure key-pair authentication, refer to
[configure key-pair authentication](https://docs.snowflake.com/en/user-guide/key-pair-auth#configuring-key-pair-authentication)
Snowflake documentation.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Pooling Profile</strong></p></td><td><div><div><p><a href="#SnowflakeDbPoolingProfile">Snowflake Db Pooling Profile</a></p></div></div></td><td><div><div><p>Configures database connection pooling.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Account Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Account name provided when registering for the Snowflake account. The account name is in the <code>&lt;OrgId&gt;.&lt;AccountId&gt;</code> format. Specify the account name with a cloud region or cloud name, for example, <code>&lt;OrgId&gt;.&lt;AccountId&gt;.&lt;CloudRegion&gt;</code> or <code>&lt;OrgId&gt;.&lt;AccountId&gt;.&lt;CloudRegion&gt;.&lt;CloudName&gt;</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Warehouse</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the Snowflake warehouse to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Database</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database to connect to.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Schema</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database schema to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>User</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database username used to initialize the session.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Private Key File Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Private key path used to authenticate the user.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Private Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password to decrypt an encrypted private key. Only for encrypted private keys.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Role</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Role assigned to the user.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Basic Snowflake Connection (To be deprecated)

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Pooling Profile</strong></p></td><td><div><div><p><a href="#SnowflakeDbPoolingProfile">Snowflake Db Pooling Profile</a></p></div></div></td><td><div><div><p>Provides a way to configure database connection pooling.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Account Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Account name that was provided when registering for the Snowflake account. The account name is in the <code>&lt;OrgId&gt;.&lt;AccountId&gt;</code> format. You can also specify the account name with a cloud region or cloud name, for example, <code>&lt;OrgId&gt;.&lt;AccountId&gt;.&lt;CloudRegion&gt;</code> or <code>&lt;OrgId&gt;.&lt;AccountId&gt;.&lt;CloudRegion&gt;.&lt;CloudName&gt;</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Warehouse</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the Snowflake warehouse to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Database</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database to connect to.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Schema</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database schema to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>User</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database username used to initialize the session.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Snowflake database password used to authenticate the user.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Role</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Role assigned to the user.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection</strong></p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## Supported Operations

- [Bulk Delete](#bulkDelete)

- [Bulk Insert](#bulkInsert)

- [Bulk Update](#bulkUpdate)

- [Copy Into Location](#copyIntoLocation)

- [Copy Into Table](#copyIntoTable)

- [Copy Into Table With Transformation](#copyIntoTableWithTransformation)

- [Create Pipe](#createPipe)

- [Create Stage](#createStage)

- [Create Task](#createTask)

- [Delete](#delete)

- [Execute Ddl](#executeDdl)

- [Execute Script](#executeScript)

- [Insert](#insert)

- [Insert Multi Table](#insertMultiTable)

- [Merge](#merge)

- [Select](#select)

- [Stored Procedure](#storedProcedure)

- [Update](#update)

## Associated Sources

- [On Table Row](#Listener)

## 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Array of Object</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can take regarding transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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 (<code>10</code>) is used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Location</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#SnowflakeLocation">Snowflake Location</a></p></li><li><p><a href="#ExternalLocation">External Location</a></p></li></ul></div></div></td><td><div><div><p>Specifies the internal or external location where the files containing the data to load are staged.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Table Query Source</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#table">Table</a></p></li><li><p><a href="#query">Query</a></p></li></ul></div></div></td><td><div><div><p>Specifies the table or query used as the source of the data to unload.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>File Format</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#DefinitionByNameForCopyIntoLocation">Definition By Name For Copy Into Location</a></p></li><li><p><a href="#DefinitionByTypeForCopyIntoLocation">Definition By Type For Copy Into Location</a></p></li></ul></div></div></td><td><div><div><p>Specifies the format of the data files to load.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Include Header</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to include the table column headings in the output files.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Overwrite</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Boolean that specifies whether the COPY command overwrites existing files with matching names in the location where the files are stored.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Single</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Boolean that specifies whether to generate a single file or multiple files. If <code>false</code>, a filename prefix must be included in the path.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max File Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number (&gt; 0) that specifies the upper size limit (in bytes) of each file to generate in parallel per thread.</p></div></div></td><td><div><div><p>16000000</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Include Query Id</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Boolean that specifies whether to uniquely identify unloaded files by including a universally unique identifier (UUID) in the filenames of unloaded data files.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Detailed Output</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Destination Table Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of the table into which data is loaded.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Location</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#SnowflakeLocation">Snowflake Location</a></p></li><li><p><a href="#ExternalLocation">External Location</a></p></li></ul></div></div></td><td><div><div><p>Specifies the internal or external location where the files containing the data to be loaded are staged.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Files</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of one or more files to load from a staged internal or external location.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pattern</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the file names or paths to match based on a regex pattern.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>File Format</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#DefinitionByNameForCopyIntoTable">Definition By Name For Copy Into Table</a></p></li><li><p><a href="#DefinitionByTypeForCopyIntoTable">Definition By Type For Copy Into Table</a></p></li></ul></div></div></td><td><div><div><p>Specifies the format of the data files to load.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Validation Mode</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#ValidationModeReturnErrors">Validation Mode Return Errors</a></p></li><li><p><a href="#ValidationModeReturnMaxRows">Validation Mode Return Max Rows</a></p></li></ul></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>On Error</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Action to perform when an error is seen while loading data from a file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Size Limit</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size in bytes of data to load with a given copy statement.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Purge</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to remove the data files from the stage automatically after the data is loaded successfully.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Return Failed Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to return only files that have failed to load in the statement result.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Match By Column Name</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>CASE_SENSITIVE</p></li><li><p>CASE_INSENSITIVE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.</p></div></div></td><td><div><div><p>NONE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enforce Length</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Truncate Columns</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Force</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, loads all files, regardless of whether they’ve been loaded previously and have not changed since they were loaded.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Load Uncertain Files</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies to load files for which the load status is unknown.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Destination Table Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of the table into which data is loaded.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Column Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies an explicit list of table columns (separated by commas) into which you want to insert data.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transformation Select SQL</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies an explicit set of fields or columns (separated by commas) to load from the staged data files.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Stage Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the internal or external location where the files containing the data to be loaded are staged.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Stage Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies an optional alias for the FROM value (for example <code>d</code> in <code>COPY INTO t1 (c1) FROM (SELECT d.$1 FROM @mystage/file1.csv.gz d));</code>).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Files</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of one or more files to load from a staged internal or external location.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Pattern</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the file names or paths to match based on a regular expression pattern.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>File Format</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#DefinitionByNameForCopyIntoTable">Definition By Name For Copy Into Table</a></p></li><li><p><a href="#DefinitionByTypeForCopyIntoTable">Definition By Type For Copy Into Table</a></p></li></ul></div></div></td><td><div><div><p>Specifies the format of the data files to load.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>On Error</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Action to perform when an error is seen while loading data from a file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Size Limit</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size in bytes of data to be loaded with a given copy statement.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Purge</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to remove the data files from the stage automatically after the data is loaded successfully.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Return Failed Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to return only files that have failed to load in the statement result.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Match By Column Name</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>CASE_SENSITIVE</p></li><li><p>CASE_INSENSITIVE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.</p></div></div></td><td><div><div><p>NONE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enforce Length</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Truncate Columns</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Force</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If true, loads all files, regardless of whether they’ve been loaded previously and have not changed since they were loaded.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Load Uncertain Files</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies to load files for which the load status is unknown.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Pipe Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the identifier for the pipe; must be unique for the schema in which the pipe is created.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Copy Statement</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Replace Existing Pipe</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if an already existing pipe should be overwritten by the one being created.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>If Not Exists</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if the pipe should be created if there isn’t already an existing pipe with the same name.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Ingest</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#true">True</a></p></li><li><p>false</p></li></ul></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Comment</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a comment for the pipe.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Stage Location</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#InternalStageLocation">Internal Stage Location</a></p></li><li><p><a href="#ExternalStageLocation">External Stage Location</a></p></li></ul></div></div></td><td><div><div><p>Snowflake internal or external location to create the stage.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>If Not Exists</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if the stage should not be created if there is already an existing stage with the same name.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Replace Already Existing Stage</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if an already existing stage should be overwritten by the one being created.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Is Temporary</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether or not the stage being created is temporary.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>File Format</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#FileFormatDefinitionByName">File Format Definition By Name</a></p></li><li><p><a href="#FileFormatDefinitionByTypeOptions">File Format Definition By Type Options</a></p></li></ul></div></div></td><td><div><div><p>Specifies the type of files for the stage.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Comment</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a comment for the stage.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>On Error</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Action to perform when an error is seen while loading data from a file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Size Limit</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size in bytes of data to load with a given copy statement.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Purge</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to remove the data files from the stage automatically after the data is loaded successfully.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Return Failed Only</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to return only files that have failed to load in the statement result.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Match By Column Name</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>CASE_SENSITIVE</p></li><li><p>CASE_INSENSITIVE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies whether to load data into columns in the target table that match corresponding columns represented in the data.</p></div></div></td><td><div><div><p>NONE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Enforce Length</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Truncate Columns</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to truncate text strings that exceed the target column length.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Force Load</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, loads all files, regardless of whether they’ve been loaded previously and have not changed since they were loaded.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Task Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of the task; must be unique for the schema in which the task is created.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Warehouse Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of the warehouse.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Sql</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the query to run.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Replace Existing Task</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if an existing task should be overwritten by the one being created.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>If Not Exists</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies if the task should be created if there isn’t already an existing task with the same name.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Session Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Specifies the session parameters to set for the session when the task runs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Run Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Specifies a time limit in milliseconds on a single task run before it times out.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Copy Grants</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether access permissions from the original task should be retained when cloning or replacing an existing task.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Comment</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a comment for the task.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>After Task</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of a predecessor task which would trigger the created task whenever the predecessor task is run.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>When</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>SQL expression to determine whether a task should run.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Schedule Option Cron Expression</strong></p></td><td><div><div><p><a href="#ScheduleOptionCronExpression">Schedule Option Cron Expression</a></p></div></div></td><td><div><div><p>Specifies a cron expression and time zone for periodically running the task. Supports a subset of standard cron utility syntax.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Schedule Option Time Interval</strong></p></td><td><div><div><p><a href="#ScheduleOptionTimeInterval">Schedule Option Time Interval</a></p></div></div></td><td><div><div><p>Specifies an interval (in minutes) of wait time inserted between runs of the task. Accepts positive integers only.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>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 <code>ID = :myParamName</code>. The map’s values will contain the actual assignation for each parameter.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>SQL DDL statement to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL Query Text</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Script Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Number</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>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 <code>ID = :myParamName</code>. The map’s values will contain the actual assignation for each parameter.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generate Keys</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates when to make auto-generated keys available for retrieval.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Indexes</strong></p></td><td><div><div><p>Array of Number</p></div></div></td><td><div><div><p>List of column indexes that indicates which auto-generated keys to make available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List of column names that indicates which auto-generated keys to make available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#StatementResult">Statement Result</a></p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Insert Into Multi Table Parameters</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#Conditional">Conditional</a></p></li><li><p><a href="#Unconditional">Unconditional</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Target Table</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the table to merge.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Source</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the table or subquery to join with the target table.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Join Expr</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the expression on which to join the target table and source.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Match Clauses</strong></p></td><td><div><div><p>Array of One of:</p></div><div><ul><li><p><a href="#NotMatchedInsertClause">Not Matched Insert Clause</a></p></li><li><p><a href="#MatchedUpdateClause">Matched Update Clause</a></p></li><li><p><a href="#MatchedDeleteClause">Matched Delete Clause</a></p></li></ul></div></div></td><td><div><div><p>Specifies a list of clauses and actions to perform when a match occurs or does not occur.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Boolean</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>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 <code>ID = :myParamName</code>. The map’s values will contain the actual assignation for each parameter.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Object</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>The type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Streaming Strategy</strong></p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><div><div><p>Configures how Mule processes streams. The default is to use repeatable streams.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>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 <code>ID = :myParamName</code>. The map’s values will contain the actual assignation for each parameter.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generate Keys</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates when to make auto-generated keys available for retrieval.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Indexes</strong></p></td><td><div><div><p>Array of Number</p></div></div></td><td><div><div><p>List of column indexes that indicates which auto-generated keys to make available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List of column names that indicates which auto-generated keys should be made available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Object</p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Configuration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the configuration to use.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Transactional Action</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_JOIN</p></li><li><p>JOIN_IF_POSSIBLE</p></li><li><p>NOT_SUPPORTED</p></li></ul></div></div></td><td><div><div><p>Type of joining action that operations can perform for transactions.</p></div></div></td><td><div><div><p>JOIN_IF_POSSIBLE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Query Timeout Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Query Timeout</strong> field.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Fetch Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>SQL String</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Text of the SQL query to execute.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Parameter Types</strong></p></td><td><div><div><p>Array of <a href="#ParameterType">Parameter Type</a></p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Input Parameters</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>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 <code>ID = :myParamName</code>. The map’s values will contain the actual assignation for each parameter.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generate Keys</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Indicates when to make auto-generated keys available for retrieval.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Indexes</strong></p></td><td><div><div><p>Array of Number</p></div></div></td><td><div><div><p>List of column indexes that indicates which auto-generated keys to make available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Auto Generated Keys Column Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>List of column names that indicates which auto-generated keys to make available for retrieval.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Variable</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the variable that stores the operation’s output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></div></div></td><td><div><div><p>#[payload]</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>A retry strategy in case of connectivity errors.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p><a href="#StatementResult">Statement Result</a></p></td></tr></tbody></table>

### For Configurations

- [Snowflake Configuration](#snowflake-config)

#### 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

## Sources

### On Table Row

`<snowflake:listener>`

Returns all rows of a table based on a watermark.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration used to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Transactional Action</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALWAYS_BEGIN</p></li><li><p>NONE</p></li></ul></div></div></td><td><p>Type of joining action that sources can perform for transactions.</p></td><td><p>NONE</p></td><td></td></tr><tr><td><p>Transaction Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>LOCAL</p></li><li><p>XA</p></li></ul></div></div></td><td><p>Type of transaction to create. Availability depends on the Mule runtime version.</p></td><td><p>LOCAL</p></td><td></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines whether to execute this source on only the primary node when running Mule instances in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p>RedeliveryPolicy</p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Table</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the table to select rows from.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Watermark Column</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the column to use for the watermark. Values taken from this column are used to filter the contents of the next poll, so that rows only with a greater watermark value are processed.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Id Column</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the column to consider as the row ID. If provided, this parameter ensures the same row is not processed twice by concurrent polls.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Since</p></td><td><div><div><p>String</p></div></div></td><td><p>Limits the initial amount of registers returned in the results.</p></td><td></td><td></td></tr><tr><td><p>Query Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Query Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit for the <strong>Query Timeout</strong> field.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Fetch Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Indicates how many rows to fetch from the database when rows are read from a result set. This parameter is required when streaming is true, in which case a default value (<code>10</code>) is used.</p></td><td></td><td></td></tr><tr><td><p>Max Rows</p></td><td><div><div><p>Number</p></div></div></td><td><p>Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>Object</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Snowflake Configuration](#snowflake-config)

## Types

### Snowflake Db Pooling Profile

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Pool Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum number of connections a pool maintains at any given time</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Min Pool Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Minimum number of connections a pool maintains at any given time</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Acquire Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Determines how many connections at a time to try to acquire when the pool is exhausted</p></div></div></td><td><div><div><p>1</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Prepared Statement Cache Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Determines how many statements are cached per pooled connection. Setting this to zero will disable statement caching</p></div></div></td><td><div><div><p>5</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Wait</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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</p></div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Wait Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A #maxWait.</p></div></div></td><td><div><div><p>SECONDS</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Determines how many seconds a Connection can remain pooled but unused before being discarded. Zero means idle connections never expire.</p></div></div></td><td><div><div><p>10800</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Additional Properties</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Reconnection strategy to use.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>A time unit that qualifies the maxIdleTime attribute</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Parameter Type

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The name of the input parameter.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Type Classifier</strong></p></td><td><div><div><p><a href="#TypeClassifier">Type Classifier</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Type Classifier

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BIT</p></li><li><p>TINYINT</p></li><li><p>SMALLINT</p></li><li><p>INTEGER</p></li><li><p>BIGINT</p></li><li><p>FLOAT</p></li><li><p>REAL</p></li><li><p>DOUBLE</p></li><li><p>NUMERIC</p></li><li><p>DECIMAL</p></li><li><p>CHAR</p></li><li><p>VARCHAR</p></li><li><p>LONGVARCHAR</p></li><li><p>DATE</p></li><li><p>TIME</p></li><li><p>TIMESTAMP</p></li><li><p>BINARY</p></li><li><p>VARBINARY</p></li><li><p>LONGVARBINARY</p></li><li><p>NULL</p></li><li><p>OTHER</p></li><li><p>JAVA_OBJECT</p></li><li><p>DISTINCT</p></li><li><p>STRUCT</p></li><li><p>ARRAY</p></li><li><p>BLOB</p></li><li><p>CLOB</p></li><li><p>REF</p></li><li><p>DATALINK</p></li><li><p>BOOLEAN</p></li><li><p>ROWID</p></li><li><p>NCHAR</p></li><li><p>NVARCHAR</p></li><li><p>LONGNVARCHAR</p></li><li><p>NCLOB</p></li><li><p>SQLXML</p></li><li><p>UNKNOWN</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Custom Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Schedule Option Cron Expression

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Cron Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a cron expression that identifies when to repeat runs of the task.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Time Zone</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the time zone to use for the cron expression.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Schedule Option Time Interval

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Time Interval In Minutes</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Specifies a time interval in minutes to wait between periodic runs of the task. Also supports num M syntax.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Statement Result

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Affected Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Generated Keys</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which all these attributes are expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Avro

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### File Format Options CSV

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Record Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate records in an input file or unloaded file.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Field Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate records in an input file or unloaded file.</p></div></div></td><td><div><div><p>,</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>File Extension</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Header Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Blank Lines</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to skip any blank lines encountered in data, instead of resulting in an end-of-record error.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Date Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary Format</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HEX</p></li><li><p>BASE64</p></li><li><p>UTF8</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>HEX</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Unenclosed Field Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a single character used as the escape character for unenclosed field values only.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Field Optionally Enclosed By</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Error On Column Count Mismatch</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Replace Invalid Characters</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to replace invalid UTF-8 characters with a default Unicode character instead of resulting in an error.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Validate UTF8</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Empty Field As Null</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When set to <code>false</code>, allows empty strings to be loaded in tables without enclosing the field values in quotes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BIG5</p></li><li><p>EUCJP</p></li><li><p>EUCKR</p></li><li><p>GB18030</p></li><li><p>IBM420</p></li><li><p>IBM424</p></li><li><p>ISO2022CN</p></li><li><p>ISO2022JP</p></li><li><p>ISO2022KR</p></li><li><p>ISO88591</p></li><li><p>ISO88592</p></li><li><p>ISO88595</p></li><li><p>ISO88596</p></li><li><p>ISO88597</p></li><li><p>ISO88598</p></li><li><p>ISO88599</p></li><li><p>KOI8R</p></li><li><p>SHIFTJIS</p></li><li><p>UTF8</p></li><li><p>UTF16</p></li><li><p>UTF16BE</p></li><li><p>UTF16LE</p></li><li><p>UTF32</p></li><li><p>UTF32BE</p></li><li><p>UTF32LE</p></li><li><p>WINDOWS1250</p></li><li><p>WINDOWS1251</p></li><li><p>WINDOWS1252</p></li><li><p>WINDOWS1253</p></li><li><p>WINDOWS1254</p></li><li><p>WINDOWS1255</p></li><li><p>WINDOWS1256</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>UTF8</p></div></div></td><td><div></div></td></tr></tbody></table>

### File Format Options JSON

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Date Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary Format</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HEX</p></li><li><p>BASE64</p></li><li><p>UTF8</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>HEX</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>File Extension</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable Octal</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Allow Duplicate</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Outer Array</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Null Values</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies that the JSON parser should remove object fields or array elements containing null values.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Replace Invalid Characters</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to replace invalid UTF-8 characters with a default Unicode character instead of resulting in an error.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Ignore UTF8 Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### ORC

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Parquet

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>LZO</p></li><li><p>SNAPPY</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary As Text</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### XML

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Ignore UTF8 Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Preserve Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser preserves leading and trailing spaces in element content.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Outer Element</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser strips out the outer XML element, exposing second-level elements as separate documents.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Disable Snowflake Data</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Disable Auto Convert</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first value to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### File Format Definition By Name

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>File Format Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### File Format Definition By Type Options

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Format Type Options</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#Avro">Avro</a></p></li><li><p><a href="#FileFormatOptionsCsv">File Format Options CSV</a></p></li><li><p><a href="#FileFormatOptionsJson">File Format Options JSON</a></p></li><li><p><a href="#ORC">ORC</a></p></li><li><p><a href="#Parquet">Parquet</a></p></li><li><p><a href="#XML">XML</a></p></li></ul></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### True

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Sns Topic</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Integration</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Validation Mode Return Errors

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Validation Error Type</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>RETURN_ERRORS</p></li><li><p>RETURN_ALL_ERRORS</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Validation Mode Return Max Rows

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Rows</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Snowflake Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Stage Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Files are unloaded to the specified Snowflake location (internal/external stage, table, path):</p></div><div><ul><li><p>[namespace.]int_stage_name[/path] = Files are unloaded to the specified named internal stage.</p></li><li><p>[namespace.]ext_stage_name[/path] = Files are unloaded to the specified named external stage.</p></li><li><p>[namespace.]%table_name[/path] = Files are unloaded to the stage for the specified table.</p></li><li><p>~[/path] = Files are unloaded to the stage for the current user.</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### External Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>External Location Provider</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#MicrosoftAzure">Microsoft Azure</a></p></li><li><p><a href="#GoogleCloudStorage">Google Cloud Storage</a></p></li><li><p><a href="#AmazonS3">Amazon S3</a></p></li></ul></div></div></td><td><div><div><p>External system to integrate with Snowflake</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Internal Stage Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Stage Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Internal stage name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### External Stage Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Stage Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>External stage name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>External Location Provider</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#MicrosoftAzure">Microsoft Azure</a></p></li><li><p><a href="#GoogleCloudStorage">Google Cloud Storage</a></p></li><li><p><a href="#AmazonS3">Amazon S3</a></p></li></ul></div></div></td><td><div><div><p>External system to integrate with Snowflake</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Microsoft Azure

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL for the Microsoft Azure.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Microsoft Azure Storage Integration Credentials</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#MicrosoftAzureStorageIntegration">Microsoft Azure Storage Integration</a></p></li><li><p><a href="#MicrosoftAzureKeyCredentials">Microsoft Azure Key Credentials</a></p></li><li><p>MicrosoftAzureNoCredentials</p></li></ul></div></div></td><td><div><div><p>Security credentials for connecting to Microsoft Azure.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Encryption</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#AzureCse">Azure Cse</a></p></li></ul></div></div></td><td><div><div><p>Required only for loading from or unloading into encrypted files; not required if storage location and files are unencrypted.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Google Cloud Storage

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL for the Google Cloud Storage.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Storage Integration Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the storage integration used to delegate authentication responsibility for external cloud storage.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Encryption</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#GcsSseMks">Gcs Sse Mks</a></p></li></ul></div></div></td><td><div><div><p>Required only for loading from/unloading into encrypted files; not required if storage location and files are unencrypted.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Amazon S3

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL for the Amazon S3.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Amazon S3 Storage Integration Credentials</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#AmazonS3StorageIntegration">Amazon S3 Storage Integration</a></p></li><li><p><a href="#AmazonS3KeyCredentials">Amazon S3 Key Credentials</a></p></li><li><p><a href="#AmazonS3RoleCredentials">Amazon S3 Role Credentials</a></p></li><li><p>AmazonS3NoCredentials</p></li></ul></div></div></td><td><div><div><p>The security credentials for connecting to AWS and accessing the private/protected S3 bucket where the files to load/unload are staged.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Encryption</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#AwsCse">AWS CSE</a></p></li><li><p>AwsSseS3</p></li><li><p><a href="#AwsSseKms">Aws Sse Kms</a></p></li></ul></div></div></td><td><div><div><p>Required only for loading from/unloading into encrypted files; not required if storage location and files are unencrypted.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### AWS CSE

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Master Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Aws Sse Kms

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Kms Key Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Gcs Sse Mks

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Kms Key Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Key for Gcs Sse Mks encryption algorithm.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Azure Cse

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Master Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Amazon S3 Storage Integration

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Storage Integration Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the storage integration used to delegate authentication responsibility for external cloud storage.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Amazon S3 Key Credentials

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Aws Key Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>AWS Key Id.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Aws Key Secret</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>AWS Key Secret.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Aws Token</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>AWS Token.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Amazon S3 Role Credentials

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Aws Role</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>AWS Role.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Microsoft Azure Storage Integration

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Storage Integration Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the storage integration used to delegate authentication responsibility for external cloud storage.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Microsoft Azure Key Credentials

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Azure Sas Token</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Table Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies the name of the table from which data is unloaded.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Query

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Sql</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Validation Mode</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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';</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

### Definition By Name For Copy Into Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>File Format Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Definition By Type For Copy Into Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>File Format Options For Copy Into Location</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#CsvForCopyIntoLocation">Csv For Copy Into Location</a></p></li><li><p><a href="#JsonForCopyIntoLocation">Json For Copy Into Location</a></p></li><li><p><a href="#ParquetForCopyIntoLocation">Parquet For Copy Into Location</a></p></li></ul></div></div></td><td><div><div><p>Specifies the type of files unloaded from the table. If a format type is specified, additional format-specific options can be specified.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Csv For Copy Into Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Record Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate records in an input file or unloaded file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Field Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate fields in an input file or unloaded file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>File Extension</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Date Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary Format</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HEX</p></li><li><p>BASE64</p></li><li><p>UTF8</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>HEX</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>NONE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Unenclosed Field Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Field Optionally Enclosed By</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>NONE</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Empty Field As Null</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Used in combination with emptyFieldAsNull when set as false allows empty strings to be loaded in tables without enclosing the field values in quotes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Json For Copy Into Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>File Extension</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Parquet For Copy Into Location

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>LZO</p></li><li><p>SNAPPY</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr></tbody></table>

### Definition By Name For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>File Format Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Definition By Type For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>File Format Options For Copy Into Table</strong></p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#AvroForCopyIntoTable">Avro For Copy Into Table</a></p></li><li><p><a href="#CsvForCopyIntoTable">Csv For Copy Into Table</a></p></li><li><p><a href="#JsonForCopyIntoTable">Json For Copy Into Table</a></p></li><li><p><a href="#OrcForCopyIntoTable">Orc For Copy Into Table</a></p></li><li><p><a href="#ParquetForCopyIntoTable">Parquet For Copy Into Table</a></p></li><li><p><a href="#XmlForCopyIntoTable">Xml For Copy Into Table</a></p></li></ul></div></div></td><td><div><div><p>Specifies the type of files loaded into the table. If a format type is specified, additional format-specific options can be specified.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Avro For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Csv For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Record Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate records in an input file or unloaded file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Field Delimiter</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>One or more single-byte or multibyte characters that separate records in an input file or unloaded file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Header Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div><div><p>0</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Blank Lines</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to skip any blank lines encountered in data, instead of resulting in an end-of-record error.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Date Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary Format</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HEX</p></li><li><p>BASE64</p></li><li><p>UTF8</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>HEX</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Escape Unenclosed Field Character</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Specifies a single character used as the escape character for unenclosed field values only.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Field Optionally Enclosed By</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Error On Column Count Mismatch</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Replace Invalid Characters</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to replace invalid UTF-8 characters with a default Unicode character instead of resulting in an error.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Validate UTF8</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Empty Field As Null</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Used in combination with emptyFieldAsNull when set as false allows empty strings to be loaded in tables without enclosing the field values in quotes.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Encoding</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BIG5</p></li><li><p>EUCJP</p></li><li><p>EUCKR</p></li><li><p>GB18030</p></li><li><p>IBM420</p></li><li><p>IBM424</p></li><li><p>ISO2022CN</p></li><li><p>ISO2022JP</p></li><li><p>ISO2022KR</p></li><li><p>ISO88591</p></li><li><p>ISO88592</p></li><li><p>ISO88595</p></li><li><p>ISO88596</p></li><li><p>ISO88597</p></li><li><p>ISO88598</p></li><li><p>ISO88599</p></li><li><p>KOI8R</p></li><li><p>SHIFTJIS</p></li><li><p>UTF8</p></li><li><p>UTF16</p></li><li><p>UTF16BE</p></li><li><p>UTF16LE</p></li><li><p>UTF32</p></li><li><p>UTF32BE</p></li><li><p>UTF32LE</p></li><li><p>WINDOWS1250</p></li><li><p>WINDOWS1251</p></li><li><p>WINDOWS1252</p></li><li><p>WINDOWS1253</p></li><li><p>WINDOWS1254</p></li><li><p>WINDOWS1255</p></li><li><p>WINDOWS1256</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>UTF8</p></div></div></td><td><div></div></td></tr></tbody></table>

### Json For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Date Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Timestamp Format</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div><div><p>Auto</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary Format</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>HEX</p></li><li><p>BASE64</p></li><li><p>UTF8</p></li></ul></div></div></td><td><div></div></td><td><div><div><p>HEX</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enable Octal</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Allow Duplicate</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Outer Array</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Null Values</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies that the JSON parser should remove object fields or array elements containing null values.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Ignore UTF8 Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Orc For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Parquet For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>SNAPPY</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Binary As Text</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Trim Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Null Ifs</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>Specifies a list of values from which Snowflake selects the first one to convert to from SQL NULL.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Xml For Copy Into Table

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Compression</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>AUTO</p></li><li><p>GZIP</p></li><li><p>BZ2</p></li><li><p>BROTLI</p></li><li><p>ZSTD</p></li><li><p>DEFLATE</p></li><li><p>RAW_DEFLATE</p></li><li><p>NONE</p></li></ul></div></div></td><td><div><div><p>Specifies a compression algorithm to use for compressing the unloaded data files.</p></div></div></td><td><div><div><p>AUTO</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Ignore UTF8 Errors</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether to suppress UTF-8 encoding errors and silently replace with a default Unicode character.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Preserve Space</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser preserves leading and trailing spaces in element content.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Strip Outer Element</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Disable Snowflake Data</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Disable Auto Convert</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Skip Byte Order Mark</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div><div><p>true</p></div></div></td><td><div></div></td></tr></tbody></table>

### Conditional

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Execution Mode</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALL</p></li><li><p>FIRST</p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Conditions</strong></p></td><td><div><div><p>Array of <a href="#ConditionStatement">Condition Statement</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Else Into Clause</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Overwrite</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Subquery</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Condition Statement

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>When Condition</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Into Clauses</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Unconditional

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Into Clauses</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Overwrite</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr><tr><td><p><strong>Subquery</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Not Matched Insert Clause

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Column Names</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Column Values</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Case Predicate</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Matched Update Clause

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Update Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Case Predicate</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Matched Delete Clause

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Case Predicate</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

<!-- document id=f888ce4c4ea607f53395d31833108e18c6949062a566e62c8b2f5c61d29e7533 url=/mulesoft/current/en-us/snowflake-connector/1.3/snowflake-connector-studio.md -->

---
product: Snowflake Connector
version: 1.3
---

# Using Anypoint Studio to Configure Snowflake Connector 1.3

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

6.  [Configure the other connector fields](#configure-other-fields).

When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[Snowflake Connector Reference](https://docs.mulesoft.com/snowflake-connector/1.3/snowflake-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Snowflake Connector to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and add the required dependencies to the project’s
`pom.xml` file:

1.  In **Mule Palette**, click **(X) Search in Exchange**.

2.  In **Add Dependencies to Project**, type `snowflake` in the search field.

3.  Click **Snowflake Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Snowflake Connector:

- Snowflake > On Table Row  
  Initiates a flow by selecting from a table at a regular interval and generating one message per
  obtained row

- HTTP Listener  
  Initiates a flow each time it receives a request on the configured host and port

- Scheduler  
  Initiates a flow when a time-based condition is met

For example, to configure an **On Table Row** source, follow these steps:

1.  In **Mule Palette**, select **Snowflake > On Table Row**.

2.  Drag **On Table Row** to the Studio canvas.

3.  On the **On Table Row** configuration screen, optionally change the value of **Display Name**.

4.  Click **+** next to **Connector configuration** to configure a global element that can be used
    by all instances of the **On Table Row** source in the app.

5.  On the **Snowflake Config** window, for **Required Libraries**, add the required Snowflake JDBC
    driver by selecting **Configure > Add recommended libraries** or **Configure > Add Maven
    dependency** and adding the artifact ID `snowflake-jdbc`.

6.  On the **Connection** section, specify the database connection information for the connector.

7.  On the **Advanced** tab, optionally specify connection pooling and reconnection information,
    including a reconnection strategy.

8.  Click **Test Connection** to confirm that Mule can connect with the specified Snowflake
    database.

9.  Click **OK** to close the window.

10. On the **On Table Row** configuration screen, in **Table**, select the name of the table to
    select from.

11. On the **On Table Row** configuration screen, in **Watermark Column**, select the name of the
    column to use for the watermark. Values taken from this column are used to filter the contents
    of the next poll, so that only rows with a later date than the watermark value are processed.

12. On the **On Table Row** configuration screen, in **Id Column**, select the name of the column to
    consider as the row ID. This parameter ensures the same row is not processed twice by concurrent
    polls.

For example, to configure an HTTP listener source, follow these steps:

1.  In **Mule Palette**, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of **Display Name**.

4.  Specify a value for the **Path** field.

5.  Click **+** next to **Connector configuration** to configure a global element that can be used
    by all instances of the HTTP Listener source in the app.

6.  On the **General** tab, specify connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for Snowflake Connector, follow these steps:

1.  In **Mule Palette**, select **Snowflake** and then select the desired operation.

2.  Drag the operation onto the Studio canvas to the right of the input source.

## Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in
the app can use. Configuring a global element requires you to provide the authentication credentials
that the connector requires to access the target Snowflake system. Snowflake Connector supports the
Snowflake Connection type to connect to Snowflake.

To configure the global element for Snowflake Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the configuration screen for the operation, click **+** next to the **Connector
    configuration** field to access the global element configuration fields.

3.  In the **General** tab, in **Required Libraries**, click **Configure** and select from the
    following options to install the required JDBC driver:

    - **Add recommended libraries**

    - **Use local file**

    - **Add Maven dependency**

4.  In **Connection**, enter the following required information to configure authentication:

    - **Account name**  
      Account name that was provided when registering for the Snowflake account.

    - **Warehouse**  
      Name of the virtual Snowflake warehouse to use. The specified warehouse must be an existing
      warehouse for which the specified account has privileges.

    - **Database**  
      Snowflake database to connect to. The specified database must be an existing database for
      which the specified account has privileges.

    - **Schema**  
      Snowflake database schema to use. The specified schema must be an existing schema for which
      the specified account has privileges.

      Either reference a configuration file that contains ANT-style property placeholders
      (recommended) or enter your authorization credentials in the global configuration properties.
      For information about the benefits of using property placeholders and how to configure them,
      see
      [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

5.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

6.  Click **Test Connection** to confirm that Mule can connect with the specified server.

7.  Click **OK**.

## Configure Additional Connector Fields

After you configure a global element for Snowflake Connector, configure the other required fields
for the connector. The required fields vary depending on which connector operation you use.

## View the App Log

To check for problems, view the app log:

- If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint
  Studio console window.

- If you’re running the app using Mule from the command line, the app log output is visible in your
  OS console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`. You can configure the location of
the log path in the app log file `log4j2.xml`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Snowflake Connector Reference](https://docs.mulesoft.com/snowflake-connector/1.3/snowflake-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=1cb73821ce97e19f6139c03bb8583bcf8ab898c85c662fc8692c083e9102d10f url=/mulesoft/current/en-us/snowflake-connector/latest/snowflake-connector-studio.md -->

---
product: Snowflake Connector
version: 1.4
is-latest-version: true
---

# Using Anypoint Studio to Configure Snowflake Connector 1.4

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

6.  [Configure the other connector fields](#configure-other-fields).

When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[Snowflake Connector Reference](https://docs.mulesoft.com/snowflake-connector/latest/snowflake-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Snowflake Connector to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and add the required dependencies to the project’s
`pom.xml` file:

1.  In **Mule Palette**, click **(X) Search in Exchange**.

2.  In **Add Dependencies to Project**, type `snowflake` in the search field.

3.  Click **Snowflake Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Snowflake Connector:

- Snowflake > On Table Row  
  Initiates a flow by selecting from a table at a regular interval and generating one message per
  obtained row

- HTTP Listener  
  Initiates a flow each time it receives a request on the configured host and port

- Scheduler  
  Initiates a flow when a time-based condition is met

For example, to configure an **On Table Row** source, follow these steps:

1.  In **Mule Palette**, select **Snowflake > On Table Row**.

2.  Drag **On Table Row** to the Studio canvas.

3.  On the **On Table Row** configuration screen, optionally change the value of **Display Name**.

4.  Click **+** next to **Connector configuration** to configure a global element that can be used
    by all instances of the **On Table Row** source in the app.

5.  On the **Snowflake Config** window, for **Required Libraries**, add the required Snowflake JDBC
    driver by selecting **Configure > Add recommended libraries** or **Configure > Add Maven
    dependency** and adding the artifact ID `snowflake-jdbc`.

6.  On the **Connection** section, specify the database connection information for the connector.

7.  On the **Advanced** tab, optionally specify connection pooling and reconnection information,
    including a reconnection strategy.

8.  Click **Test Connection** to confirm that Mule can connect with the specified Snowflake
    database.

9.  Click **OK** to close the window.

10. On the **On Table Row** configuration screen, in **Table**, select the name of the table to
    select from.

11. On the **On Table Row** configuration screen, in **Watermark Column**, select the name of the
    column to use for the watermark. Values taken from this column are used to filter the contents
    of the next poll, so that only rows with a later date than the watermark value are processed.

12. On the **On Table Row** configuration screen, in **Id Column**, select the name of the column to
    consider as the row ID. This parameter ensures the same row is not processed twice by concurrent
    polls.

For example, to configure an HTTP listener source, follow these steps:

1.  In **Mule Palette**, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of **Display Name**.

4.  Specify a value for the **Path** field.

5.  Click **+** next to **Connector configuration** to configure a global element that can be used
    by all instances of the HTTP Listener source in the app.

6.  On the **General** tab, specify connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for Snowflake Connector, follow these steps:

1.  In **Mule Palette**, select **Snowflake** and then select the desired operation.

2.  Drag the operation onto the Studio canvas to the right of the input source.

## Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in
the app can use. Configuring a global element requires you to provide the authentication credentials
that the connector requires to access the target Snowflake system. Snowflake Connector supports the
Snowflake Connection type to connect to Snowflake.

To configure the global element for Snowflake Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the configuration screen for the operation, click **+** next to the **Connector
    configuration** field to access the global element configuration fields.

3.  In the **General** tab, in **Required Libraries**, click **Configure** and select from the
    following options to install the required JDBC driver:

    - **Add recommended libraries**

    - **Use local file**

    - **Add Maven dependency**

4.  In **Connection**, enter the following required information to configure authentication:

    - **Account name**  
      Account name that was provided when registering for the Snowflake account.

    - **Warehouse**  
      Name of the virtual Snowflake warehouse to use. The specified warehouse must be an existing
      warehouse for which the specified account has privileges.

    - **Database**  
      Snowflake database to connect to. The specified database must be an existing database for
      which the specified account has privileges.

    - **Schema**  
      Snowflake database schema to use. The specified schema must be an existing schema for which
      the specified account has privileges.

      Either reference a configuration file that contains ANT-style property placeholders
      (recommended) or enter your authorization credentials in the global configuration properties.
      For information about the benefits of using property placeholders and how to configure them,
      see
      [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

5.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

6.  Click **Test Connection** to confirm that Mule can connect with the specified server.

7.  Click **OK**.

## Configure Additional Connector Fields

After you configure a global element for Snowflake Connector, configure the other required fields
for the connector. The required fields vary depending on which connector operation you use.

## View the App Log

To check for problems, view the app log:

- If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint
  Studio console window.

- If you’re running the app using Mule from the command line, the app log output is visible in your
  OS console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`. You can configure the location of
the log path in the app log file `log4j2.xml`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Snowflake Connector Reference](https://docs.mulesoft.com/snowflake-connector/latest/snowflake-connector-reference)

- [Salesforce Help](https://help.salesforce.com)