On this Page
Table of Contents | ||||
---|---|---|---|---|
|
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.
...
...
Snap Type
The Snowflake - Insert Snap is a Write-type Snap that inserts new records into Snowflake database tables
Prerequisites
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
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.
...
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 |
|
| 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 |
|
| 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:
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 |
---|
|
Field Name | Field Type | Description |
---|---|---|
Label* Default Value: Snowflake - Insert | 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 | 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. |
The values can be passed using the pipeline parameters but not the upstream parameter. |
Table name* Default |
---|
Value: N/A | Specify the name of the table to execute insert-on. |
---|
|
|
Create table if not present Default value: Deselected | Checkbox |
| ||||||
---|---|---|---|---|---|---|---|---|
Preserve case sensitivity Default |
Value: Deselected | Checkbox | Select this check box to preserve the case sensitivity of the column names.
|
---|---|---|
Number of retries Default Value: 0 | 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. |
Example: 3
| ||||||
Retry interval (seconds) Default Value: 1 | 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 |
Example: 10
Manage Queued Queries
Value: Continue to execute 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. |
---|
If you select Cancel queued queries when the pipeline is stopped or if it fails, then |
the read queries under execution are canceled, whereas the write queries under execution are not canceled. |
Snowflake internally determines which queries are safe to be canceled and cancels those queries. |
Default Value: Execute only | Dropdown list |
|
---|
...
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:
...
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:
...
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|