Snowflake - Snowpipe Operation

Tools

Description

Use this tool to perform Snowpipe operations using the Snowpipe REST API.

Parameters

Parameter Mandatory Description

Parameter	Mandatory	Description
Name	True	Name given to the tool.
Snowpipe Name	True	Valid Snowpipe name for which you want to execute the Snowipipe API call.
File Names	True	Name of the file to ingest. Mutliple file names can be separated by the pipe character '\|'.
Operation	True	Type of operation to execute. Possible options are: ingestData: Sends an API request to the selected snowpipe to ingest the files provided in in the File Names parameter. The files have to be first dropped on the stage used by the Snowpipe. getStatusReport: Checks the status report for the listed files and depending on the Report Publication and Report Processing parameters, either returns it or processes it. If the files are not processed in enough time, the tool throws a timeout exception. The default is two and a half minutes, but you can modify the delay in the Report Timeout parameter.
Scripting Connection	True	Scripting connection that should be used by the scripting ations.
XPath Expression for Snowflake	True	Valid XPath expression used to reference the Snowflake metadata to use as target. This expression can return any node of a Snowflake metadata.
Report Publication	True	Only applies to the getStatusReport operation. Determines how to publish the API response. Possible options are: * sessionVariable: The status report is published as a sessionVariable: `SNOWPIPE_API_RESPONSE` * disable: The status is not published.
Report Processing	True	Only applies to the getStatusReport operation. Determines how to process the report. Possible options are: * Do not parse the report: There will be no processing of the report. * Throw an error when the report contains loading failures: The tool raises an exception when at least one file from the list is not correctly ingested. The exception contains the error details regarding the file(s) that were not processed.
Report Timeout	150000	How much time to wait for an operation to finish before stopping with an error. The value is defined in milliseconds, and the default is two and a half minutes.

Name

True

Name given to the tool.

Snowpipe Name

True

Valid Snowpipe name for which you want to execute the Snowipipe API call.

File Names

True

Name of the file to ingest. Mutliple file names can be separated by the pipe character '|'.

Operation

True

Type of operation to execute. Possible options are:

ingestData: Sends an API request to the selected snowpipe to ingest the files provided in in the File Names parameter. The files have to be first dropped on the stage used by the Snowpipe.
getStatusReport: Checks the status report for the listed files and depending on the Report Publication and Report Processing parameters, either returns it or processes it.

If the files are not processed in enough time, the tool throws a timeout exception. The default is two and a half minutes, but you can modify the delay in the Report Timeout parameter.

Scripting Connection

True

Scripting connection that should be used by the scripting ations.

XPath Expression for Snowflake

True

Valid XPath expression used to reference the Snowflake metadata to use as target.

This expression can return any node of a Snowflake metadata.

Report Publication

True

Only applies to the getStatusReport operation.

Determines how to publish the API response. Possible options are:

* sessionVariable: The status report is published as a sessionVariable: SNOWPIPE_API_RESPONSE

* disable: The status is not published.

Report Processing

True

Only applies to the getStatusReport operation.

Determines how to process the report. Possible options are:

* Do not parse the report: There will be no processing of the report.

* Throw an error when the report contains loading failures: The tool raises an exception when at least one file from the list is not correctly ingested. The exception contains the error details regarding the file(s) that were not processed.

Report Timeout

150000

How much time to wait for an operation to finish before stopping with an error. The value is defined in milliseconds, and the default is two and a half minutes.