Versions Compared

Old Version 106

changes.mady.by.user Lakshmi Manda

Saved on

compared with

New Version Current

changes.mady.by.user Lakshmi Manda

Saved on

Key

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

In this article

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

Overview

You can use this Snap to execute Snowflake bulk load, for example, writing data from Snowflake into an Amazon S3 bucket or a Microsoft Azure Storage Blob.
Image Removed
Note

The Snap creates temporary files in JCC when the Staging location is internal and the Data source is input view. These temporary files are removed automatically once the Pipeline completes execution.

Snap Type

The Snowflake - Bulk Load Snap is a Write-type Snap.

Prerequisites

Excerpt

You must have minimum permissions on the database to execute Snowflake Snaps. To understand if you already have them, you must retrieve the current set of permissions. The following commands enable you to retrieve those permissions.

Code Block
SHOW GRANTS ON DATABASE <database_name>
 
SHOW GRANTS ON SCHEMA <schema_name>
 
SHOW GRANTS TO USER <user_name>

Security Prererequisites

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

  • Usage (DB and Schema): Privilege to use the database, role, and schema.
  • Create table: Privilege to create a temporary table within this schema.

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

Learn more about Snowflake privileges, Access Control Privileges.

The below are mandatory when using an external staging location:

When using an Amazon S3 bucket for storage:

  • The Snowflake account should contain S3 Access-key ID, S3 Secret key, S3 Bucket and S3 Folder.
  • The Amazon S3 bucket where the Snowflake will write the output files must reside in the same region as your cluster.

When using a Microsoft Azure storage blob:

  • A working Snowflake Azure database account.

Internal SQL Commands

This Snap uses the following Snowflake commands internally:

  • COPY INTO - Enables loading data from staged files to an existing table.
  • PUT - Enables staging the files internally in a table or user stage.

Support for Ultra Pipelines

Works in Ultra Pipelines. Howevever, we recommend you not to use this Snap in an Ultra Pipeline.

Limitations

  • Special character'~' is not supported if it is there in temp directory name for Windows. It is reserved for user's home directory.

  • Snowflake provides the option to use the Cross Account IAM into the external staging. You can adopt the cross account access through option Storage Integration. With this setup, you don’t need to pass any credentials around, and access to the storage only using the the named stage or integration object. For more details: Configuring Cross Account IAM Role Support for Snowflake Snaps

  • Snowflake Bulk Load expects column order should be as like table from upstream snaps otherwise it will result in failure of data validation.
  • If a Snowflake Bulk Load operation fails due to inadequate memory space on the JCC node when the Data Source is Input View and the Staging Location is Internal Stage, you can store the data on an external staging location (S3, Azure Blob or GCS).
  • When the bulk load operation fails due to invalid input, the error view does not display the erroneous columns correctly when the input does not contain the default columns.
    This is a bug in Snowflake and is being tracked under JIRA SNOW-662311 and JIRA SNOW-640676.

Known Issues

None.

Snap Views

TypeFormatNumer of ViewsExamples of Upstream and Downstream SnapsDescriptionInputDocument

  • Min: 0

  • Max: 2

  •  JSON Generator
  • Binary to Document

Documents containing the data to be uploaded to the target location.

Info
iconfalse
titleSecond Input View

This Snap has one document input view by default. 

You can add a second input view for metadata for the table as a document so that when the target table is absent, this table metadata can be created in the database 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, the data types might not be properly handled.

Learn more about adding metadata for the table in the second input view from the example

Providing Metadata For Table Using The Second Input View.

.

OutputDocument

  • Min: 0

  • Max: 1

  • Mapper
  • Snowflake Execute
If an output view is available, then the original document that was used to create the statement will be output with the status of the insert executed. A document containing the original document provided as input and the status of the bulk upload.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 while 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.

Snap Settings

Info

  • Asterisk ( *  ): Indicates a mandatory field.

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

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

  • Add icon ( Image Removed ): Indicates that you can add fields in the fieldset.

  • Remove icon ( Image Removed): Indicates that you can remove fields from the fieldset.

Field Name

Field TypeField DependencyDescription

Label*

Default Value: Snowflake - Bulk Load
Example: Load Employee TablesStringN/ASpecify the name for the instance. 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/Suggestion

N/A

Specify the database schema name. In case it is not defined, then the suggestion for the Table Name retrieves all tables 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: N/A
Example:employees_table

String/Expression/Suggestion

N/A

Specify the name of the table to execute bulk load operation on.

Note

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

Create table if not present

Default Value: Deselected

Checkbox

N/A

Select this check box to allow the Snap to automatically create a table if a table does not exist.

Note
  • The data type for the columns in the new table depends on the data type of the input in the upstream Snap. If a second input view exists the data type for the columns is read from the input view.
  • Due to implementation details a newly created table is not visible to subsequent database Snaps during runtime validation. If you wish to immediately use the newly updated data you must use a child Pipeline invoked via a Pipe Exec Snap.
  • Create table if not present works only when the set Datasource is Inputview. When you select Create table if not present and the Datasource is set to a Staged files, then the Snowflake Bulk Load Snap throws a configuration exception "Failure: Invalid snap configuration", because this Snap does not support table creation when you upload existing files. You can create a table if a table does not exist and retry.
Warning

This should not be used in production since there are no indexes or integrity constraints on any column and the default varchar() column is over 30k bytes.

Data source

Default Value: Input view
Example: Staged files

Dropdown list

N/A

Specify the source from where the data should load. The available options are Input view and Staged files.

Note

When the option 'Input View' is selected, leave the Table Columns field empty, and if the 'Staged files' option is selected, provide the column names for the Table Columns to which the records are to be added.

Preserve case sensitivity

Default Value: Deselected

Checkbox

N/A

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.

Load empty strings

Default Value: Deselected

Checkbox

N/A

Select this check box to load empty string values in the input documents as empty strings to the string-type fields. Else, empty string values in the input documents are loaded as null. Null values are loaded as null regardless.

Truncate data

Default Value:  Deselected

Checkbox
N/ASelect this checkbox to truncate existing data before performing data load. With the Bulk Update Snap, instead of doing truncate and then update, a Bulk Insert would be faster.

Staging Location

Default Value: Internal
Example: External

Dropdown list

N/A

Select the type of staging location that is to be used for data loading:

  • External: Location that is not managed by Snowflake. The location should be an AWS S3 Bucket or Microsoft Azure Storage Blob. These credentials are mandatory while validating the Account.
    • Internal: Location that is managed by Snowflake.
    Info
  • If you want to delete the temporary files from the S3 Bucket, we recommend you assign the delete object permission policy to the S3 user to delete the files. Learn how to assign delete object permission to an S3 user in AWS S3.
    • If you do not want to delete the temporary files, you can add an error view to the Snap and run the Pipeline

    In this article

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

    Overview

    You can use the Snowflake - Bulkload Snap to load data from input sources or files stored on external object stores like Amazon S3, Google Storage, and Azure Storage Blob into the Snowflake data warehouse.

    Image Added

    Snap Type

    The Snowflake - Bulk Load Snap is a Write-type Snap that performs a bulk load operation.

    Prerequisites

    Excerpt

    You must have minimum permissions on the database to execute Snowflake Snaps. To understand if you already have them, you must retrieve the current set of permissions. The following commands enable you to retrieve those permissions:

    Code Block
    SHOW GRANTS ON DATABASE <database_name>
SHOW GRANTS ON SCHEMA <schema_name>
SHOW GRANTS TO USER <user_name>

    • You must enable the Snowflake account to use private preview features for creating the Iceberg table.

    • External volume has to be created on the Snowflake worksheet, or Snowflake Execute snap. Learn more about creating external volume.

    Security Prererequisites

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

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

    • Create table: Privilege to create a temporary table within this schema.

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

    Learn more about Snowflake privileges: Access Control Privileges.

    Internal SQL Commands

    This Snap uses the following Snowflake commands internally:

    • COPY INTO - Enables loading data from staged files to an existing table.

    • PUT - Enables staging the files internally in a table or user stage.

    Info

    Requirements for External Storage Location

    The following are mandatory when using an external staging location:

    When using an Amazon S3 bucket for storage:

    • The Snowflake account should contain S3 Access-key ID, S3 Secret key, S3 Bucket and S3 Folder.

    • The Amazon S3 bucket where the Snowflake will write the output files must reside in the same region as your cluster.

    When using a Microsoft Azure storage blob:

    • A working Snowflake Azure database account.

    When using a Google Cloud Storage:

    • Provide permissions such as Public access and Access control to the Google Cloud Storage bucket on the Google Cloud Platform.

    Support for Ultra Pipelines

    Works in Ultra Pipelines. However, we recommend that you not to use this Snap in an Ultra Pipeline.

    Limitations

    • Special character'~' is not supported if it is there in the temp directory name for Windows. It is reserved for the user's home directory.

    • Snowflake provides the option to use the Cross Account IAM in the external staging. You can adopt the cross-account access through the option Storage Integration. With this setup, you don’t need to pass any credentials around, and access to the storage only using the named stage or integration object. For more details: Configuring Cross Account IAM Role Support for Snowflake Snaps

    • Snowflake Bulk Load expects column order should be like a table from upstream snaps; otherwise, it will result in failure of data validation.

    • If a Snowflake Bulk Load operation fails due to inadequate memory space on the JCC node when the Data source is Input View and the Staging location is Internal Stage, you can store the data on an external staging location (S3, Azure Blob or GCS).

    • When the bulk load operation fails due to an invalid input and when the input does not contain the default columns, the error view does not display the erroneous columns correctly.
      This is a bug in Snowflake and is being tracked under JIRA SNOW-662311 and JIRA SNOW-640676.

    • This Snap does not support creating an iceberg table with an external catalog in Snowflake as, currently, the endpoint only allows read-only access for the tables that are created using an external catalog without any write capabilities. Learn more about iceberg catalog options.

    • Snowflake does not support cross-cloud and cross-region Iceberg tables when you use Snowflake as the Iceberg catalog. If the Snap displays an error message such as External volume <volume_name> must have a STORAGE_LOCATION defined in the local region ..., ensure that the External volume fielduses an active storage location in the same region as your Snowflake account.

    Behavior change

    Starting from 4.35 GA, if your Snaplex is behind a proxy and the Snowflake Bulk Load Snap uses the default Snowflake driver (3.14.0 JDBC driver), then the Snap might encounter a failure. There are two ways to prevent this failure:

    1️⃣ Add the following key-value pair in the Global properties section of the Node Properties tab:
    Key: jcc.jvm_options
    Value: -Dhttp.useProxy=true

    global-properties.pngImage Added

    2️⃣ Add the following key-value pairs in the URL properties of the Snap under Advanced properties.

    url-properties.pngImage Added

    We recommend you use the second approach to prevent the Snap’s failure.

    Known Issues

    Multiexcerpt macro
    nameKI_geospatial_data_type

    Known Issue: The create table operation fails if it contains a geospatial data type column.
    Workaround: Create the table manually ahead of time or use the Snowflake - Execute to create the table.

    Multiexcerpt macro
    hiddenfalse
    macro_uuid9eb3afd7-9cc2-4d79-bb4b-ff03106d1a7d
    nameKI_manage_queued_queries
    fallbackfalse

    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.

    Snap Views

    Type

    Format

    Number of Views

    Examples of Upstream and Downstream Snaps

    Description

    Input

    Document

    • Min: 0

    • Max: 2

    •  JSON Generator

    • Binary to Document

    Documents containing the data to be uploaded to the target location.

    Info

    Second Input View

    This Snap has one document input view by default. 

    You can add a second input view for metadata for the table as a document so that when the target table is absent, this table metadata can be created in the database 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, the data types might not be properly handled.

    Learn more about adding metadata for the table in the second input view from the example Providing Metadata For Table Using The Second Input View.

    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:

    Image Added

    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.

    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

    Field Dependency

    Description

    Label*


    Default Value: Snowflake - Bulk Load
    Example: Load Employee Tables

    String

    N/A

    Specify the name for the instance. 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/Suggestion


    N/A

    Specify the database schema name. In case it is not defined, then the suggestion for the Table Name retrieves all tables 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
    Example: employees_table

    String/Expression/Suggestion


    N/A

    Specify the name of the table to execute bulk load operation on.

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


    Create table if not present

    Default Value: Deselected


    Checkbox




    N/A

    Select this checkbox to automatically create the target table if it does not exist.

    • The data type for the columns in the new table depends on the data type of the input in the upstream Snap. If a second input view exists the data type for the columns is read from the input view.

    • Due to implementation details a newly created table is not visible to subsequent database Snaps during runtime validation. If you want to immediately use the newly updated data you must use a child Pipeline that is invoked through a Pipeline Execute Snap.

    • Create table if not present works only when the set Datasource is Inputview. When you select Create table if not present and the Datasource is set to Staged files, the Snowflake Bulk Load Snap throws the configuration exception "Failure: Invalid snap configuration" because this Snap does not support table creation when you upload existing files. You can create a table if a table does not exist and retry.

    • If you provide a second input view and select Create table if not present when the target table does not exist, the target table is only created from the metadata of the second input view and not from the input document.

    Info

    This should not be used in production since there are no indexes or integrity constraints on any column and the default varchar() column is over 30k bytes.

    Info

    The create table operation fails if it contains a geospatial data type column.
    Workaround: Create the table manually ahead of time, or use the Snowflake - Execute to create the table.

    Iceberg table

    Default Value: Deselected

    Checkbox

    Appears when you select Create table if not present.

    Select this checkbox to create an Iceberg table with the Snowflake catalog. Learn more about how to create and Iceberg table with Snowflake as the Iceberg catalog.

    External volume*

    Default Value: N/A
    Example:

    String/Expression/Suggestion

    Appears when you selectthe Iceberg table.

    Specify the external volume for the Iceberg table. Learn more about how to configure an external volume for Iceberg tables.

    Base location*

     

    Default Value: N/A
    Example: iceberg_s3_stage

    String/Expression

    Appears when you selectthe Iceberg table checkbox.

    Specify the Base location for the Iceberg table.

    The base location is the relative path from the external volume.

    Data source

    Default Value: Input view
    Example: Staged files


    Dropdown list

    N/A

    Specify the source from where the data should load. The available options are Input view and Staged files.

    When the option 'Input View' is selected, leave the Table Columns field empty, and if the 'Staged files' option is selected, provide the column names for the Table Columns to which the records are to be added.

    Preserve case sensitivity

    Default Value: Deselected

    Checkbox


    N/A

    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.

    Load empty strings

    Default Value: Deselected

    Checkbox


    N/A

    Select this check box to load empty string values in the input documents as empty strings to the string-type fields. Else, empty string values in the input documents are loaded as null. Null values are loaded as null regardless.

    Truncate data

    Default Value:  Deselected

    Checkbox


    N/A

    Select this checkbox to truncate existing data before performing data load. With the Bulk Update Snap, instead of doing truncate and then update, a Bulk Insert would be faster.

    Staging location


    Default Value: Internal
    Example: External


    Dropdown list/Expression



    N/A

    Select the type of staging location that is to be used for data loading:

    • External: Location that is not managed by Snowflake. The location should be an AWS S3 Bucket or Microsoft Azure Storage Blob or Google Cloud Storage. These credentials are mandatory while validating the Account.

    • Internal: Location that is managed by Snowflake.

    • The Snap creates temporary files in JCC when the Staging location is internal and the Data source is input view. These temporary files are removed automatically once the Pipeline completes execution.

    • Vector support:

      • This Snap supports loading data in vector data type only when the Staging location is Internal.

      • The input vector data must be an array.

      • If you use a SELECT query, you must parse the vector.

    Info

    • If you want to delete the temporary files from the S3 Bucket, we recommend you assign the delete object permission policy to the S3 user to delete the files. Learn how to assign delete object permission to an S3 user in AWS S3.

    • If you do not want to delete the temporary files, you can add an error view to the Snap and run the Pipeline.

    Flush chunk size (in bytes)

    String/Expression

    Appears when you select Input view for Data source and Internal for Staging location.

    When using internal staging, data from the input view is written to a temporary chunk file on the local disk. When the size of a chunk file exceeds the specified value, the current chunk file is copied to the Snowflake stage and then deleted. A new chunk file simultaneously starts to store the subsequent chunk of input data. The default size is 100,000,000 bytes (100 MB), which is used if this value is left blank.

    Target

    Default Value: N/A
    Example: s3://test_bucket

    String/Expression



    N/A

    Specify an internal or external location to load the data. If you select External for Staging Location, a staging area is created in Azure, GCS, or S3 as configured

    ; else

    . Otherwise, a staging area is created in Snowflake's internal location.

    The staging

    This field accepts the following input:

    • Named Stage: The name for user-defined named stage. This should be used only when a Staging location is set as Internal. 
      Format: @<Schema>.<StageName>[/path]

    • Internal Path: The staging

    represent with

    • location represent by a path.
      Format: @~/[path]

    • S3 Url: The external S3 URL that specifies an S3 storage bucket.
      Format: s3://[path]

    • Microsoft Azure Storage Blob URL: The external URL required to connect to the Microsoft Azure Storage.

    • Folder Name: Anything else (including

    none

    • no input). This is regarded as a Folder name under the Internal Home Path (@~) if using internal staging or under the S3 bucket and folder specified in the Snowflake account.

    Note

    The value for the expression has to be provided as a Pipeline parameter and cannot be provided from the Upstream Snap for performance reasons when you use expression values.

    Storage Integration

    Default Value: N/A
    Example: 

    String/Expression

    Appears when you select Staged files for Data source and External for Staging location.

    Specify the pre-defined storage integration that is used to authenticate the external stages.

    Note

    The value for the expression has to be provided as a Pipeline parameter and cannot be provided from the Upstream Snap for performance reasons when you use expression values.

    Staged file list

    Use this field set to define staged file(s) to be loaded to the target file.


    Staged file

    String/Expression

    Appears when you select Staged files for Data source.

    Specify the staged file to be loaded to the target table.

    File name pattern

    Default Value: N/A

    Example: .length

    String/Expression


    Appears when you select Staged files for Data source.

    Specify a regular expression pattern string, enclosed in single quotes with the file names and /or path to match.

    File format object

    Default Value: None

    Example: jsonPath()

    String/Expression

    /Suggestion

    N/A

    Specify an existing file format object to use for loading data into the table. The specified file format object determines the format type such as CSV, JSON, XML, AVRO, or other format options for data files.

    File

    Format type

    format type

    Default Value: None
    Example: CSV

    Dropdown list

    String/Expression/Suggestion

    N/A

    Specify a predefined file format object to use for loading data into the table. The available file formats include CSV, JSON, XML, and AVRO.

    File Format

    This Snap supports only CSV and NONE as file format types when the Datasource is Input view.

    File format option


    Default value:  N/A
    Example: BINARY_FORMAT=

    UTF-8

    UTF8


    String/Expression


    N/A

    Specify the file format option. Separate multiple options by using blank spaces and commas.

    Excerpt


    Info

    You can use various file format options including a binary format which passes through in the same way as other file formats.

    See

    Learn more: File Format Type Options

    for additional information

    .

    Before loading binary data into Snowflake, you must specify the binary encoding format, so that Snap can decode the string type to binary types before loading it into Snowflake. This can be done by selecting the following binary file format:

    BINARY_FORMAT=xxx (Where XXX = HEX|BASE64|

    UTF-8

    UTF8)

    However, the file you upload and download must be in similar formats. For instance, if you load a file in HEX binary format, you should specify the HEX format for download as well.

    note

    title


    When using external staging locations

    • When loading numeric data from staged files, you must provide file format options depending on the user's data.

    • Do not use the following file format options if you selected Input view in the Data source field.

      • FIELD_DELIMITER

      • RECORD_DELIMITER

      • FIELD_OPTIONALLY_ENCLOSED_BY

    Table Columns



    Use this field set to specify the columns to be used in the COPY INTO command. This only applies when the Data source is Staged files. 

    columns

    Columns
    Default value: None

    String/Expression/Suggestion

    N/A

    Specify the table columns to use in the Snowflake COPY INTO query. This configuration is valid when the staged files contain a subset of the columns in the Snowflake table. For example, if the Snowflake table contains columns A, B, C, and D, and the staged files contain columns A and D then the Table Columns field would have two entries with values A and D. The order of the entries should match the order of the data in the staged files.

    note

    If the Data source is Input view, the snap displays the following error:

    Image Removed
    Image Added

    Select Query

    Default Value: N/A
    Example: 

    select substr

    select substr(t.

    $2

    $2,4),

     t

     t.

    $1

    $1,

     t

     t.

    $5

    $5,

     t.$4 
    from @mystage t

     t.$4 
    from @mystage t

    String/Expression

    Appers Staged

    Appears when the Data source

     is 

     is Staged files.

    Specify the SELECT query to transform data before loading it into the Snowflake database. 

    The SELECT statement transform option enables querying the staged data files by either reordering the columns or loading a subset of table data from a staged file. For example, 

    select $1

    select $1:location,

     $1

     $1:dimensions.sq_ft,

     $1

     $1:sale_date,

     $1:price from @mystage

     $1:price from @mystage/sales.json.

    gz t

    gz t
    This query loads the file sales.json from the internal stage mystage, (which stores the data files internally); wherein location, dimensions.sq_ft, and sale_date are the objects.

    (OR)

    select substr

    select substr(t.

    $2

    $2,4),

     t

     t.

    $1

    $1,

     t

     t.

    $5

    $5,

     t.$4 from @mystage t

     t.$4 from @mystage t
    This query reorders the column

    data from

    data from the internal stage mystage before loading it into a table. The (SUBSTR), SUBSTRING function removes the first few characters of a string before inserting it.

    Note

    We recommend you not use a temporary stage while loading your data.

    Encryption type

    Default Value: None
    Example: Server-Side Encryption

    Dropdown list


    N/A

    Specify the type of encryption to be used on the data. The available encryption options are:

    • None: Files do not get encrypted.

    • Server Side Encryption: The output files on Amazon S3 are encrypted with server-side encryption.

    • Server-Side KMS Encryption: The output files on Amazon S3 are encrypted with an Amazon S3-generated KMS key. 

    note

    The KMS Encryption option is available only for S3 Accounts (not for Azure Accounts and GCS) with Snowflake.

    Note

    If Staging Location is set to Internal, and when Data source is Input view, the Server Side Encryption and Server-Side KMS Encryption options are not supported for Snowflake snaps:

    This happens because Snowflake encrypts loading data in its internal staging area and does not allow the user to specify the type of encryption in the PUT API

    (see 

    . Learn more: Snowflake PUT Command Documentation.

    )

    KMS key


    Default Value: N/A
    Example: <Encrypted>

    String/Expression



    N/A

    Specify the KMS key that you want to use for S3 encryption. Learn more about the KMS key

    , see 

    : AWS KMS Overview

     and 

     and Using Server Side Encryption.

    Buffer size (MB)


    Default Value: 10MB
    Example:

    20MB

    20MB

    String/Expression




    N/A

    Specify the data in MB to be loaded into the S3 bucket at a time. This property is required when bulk loading to Snowflake using AWS S3 as the external staging area.

    Minimum value: 5 MB

    Maximum value: 5000 MB

    Note

    S3 allows a maximum of 10000 parts to be uploaded so this property must be configured accordingly to optimize the bulk load.

     Refer

     Refer toUpload Part for more information on uploading to S3. 

    Manage Queued Queries


    Default Value: Continue to execute queued queries when

    pipeline

    the Pipeline is stopped or if it fails
    Example: Cancel queued queries when

    pipeline

    the Pipeline is stopped or if it fails

    Dropdown list

    N/A

    Select this property to determine 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

    pipeline

    the Pipeline is stopped or if it fails, then

    the read

    the read queries under execution are

    cancelled

    canceled, whereas the write type of queries under execution are not

    cancelled

    canceled.

     Snowflake

     Snowflake internally determines which queries are safe to be

    cancelled

    canceled and cancels those queries.

    Additional Options

    On Error

    Default Value: ABORT_STATEMENT
    Example: CONTINUE



    Dropdown list

    N/A

    Select an action to perform when errors are encountered in a file. The available actions are:

    • ABORT_STATEMENT: Aborts the COPY statement if any error is encountered. The error will be thrown from the Snap or routed to the error view.

    • CONTINUE: Continues loading the file. The error will be shown as a part of the output document.

    • SKIP_FILE: Skips file if any errors encountered in the file.

    • SKIP_FILE_*error_limit*: Skips file when the number of errors in the file exceeds the number specified in Error Limit.

    • SKIP_FILE_*error_percent_limit*%: Skips file when the percentage of errors in the file exceeds the percentage specified in Error percentage limit.

    Error Limit

    Default Value: 0
    Example: 3

    Integer

    Appears when you select SKIP_FILE_*error_

    percent_

    limit*

    %: Skips file when the percentage

    for On Error.

    Specify the error limit to skip file. When the number of errors in the file exceeds the

    percentage specified in Error percentage limit

    specified error limit or when SKIP_FILE_number is selected for On Error.

    Error Percentage Limit

    Default Value: 0
    Example:

    3

    1

     

    Integer

    Appears when you select SKIP_FILE_*error_percent_limit*% 
    for On Error.

    Specify the

    error limit to skip file. When the number of errors in the file exceeds the specified error limit or when SKIP_FILE_number is selected for On Error.Error Percentage Limit

    Default Value:0
    Example: 1

    Integer

    Appears when you select SKIP_FILE_*error_percent_limit*% 
    for On Error.

    Specify the percentage of errors  to skip file. If the file exceeds the specified percentage when SKIP_FILE_number% is selected for On Error. 

    Size Limit

    Default Value: 0
    Example: 5

    Integer

    N/A

    Specify the maximum size (in bytes) of data to be loaded.

    Note

     At least one file is loaded regardless of the value specified for SIZE_LIMIT unless there is no file to be loaded. A null value indicates no size limit.

    Purge

    Default value: Deslected

     Checkbox

    N/A

    Specify whether to purge the data files from the location automatically after the data is successfully loaded.

    Return Failed Only

    Default value: Deselected

    Checkbox

    N/A

    Specify whether to return only files that have failed to load while loading.

    Force

    Default value: Deselected

    Checkbox

    N/A

    Specify if you want to load all files, regardless of whether they have been loaded previously and have not changed since they were loaded.

    Truncate Columns

    Default value: Deselected

    Checkbox

    N/A

    Select this checkbox to truncate column values that are larger than the maximum column length in the table.

    Validation mode

    Default Value: None
    Example:     RETURN_n_ROWS

    Dropdown list

    N/A

    Select the validation mode for visually verifying the data before unloading it. The available options are:

    • NONE
    • RETURN_n_ROWS
    • RETURN_ERRORS
    • RETURN_ALL_ERRORS
    Rows to return

    Default Value: 0
    Example: 5

    Integer

    N/A

    percentage of errors  to skip file. If the file exceeds the specified percentage when SKIP_FILE_number% is selected for On Error. 

    Size Limit

    Default Value: 0
    Example: 5

    Integer

    N/A

    Specify the maximum size (in bytes) of data to be loaded.

    At least one file is loaded regardless of the value specified for SIZE_LIMIT unless there is no file to be loaded. A null value indicates no size limit.

    Purge

    Default value: Deselected

    Checkbox

    Appears when the Staging location is External.

    Specify whether to purge the data files from the location automatically after the data is successfully loaded.

    Return Failed Only

    Default Value: Deselected

    Checkbox

    N/A

    Specify whether to return only files that have failed to load while loading.

    Force

    Default Value: Deselected

    Checkbox

    N/A

    Specify if you want to load all files, regardless of whether they have been loaded previously and have not changed since they were loaded.

    Truncate Columns

    Default Value: Deselected

    Checkbox

    N/A

    Select this checkbox to truncate column values that are larger than the maximum column length in the table.

    Validation Mode

    Default Value: None
    Example: RETURN_n_ROWS

    Dropdown list

    N/A

    Select the validation mode for visually verifying the data before unloading it. The available options are:

    • NONE

    • RETURN_n_ROWS

    • RETURN_ERRORS

    • RETURN_ALL_ERRORS

    Validation Errors Type


    Default Value: Full error
    Example: Do not show errors

    Dropdown list

    Appears when you select NONE for Validation Mode.

    Select one of the following methods for displaying the validation errors:

    • Aggregate errors per row: Provides a summary view of the errors. You can expand rows to reveal a detailed view of the errors.

    • Full error: Provides the complete error message.

    • Do not show errors

    Rows to Return

    Default Value: 0
    Example: 5

    Integer

    Appears when you select RETURN_n_ROWS, RETURN_ERRORS, and RETURN_ALL_ERRORS for Validation Mode.

    Specify the number of rows not loaded into the corresponding table. Instead, the data is validated to be loaded and returns results based on the validation option specified. It can be one of the following values: RETURN_n_ROWS | RETURN_ERRORS | RETURN_ALL_ERRORS

    Snap Execution


    Default Value: Execute only
    Example: Validate & Execute

    Dropdown list

    N/A

    Select one of the three modes in which the Snap executes. Available options are:

    • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, 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 that are downstream from it.

    note

    Instead of building multiple Snaps with

    inter dependent

    interdependent DML queries, we recommend you

    to

    use the Stored Procedure or the Multi Execute

    Snap

    Snaps.
    In a scenario where the downstream Snap depends 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

    a

    delete function sequentially on a

    Pipeline using a

    pipeline, the 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.

    Examples

    to create a delay between the insert and delete function. Otherwise, the delete function may get triggered before inserting the records into the table.

    Troubleshooting

    Error

    Reason

    Resolution

    Data can only be read from Google Cloud Storage (GCS) with the supplied account credentials (not written to it).

    Snowflake Google Storage Database accounts do not support external staging when the Data source is the Input view.

    Data can only be read from GCS with the supplied account credentials (not written to it).

    Use internal staging if the data source is the input view or change the data source to staged files for Google Storage external staging.

    Examples

    Provide metadata in the table using the second input view

    This example Pipeline demonstrates how to provide metadata for the table definition through the second input view, to enable the Bulk Load Snap to create a table according to the definition.

    Image Removed
    Image Added

    1. Configure the Snowflake Execute Snap as follows to drop the newTable with the

    DROP

    1. DROP TABLE query.

    Image Modified

    2. Configure the Mapper Snap as follows to pass the input data.

    Image Modified

    3. Configure the Snowflake Bulk Load Snap with two input views:

                a. First input view: Input data from the upstream Mapper Snap.

                b. Second input view: Table metadata from JSON Generator. If the target table is not present, a table is created in the database based on the schema from the second input view.

    Image ModifiedImage Modified

    JSON Generator Configuration: Table metadata to pass to the second input view.

    Image Modified

    4. Finally, configure the Snowflake Select Snap with two output views.

    Image ModifiedImage Modified

    Output from the first input view.

    Output from the second input view: This schema of the target table is from the second output (rows) of the Snowflake Select Snap.

    Image ModifiedImage Modified

    Download this Pipeline.

    Loading Binary Data Into

    Load binary data into Snowflake

    The following example Pipeline demonstrates how you can convert the staged data into binary data using the binary file format before loading it into the Snowflake database.

    Image Removed
    Image Added

    To begin with, configure the Snowflake Execute Snap with this query: select * from "PUBLIC"."EMP2" limit 25——this query reads 25 records from the Emp2 table.

    Image Removed
    Image Added

    Next, configure the Mapper Snap with the output from the upstream Snap by mapping the employee details to the columns in the target table. Note that the Bio column is the binary data type and the Text column is varbinary data type. Upon validation, the Mapper Snap passes the output with the given mappings (employee details) in the table.

    Image Removed
    Image Added

    Next, configure the Snowflake - Bulk Load Snap to load the records into Snowflake. We set the File format option as BINARY_FORMAT=UTF-8 to enable the Snap to encode the binary data before loading.

    Image Removed
    Image Added

    Upon validation, the Snap loads the database with 25 employee records.

    Output Preview

    Data in Snowflake

    Image Removed
    Image Added
    Image Removed
    Image Added

    Finally, connect the JSON Formatter Snap to the Snowflake - Bulk Load Snap to transform the binary data to JSON format, and finally write this output in S3 using the File Writer Snap.

    Image Removed
    Image Added

    Download this Pipeline.

    Transforming Data Using Select Query Before Loading Into

    Transform data using a select query before loading into Snowflake

    The following example Pipeline

    demonstrates how

    demonstrates how you can reorder the columns using the SELECT statement transform option before loading data into Snowflake database. We use the Snowflake - Bulk Load Snap to accomplish this task.

    Image Removed
    Image Added

    Prerequisite: You must create an internal or external stage in Snowflake before you transform your data. This stage is used for loading data from source files into the tables of Snowflake database.

    To begin with, we create a stage using a query in the following format.

     Snowflake

     Snowflake supports both internal (Snowflake) and external (Microsoft Azure and AWS S3) stages for this transformation. 

    "CREATE STAGE IF NOT EXISTS "+_stageName+" url='"+_s3Location+"' CREDENTIALS = (AWS_KEY_ID='string' AWS_SECRET_KEY='string') "

    This query creates an external stage in Snowflake pointing to S3 location with AWS credentials (Key ID and Secrete Key).

    note

    We recommend that you do not use a temporary stage to prevent issues while loading and transforming your data.

    Now, add the Snowflake - Bulk Load Snap to the canvas and configure it to transform the data in the staged file SNAP7517_EXT_CSV.csv by providing the following query in the Select Query field:
    "select t.$1,t.$4,t.$3,t.$4,t.$5,t.$6,t.$7 from @"+_stageName+" t"

    Note

    You must provide the stage name along with schema name in the Select Query, else the Snap displays an error. For instance,
    SELECT t.$1,t.$4,t.$3,t.$4,t.$5,t.$6,t.$7 from @mys3stage t", displays an error.
    SELECT t.$1,t.$4,t.$3,t.$4,t.$5,t.$6,t.$7 from @<Schema Name>.<stagename> t", executes correctly.

    Image Removed
    Image Added

    Next, connect a Snowflake Select Snap with the Snowflake - Bulk Load Snap to select the data from the Snowflake database. Upon validation you can view the transformed data in the output view.

    Image Removed
    Image Added

    Download this Pipeline.

    Expand
    titleSnowflake Bulk Load Snap removes spaces from input documents

    You

    can remove empty

    can remove empty spaces from input documents.

     When you  

     When you select Input view

     as

     as Data Source,

    enter 

    enter TRIM_SPACE=TRUE in the File Format Option

     field to

     field to remove empty spaces, if any.

    Image Modified

    Download

     this

     this pipeline.

    In this example, the Pipeline uses the following Snaps:

    • Data (JSON Generator): Generates a JSON document for the Snowflake - Bulk Load Snap in the Pipeline. In this example, the JSON document contains an empty space.

    • BL: Executes a Snowflake Bulk Load, writing data into an Amazon S3 bucket or a Microsoft Azure Storage Blob. Also, it enables you to remove all spaces from the input document.

    • Schema (JSON Generator): Provides the schema to interpret the document passed to the Snowflake - Bulk Load Snap.

    • Snowflake - Execute: Reads the newly uploaded document and enables you to check whether the spaces were removed as expected.

    Anchor
    DATA
    DATA
    Data (JSON Generator)

    Data streams from your database source, and you do not necessarily need a Snap to provide input documents. In this example, however, we use the JSON Generator Snap to provide the input document.

    Input:

    Image Modified

    Output:

    Image Modified

    As you can see, the value listed against the key ACCOUNT_NAME has empty spaces in it.

    Anchor
    BL
    BL
    Snowflake - Bulk Load

    Input:

    Image Modified
    Note

    Notice that the File Format Option is TRIM_SPACE=TRUE.

    Output:

    Image Modified

    Anchor
    GEN
    GEN
    Schema (JSON Generator)

    Table schema is taken from your database source, and you do not necessarily need a Schema Snap to provide the table schema. In this example, however, we use the JSON Generator Snap to provide the table schema.

    Input:

    Image Modified

    Output:

    Image Modified

    Anchor
    EXEC
    EXEC
    Snowflake - Execute

    Input:

    Image Modified

    Output:

    Image Modified

    As you can see, the data no longer contains any spaces.


    Expand
    titleSnowflake Bulk Load with Table Columns on Staged files

    In this pipeline, the Snowflake Bulk Load Snap loads the records from a staged file 'employee.csv content' on to a table on Snowflake.

    Image Modified

    The staged file 'employee.csv content' is passed via the Upstream Snap:

    Image Modified

    The Snowflake Bulk Load Snap is configured with Data source as Staged files and the Table Columns added as ID, FIRSTNAME, CITY, to be loaded into a table "PRASANNA"."EMPLOYEE" on Snowflake.

    Image Removed
    Image Added


    The successful execution of the pipeline displays the below output preview:

    Image Modified

    If the 'employee.csv content' (Staged file)has the below details:

    1,PRASANNA,Hyderabad
    2,Aparna,hyderabad

    Table Columns added are:
    ID, FIRSTNAME, CITY

    then the table, "PRASANNA"."EMPLOYEE" on Snowflake is as below:

    code

    title
    The Snowflake table "PRASANNA"."EMPLOYEE"
    Code Block
    Create table "PRASANNA"."EMPLOYEE" (ID int, FIRSTNAME varchar(30), LASTNAME varchar(30), CITY varchar(30), ADDRESS varchar(30), JOIN_DATE date)

    Note the columns ID, FIRSTNAME and CITY are populated as provided and the LASTNAME, ADDRESS and JOIN DATE are null.

    Image Modified


    Expand
    titleSnowflake Bulk Load with Load empty strings property selected

    In this pipeline, the Snowflake Bulk Load Snap loads the input document with empty string values as empty strings to the string-type fields. The values to be updated are passed via the upstream Mapper Snap and the Snowflake Execute Snap displays the output view of the table records.

    Image Modified

    The Mapper Snap passes the values to be updated to the table on Snowflake:

    Image Modified

    The Snowflake Bulk Load Snap with Load empty strings property selected:

    Image Removed
    Image Added

    The Snowflake Execute Snap runs the query to select the table 'TEST BULKLOAD' for the 'ID=1002':

    Image Modified

    The successful execution of the pipeline displays the below output preview:

    Note

    The Name field is left empty. It means the empty strings are loaded as empty strings only.

    Image Modified

    The below screenshot displays the output preview (on a table with an ID=1003), wherein the Load empty strings property is not selected, and the the Name field has a value 'Null' in it:


    Image Modified



    Expand
    titleSnowflake Bulk Load Snap loads data from an Oracle Database

    In this example, the data is loaded from the table "TECTONIC"."ADOBEPRASANNA_NEW1124"  using Oracle Select Snap to the target table "PRASANNA"."ADOBEDATA123"  using Snowflake Bulk Load Snap.

    The Pipeline:

    Image Modified

    The Oracle Select Snap gets records in the table "TECTONIC"."ADOBEPRASANNA_NEW1124" and passes them to the Snowflake Bulk Load Snap: 

    Image Removed
    Image Added

    The Snowflake Bulk Load Snap loads records to table "PRASANNA"."ADOBEDATA123":

     Image Modified

    The output of the Snowflake Bulk Load Snap after executing the pipeline:Image Modified  


    Expand
    titleLoading Data from S3

    This example demonstrates how you can use the Snowflake Bulk Snap to load files from an external staging location such as S3. It further shows the configuration required when loading numeric data.

    Image Modified

    Download this Pipeline. 

    note

    The Snowflake Bulk Load Snap has a minimum of 1 Input view. This is useful when the data source is Input view. Even though, within the scope of this Pipeline, the Snap does not require any input from an upstream Snap, the view cannot be disabled. 

    Data is to be loaded from the staged file threecolumns.csv present in a S3 folder into the table "EXTR_PERF_01_SC"."THREECOLUMNS".

    Below is a screenshot of the data in threecolumns.csv:

    Image Removed
    Image Added

    The Snowflake Bulk Load Snap is configured accordingly as follows:

    Image Removed
    Image Added

    Furthermore, since this data has numeric values, the Snowflake Bulk Load Snap is configured with the following file format options to handle any string/NULL values that may be present in the dataset: 

    • SKIP_HEADER = 1: Specifies that the first row is a header row so that all rows after the first row are loaded.

    • NULL_IF = "": Convert empty spaces to SQL NULL.

    • FIELD_OPTIONALLY_ENCLOSED_BY ="": Specifies the character used to enclose strings.

    See Format Type Options for a detailed explanation of the above file format options.

    Image Removed
    Image Added

    Upon execution, the Snowflake Bulk Load Snap loads three rows:

    Image Modified

    To confirm that three rows were loaded, we use a Snowflake Execute Snap configured to count the number of rows in the target table:

    Image Removed
    Image Added

    Below is a preview of the output from the Snowflake Execute Snap. 

    Image Modified

    We can see that the count is 3, thereby confirming a successful bulk load.

    You can also modify the SELECT query in the Snowflake Execute Snap to read the data in the table and thus verify the data loaded into the target table. 

    Image Modified

    Image Modified 

    Downloads

    Multiexcerpt include macro
    namedownload_instructions
    pageOpenAPI

    Attachments
    patterns*.slp
    ,*.png

    Snap Pack History

    Expand

    Insert excerpt
    Snowflake Snap Pack
    Snowflake Snap Pack
    nameSnowflake_SPH
    nopaneltrue

    Related

    Links

    Content

  • SnapLogic Glossary
    • Getting Started with SnapLogic