Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Overview

...

Snap type:

Write

...

Description:

...

You can use this Snap to execute a Snowflake SQL Insert statement with given values. Document keys will be used as the columns to insert into, and their values will be the values inserted. Missing columns from the document will have null values inserted into them. 

...

Image Removed

...

Snap Type

The Snowflake - Insert Snap is a Write-type Snap that inserts new records into Snowflake database tables

Prerequisites
Insert excerpt
Snowflake - Bulk Load
Snowflake - Bulk Load
nopaneltrue

Security Prerequisites

...

You should have the following permissions in your Snowflake account to execute this Snap: 

  • Usage (DB and Schema): Privilege to use database, role,

...

  •  and schema.

  • Create table: Privilege to create a new table or insert data into an existing table.

The following commands enable minimum privileges in the Snowflake Console:

Code Block
grant usage on database <database_name> to role <role_name>;
grant usage on schema <database_name>.<schema_name>;
 
grant "CREATE TABLE" on database <database_name> to role <role_name>;
grant "CREATE TABLE" on schema <database_name>.<schema_name>;

For more information on Snowflake privileges, refer to Access Control Privileges.

Internal SQL Commands

This Snap uses the INSERT

...

 command internally. It

...

enables updating a table by inserting one or more rows into the table.

Info

Use Snowflake - Bulk Load Snap to do efficient bulk load of records instead of using the Snowflake - Insert Snap. The Snowflake Bulk Snaps use the Snowflake’s Bulk API thus improving the performance.

Support

...

for Ultra Pipelines

Works

...

in Ultra Task

...

Pipelines if Batch size is set to 1 in the Snowflake account. Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline.

Limitations

Snowflake does not support batch insert. As a workaround, use

...

the Snowflake - Bulk

...

Load Snap to insert records in batches.
Though the Snowflake Insert Snap sends requests in batches, Snowflake does not support executing multiple SQL statements in a single API call. So, even if batching is enabled in a Snowflake Insert Snap, Snowflake will execute one SQL statement at a time.

Known Issues

...

Because of performance issues, all Snowflake Snaps now ignore

...

the Cancel queued queries when pipeline is stopped or if it fails

...

 option for Manage Queued Queries, even when selected. Snaps behave as though the

...

default Continue to execute queued queries when the Pipeline is stopped or if it

...

fails option were selected.

Image Modified

...

This Snap uses account references created on the Accounts page of  SnapLogic Manager to handle access to this endpoint. See Configuring Snowflake Accounts for information on setting up this type of account.

...

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

  • Min: 1

  • Max: 2

  • JSON Generator

  • Binary to Document

Incoming documents are first written to a staging file on Snowflake's internal staging area. A temporary table is created on Snowflake with the contents of the staging file. An update operation is then run to update existing records in the target table and/or an insert operation is run to insert new records into the target table.

Output

Document

  • Min: 0

  • Max: 1

  • Mapper

  • Snowflake Execute

If an output view is available, then the output document displays the number of input records and the status of the bulk upload as follows:

 

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Input

This Snap has one document input view by default. 

A second view can be added for table metadata as a document so that the table is created in Snowflake with a similar schema as the source table. This schema is usually from the second output of a database Select Snap. If the schema is from a different database, there is no guarantee that all the data types would be properly handled.

Output

This Snap has at most one output view.

Error

This Snap has at most one error view and produces zero or more documents in the view.


Snap Settings

Info
  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ((blue star)): Indicates that you can add fields in the field set.

  • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

Field Name

Field Type

Description

Label*

Default ValueSnowflake - Insert
Example: Load Employee Tables

String

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Schema name

Default Value: N/A
Example: schema_demo



String/Expression

Specify the database schema name. In case it is not defined, then the suggestion for the Table Name will retrieve all table names of all schemas. The property is suggestible and will retrieve available database schemas during suggest values.

note

The values can be passed using the pipeline parameters but not the upstream parameter.


Table name*

Default

value:  [None]Table name*

Value: N/A
Example: employees_table

Specify the name of the table to execute insert-on.

note

  • The values can be passed using the pipeline parameters but not the upstream parameter.

Note
  • A table name with special characters is not supported.

Default value:  [None]

Create table if not present

Default value: Deselected


Checkbox

Multiexcerpt include macro
nameME_Create_Table_Automatically_2_Inputs
pageRedshift - Bulk Load

Preserve case sensitivity

Default

value:  Not selectedPreserve case sensitivity Insert excerptMySQL - InsertMySQL - InsertnopaneltrueNumber of retries

Value: Deselected

Checkbox

Select this check box to preserve the case sensitivity of the column names.

  • If you do not select Preserve case sensitivity, the input documents are loaded to the target table if the key names in the input documents match the target table column names ignoring the case.

  • If you include a second input view, selecting Preserve case sensitivity has no effect on the column names of the target table, because Snap uses the metadata from the second input view.

Number of retries

Default Value: 0
Example: 3

Integer/Expression

Specify the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response.

Default value: 0
Example: 3

Multiexcerpt include macro
nameretries
pageFile Reader

Retry interval (seconds)

Default Value: 1
Example: 10

Integer/Expression

Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. 

Manage Queued Queries

Default

value: 1
Example:  10
Manage Queued Queries

Value: Continue to execute queued queries when the Pipeline is stopped or if it fails
Example: Cancel queued queries when the Pipeline is stopped or if it fails

Dropdown list

Select this property to decide whether the Snap should continue or cancel the execution of the queued Snowflake Execute SQL queries when you stop the pipeline.

note

If you select Cancel queued queries when the pipeline is stopped or if it fails, then

the read

the read queries under execution are canceled, whereas the write queries under execution are not canceled.

 Snowflake

 Snowflake internally determines which queries are safe to be canceled and cancels those queries.

Default value: Continue to execute queued queries when the pipeline is stopped or if it fails

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Default Value: Execute only
Example: Validate & Execute

Dropdown list

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

...

Instead of building multiple Snaps with interdependent DML queries, we recommend that you use the Multi Execute Snap.
In a scenario where the downstream Snap does depend on the data processed on an Upstream Database Bulk Load Snap, use the Script Snap to add delay for the data to be available.

For example, when performing a create, insert and delete function sequentially on a pipeline, using a Script Snap helps in creating a delay between the insert and delete function. Else, it may turn out that the delete function is triggered even before inserting the records on the table.

Example

...

This pipeline reads the data from a table in Oracle and inserts it into a Snowflake table using the Snowflake - Insert Snap. 

...

The data preview of the Oracle Select Snap is: Image Removed

...

The data from Oracle is inserted into the Snowflake table, adobedata  using the Snowflake Insert Snap.

...

After the pipeline executes, the Snowflake - Insert Snap shows the following data preview:  Image Removed

...

Insert excerpt
Snowflake Snap Pack
Snowflake Snap Pack
nopaneltrue