Read

Security Prerequisites: You should have the following permission in your Snowflake account to execute this Snap: 

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

The following commands enable minimum privileges in the Snowflake Console:

grant usage on database <database_name> to role <role_name>;
grant usage on schema <database_name>.<schema_name>;

For more information on Snowflake privileges, refer to 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.

This Snap uses the COPY INTO command internally. It enables unloading data from a table (or query) into one or more files in one of the following locations:

• Named internal stage (or table/user stage).
• Named external stage, that references external location, such as, Amazon S3, Google Cloud Storage, or Microsoft Azure.
• External location, such as, Amazon S3, Google Cloud Storage, or Microsoft Azure.

• Works in Ultra Task Pipelines.
• 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 the storage only using the named stage or integration object. For more details: Configuring Cross Account IAM Role Support for Snowflake Snaps.

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. This Snap requires a Snowflake Account with S3 or Microsoft Azure properties. See Snowflake Account for information on setting up this type of account.
 

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

Required. Defines a SELECT query. The results of the query are unloaded. In most cases, it is worthwhile to unload data in sorted order by specifying an ORDER BY clause in the query; this approach will save the time Required. to sort the data when it is reloaded.

Example: SELECT * FROM public.company ORDER BY id

Default value: None

The staging location for the unload. The expected input for this should be a path to a file or filename-prefix.

The options available include:

• External: Location that is not managed by Snowflake. The location should be an AWS S3 Bucket or Microsoft Azure Storage blob.
• Internal: Location that is managed by Snowflake.

Default value: Internal

Required. The staging area where the unloaded file(s) are placed. If the staging location is external, it will be put under the S3 Bucket or Microsoft Azure Storage Blob specified for the Account. If the staging location is internal,  the files will be placed in the user’s home folder. 

Example: TestFolder/file_name_prefix

Default value:  None

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

Default value: None

The file format object to use for unloading data from the table. The field is valid only when the File format type is specified as Customized. Otherwise, this will be ignored.
Default value: None

If selected, the UNLOAD overwrites the existing files, if any, in the location where files are stored.

If unselected, the option does not remove the existing files or overwrite.

Default value: Not selected

If selected, the UNLOAD will generate a single file. If it is not selected, the filename prefix needs to be included in the path.

Default value: Not selected

Maximum size (in bytes) of each file to be generated in parallel per thread. The number should be greater than 0, If it is less than or equals 0, the Snap will use the default size for snowflake: 16000000 (16MB).

Default value: 0

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

Default value: No default value.

The KMS key that you want to use for S3 encryption. For more information about the KMS key, see AWS KMS Overview and Using Server Side Encryption.

Default value: No default value.

If selected, the table column heading will be included in the generated files. If multiple files are generated, the heading will be included in every file.

Default value: Not selected 

This mode is useful for visually verifying the data before unloading it. If this is NONE, validation mode is disabled or, the unloaded data will not be written to the file. Instead, it will be sent as a response to the output.

The options available include:

• NONE
• RETURN_ROWS

Default value: NONE  

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.

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