Skip to main content
Server path: /snowflake-cloud-sql | Type: Application | PCID required: Yes

Tools

ToolDescription
snowflake_cloud_sql_cancel_statementCancels the execution of a statement.
snowflake_cloud_sql_get_statement_statusChecks the status of the execution of a statement
snowflake_cloud_sql_submit_statementSubmits a SQL statement for execution.

snowflake_cloud_sql_cancel_statement

Cancels the execution of a statement. Parameters:
ParameterTypeRequiredDefaultDescription
statementHandlestringYesThe handle of the statement that you want to use (e.g. to fetch the result set or cancel execution).
requestIdstringNoUnique ID of the API request. This ensures that the execution is idempotent. If not specified, a new UUID is generated and assigned.

snowflake_cloud_sql_get_statement_status

Checks the status of the execution of a statement Parameters:
ParameterTypeRequiredDefaultDescription
statementHandlestringYesThe handle of the statement that you want to use (e.g. to fetch the result set or cancel execution).
requestIdstringNoUnique ID of the API request. This ensures that the execution is idempotent. If not specified, a new UUID is generated and assigned.
partitionintegerNoNumber of the partition of results to return. The number can range from 0 to the total number of partitions minus 1.

snowflake_cloud_sql_submit_statement

Submits a SQL statement for execution. Parameters:
ParameterTypeRequiredDefaultDescription
requestIdstringNoUnique ID of the API request. This ensures that the execution is idempotent. If not specified, a new UUID is generated and assigned.
asyncbooleanNoSet to true to execute the statement asynchronously and return the statement handle. If the parameter is not specified or is set to false, a statement is executed and the first result is returned if the execution is completed in 45 seconds. If the statement execution takes longer to complete, the statement handle is returned.
nullablebooleanNoSet to true to execute the statement to generate the result set including null. If the parameter is set to false, the result set value null will be replaced with a string ‘null’.
bindingsobjectNoValues of bind variables in the SQL statement. When executing the statement, Snowflake replaces placeholders (’?’ and ‘:name’) in the statement with these specified values.
databasestringNoDatabase in which the statement should be executed. The value in this field is case-sensitive.
parametersobjectNoSession parameters that should be set before executing the statement.
rolestringNoRole to use when executing the statement. The value in this field is case-sensitive.
schemastringNoSchema in which the statement should be executed. The value in this field is case-sensitive.
statementstringYesSQL statement or batch of SQL statements to execute. You can specify query, DML and DDL statements. The following statements are not supported: PUT, GET, USE, ALTER SESSION, BEGIN, COMMIT, ROLLBACK, statements that set session variables, and statements that create temporary tables and stages.
timeoutintegerNoTimeout in seconds for statement execution. If the execution of a statement takes longer than the specified timeout, the execution is automatically canceled. To set the timeout to the maximum value (604800 seconds), set timeout to 0.
warehousestringNoWarehouse to use when executing the statement. The value in this field is case-sensitive.