| Appsplus panel macro confluence macro | ||
|---|---|---|
| ||
**Delete Before Publishing**
|
In this article
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Overview
You can use this Snap to insert data into Snowflake using the Snowpipe Streaming API, which enables the continuous ingestion of data into Snowflake tables as and when it is available.
The Snowpipe Streaming Snap uses the role defined in the account URL properties field. If a role is not defined, the Snap runs a SELECT CURRENT_ROLE() to determine a suitable role, failing which it falls back to the PUBLIC role.
...
Snap Type
The <Snap name> Snowflake – Snowpipe Streaming Snap is a Read/ Write/Parse/Transform/Flow/Format-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates… .
Prerequisites
Valid client IDSnowflake KeyPair or OAuth 2.0 account.
A valid account with the required permissions.
...
.
Support for Ultra
...
Tasks
Works in Ultra Pipelines.
Works in Ultra Pipelines if....
Does not support Ultra Pipelines.
Limitations
None.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input | Document |
Binary
Binary or Document
|
|
|
Requires the |
table name where the data has to be inserted and the data flush interval (milliseconds) in which the data is pushed to the database. | |
Output | Document |
|
Binary or Document
|
|
..
| Inserts data in Snowflake tables in specified intervals. | |||
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. | |||
Snap Settings
...
| data | {"features":["title","icon","rounded","collapsible","border"],"title":"Documenting Fields Based On Data Type/UI Element","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false} |
|---|
**Delete Before Publishing**
Choose from the following sentences to document specific field types.
Drop-down lists/Option Buttons (radio buttons):
You must list the LoV and describe them if their meaning isn't apparent. In this case, format the LoV in italics, regular font for the LoV's description. In either case, list the LoVs as a bullet list.
<State what the option should do in this field>. The available options are: <bullet list of LoVs>
Specify the Salesforce API to be used. The available options are:...Select the <category> that you want to use. Available options are...
* Option 1<italicized>. <third person singular form of the verb>
* Option 2<italicized>. <third person singular form of the verb>
Select the API that you want to use. Available options are:
Bulk API. Sends the Snap execution request details as a bulk API call.
REST API. ...
OR
Select one of the three following modes in which the Snap executes:
* Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime.
* Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data.
* Disabled. Disables the Snap and all Snaps downstream from it.
Check boxes:
If selected, <Snap behavior>.
If selected, an empty file is written when the incoming document has no data.If selected, <behavior>. If not selected/Otherwise, <behavior>
Use "If not selected" if the first sentence is long.
If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.Select to <action>
Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
Select to execute the Pipeline during validation.
Text Fields
Describe what the user shall specify in this field. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
Enter the name for new account.
Specify the account ID to use to log in to the endpoint.
Required if IAM Role is selected.
Do not use this field if you are using batch processing.
Numeric Text Fields
Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
The number of records in a batch.
The number of seconds for which you want the Snap to wait between retries.
The number of seconds for which the Snap waits between retries.
Use the following special values:
* 0: Disables batching.
* 1: Includes all documents in a single request.
Notes in field descriptions
Confluence’s new editor does not allow nesting of most macros inside another macro, especially the Note/Alert/Warning/Info (Panel) macros inside a table macro and Excerpt macros inside Expand or Panel Macro+ macros. So, as a workaround use the Footnotes approach as mentioned below:
...
Assign numbers at the Note locations in the form of follow through phrases like See Note 2 below this table. or such.
...
| Info |
|---|
|
): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Field Name | Field Type |
|---|
Description | |
|---|---|
Label*
Default Value: |
Snowflake – Snowpipe Streaming |
Stream Data | String |
None.
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 |
Sampling Type is Number of records.
Enter the number of records to output.
fieldset Name
Specify advanced parameters that you want to include in the request.
Field 1*/Suggestion | Specify the database schema name. | |
Table Name*
Default Value: N/A | String/Expression/Suggestion | Specify the table name on which the insert operation has to be executed. |
Create table if not present
Default Value: |
Example: <value>
String
Debug mode check box is not selected.
Deselected | Checkbox | Select this checkbox if you want the table to be automatically created if it does not already exist. |
Max client lag*
Default Value: |
1000 |
String
None.
: 1500 | Integer/Expression/Suggestion | Specify the client data flush interval in milliseconds. Adjust this value based on the maximum latency your target system can handle (60,000 ms). This field also accepts inputs in n-second and n-minute formats. Maximum value is 10 minutes. |
Snap execution Default Value: | Dropdown list |
Select one of the following three modes in which the Snap executes:
|
Troubleshooting
Error | Reason | Resolution |
|---|
Account validation failed.
The Pipeline ended before the batch could complete execution due to a connection error.
Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.
Examples
Excluding Fields from the Input Data Stream
We can exclude the unrequired fields from the input data stream by omitting them in the Input schema fieldset. This example demonstrates how we can use the <Snap Name> to achieve this result:
<screenshot of Pipeline/Snap and description>
Download this Pipeline.
Downloads
...
Download and import the pipeline into the SnapLogic application.
...
Configure Snap accounts, as applicable.
...
| The schema name is required for Snowpipe Streaming. | Provide a schema name in the Snap configuration. |
Examples
Ingest Data from One Table to Another in Snowflake
This example pipeline demonstrates real-time data ingestion from one table to another within Snowflake. As new data is added to the source table, the Snowpipe Streaming Snap detects these changes and then streams the new data directly into the target table without significant delays. Here's the execution flow of the pipeline:
Source Table: The table where new data entries are continuously added.
Snowpipe Streaming Snap: This Snap monitors the source table for new data and streams the data in real time.
Target Table: The destination table where the streamed data is inserted.
...
Step 1: Configure the Snowflake - Execute Snap to delete the existing table.
...
Step 2: Configure the Snowflake - Select Snap with Schema name and Table name fields. Add the second output view for Snowflake - Select to pass the schema to the downstream Snowflake - Snowpipe Streaming Snap to enable table creation.
 |  |
Step 3: Configure the Snowflake - Snowpipe Streaming Snap to ingest the data into the Snowflake database as and when available. On validation, the data is successfully inserted into the Snowflake database.
 |  |
Ingest Data from a Source into Snowflake
This example pipeline demonstrates how to use Snowflake - Snowpipe Streaming Snap to ingest data into the Snowflake database from a source as and when it is available. Here's the execution flow of the pipeline:
Data generation: The Sequence Snap generates a set number of data records.
Data formatting: The JSON Formatter Snap converts these records into JSON format.
Data Streaming: The Snowflake Snowpipe Streaming Snap ingests the JSON-formatted data into a specified Snowflake table as soon as the data is available.
...
Step 1: Configure the Sequence Snap to generate ten documents.
Step 2: Configure the Mapper Snap to pass the values to the downstream Snowflake- Snowpipe Streaming Snap.
...
Step 3: Configure the Snowflake - Execute Snap to create or replace an existing table with the column datatype.
...
Step 4: Configure the Mapper Snap to pass the values to the downstream Snowflake- Snowpipe Streaming Snap.
...
Step 5: Configure the Snowflake—Snowpipe Streaming Snap to ingest the data into the Snowflake database as and when available.
...
On validation, the data is successfully inserted into the Snowflake database.
...
| Attachments | ||
|---|---|---|
|
...
Snap Pack History
| Expand | ||
|---|---|---|
| ||
|
...
|
...
|
...
Related Content
Endpoint Doc Link 1
Endpoint Doc Link 2
Endpoint Doc Link 3Snowflake Snap Pack