Snowflake stores data in databases and schemas and uses virtual warehouses to run queries. Sim connects over the SQL API with a programmatic access token.
Use the block to execute SQL, synchronize rows, move staged data, manage warehouses and tasks, and inspect history. To unload a query result, first materialize it as a view or with CREATE TABLE AS SELECT.
Cortex Analyst. Ask Cortex Analyst turns a plain-English question into SQL against a semantic view or semantic model, and can run that SQL to return rows. Pass the returned conversation back as history to ask follow-up questions, and start a new conversation after a handful of turns, since Snowflake reprocesses the whole history on every question. Before you use it:
- The access token's role needs the
SNOWFLAKE.CORTEX_USERorSNOWFLAKE.CORTEX_ANALYST_USERdatabase role,SELECTon the tables behind the semantic view, and read access to the stage when the model is a staged YAML file. - Cortex Analyst always answers under the access token's role. The block's execution role, warehouse, and row limit apply only when it runs the generated SQL.
- Cortex Analyst runs natively in a limited set of cloud regions. Other accounts need cross-region inference turned on.
- Snowflake bills each successful answer, and running the SQL uses warehouse credits on top.
- Snowflake now recommends Cortex Agents for new builds; Cortex Analyst remains available.
Connection guides: Programmatic access tokens.
Use the block
Connect with a Snowflake programmatic access token to execute SQL, synchronize structured rows, load and unload staged data, browse databases and schemas, size and control warehouses, run and schedule tasks, review query and load history, inspect schemas, and call stored procedures. Ask Cortex Analyst questions in natural language against a semantic view or model to get generated SQL and, optionally, its results, with multi-turn follow-ups.
Actions
Snowflake Execute SQL
Execute one parameterized SQL statement through the Snowflake SQL API.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
maxRows | number | No | Maximum result rows; defaults to 1000 with a Sim safety limit of 10000 |
database | string | No | Database context for this statement |
schema | string | No | Schema context for this statement |
statement | string | Yes | One Snowflake SQL statement to execute |
bindings | json | No | Snowflake bindings keyed by 1-based position, each with type and string value |
async | boolean | No | Return immediately with a statement handle |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Get Statement
Check a running or completed statement and retrieve exactly one result partition. Canceled or failed statements are returned as errors.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
statementHandle | string | Yes | Statement handle returned by Snowflake |
partition | number | No | Zero-based result partition to retrieve; defaults to 0 |
partitionCount | number | No | Total number of result partitions, taken from the partitionCount of the first partition. Snowflake omits metadata from every later partition response, so supply this when fetching partition 1 or higher to keep truncated and nextPartition accurate |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Cancel Statement
Cancel a running Snowflake SQL API statement.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
statementHandle | string | Yes | Statement handle returned by Snowflake |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Insert Rows
Insert structured JSON rows using bound values.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
table | string | Yes | Target Snowflake table name within the selected database and schema context |
rows | json | Yes | Non-empty JSON array of row objects with matching keys. For bulk loads, stage the files and use Load Data instead. |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Update Rows
Update matching rows with a bound MERGE statement without inserting new rows.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
table | string | Yes | Target Snowflake table name within the selected database and schema context |
rows | json | Yes | Non-empty JSON array of row objects with matching keys. For bulk loads, stage the files and use Load Data instead. |
matchColumns | array | Yes | Columns used to match target rows. Match values must be non-null and unique across the submitted rows. |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Upsert Rows
Update matching rows and insert unmatched rows with a bound MERGE statement.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
table | string | Yes | Target Snowflake table name within the selected database and schema context |
rows | json | Yes | Non-empty JSON array of row objects with matching keys. For bulk loads, stage the files and use Load Data instead. |
matchColumns | array | Yes | Columns used to match target rows. Match values must be non-null and unique across the submitted rows. |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Delete Rows
Delete rows matching a required set of bound column filters.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
table | string | Yes | Target Snowflake table name within the selected database and schema context |
filters | json | Yes | Non-empty JSON object of column filters combined with AND. A null value matches rows where that column IS NULL; every other value is compared for equality against a bound parameter. |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Load Data
Load files from an existing Snowflake stage with COPY INTO.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
maxRows | number | No | Maximum result rows; defaults to 1000 with a Sim safety limit of 10000 |
database | string | Yes | Target database name |
schema | string | Yes | Target schema name |
table | string | Yes | Target table name |
stagePath | string | Yes | Existing stage path, for example @my_stage/path |
fileFormat | string | No | Optional named file format |
pattern | string | No | Optional regular expression used to select staged files |
onError | string | No | COPY error handling: ABORT_STATEMENT, CONTINUE, SKIP_FILE, SKIP_FILE_<count>, or SKIP_FILE_<percent>% |
purge | boolean | No | Remove successfully loaded files from the stage |
force | boolean | No | Reload files even when Snowflake has loaded them before |
matchByColumnName | string | No | CASE_SENSITIVE, CASE_INSENSITIVE, or NONE |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Unload Data
Export a Snowflake table to files in a stage with COPY INTO.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
maxRows | number | No | Maximum result rows; defaults to 1000 with a Sim safety limit of 10000 |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
stagePath | string | Yes | Destination stage reference, for example @EXPORTS/daily |
table | string | Yes | Source table to unload. To export a query result, materialize it first as a view or with CREATE TABLE AS SELECT, then unload that |
fileFormat | string | No | Named file format applied to the unloaded files |
header | boolean | No | Whether to write column headings into the unloaded files; supported for CSV and Parquet only |
overwrite | boolean | No | Whether to replace existing files with matching names in the stage |
singleFile | boolean | No | Whether to write one file instead of splitting the output across files |
maxFileSizeBytes | number | No | Upper size limit per unloaded file in bytes; Snowflake defaults to 16777216 (16 MB) and allows up to 5368709120 (5 GB) |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake List Databases
List the databases the credential can access.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
nameLike | string | No | Optional SQL LIKE pattern for object names |
limit | number | No | Maximum rows, from 1 to 10000 |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake List Schemas
List the schemas in a Snowflake database.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
database | string | Yes | Database name |
nameLike | string | No | Optional SQL LIKE pattern for object names |
limit | number | No | Maximum rows, from 1 to 10000 |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake List Tables
List the tables in a Snowflake schema.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
nameLike | string | No | Optional SQL LIKE pattern for object names |
limit | number | No | Maximum rows, from 1 to 10000 |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake List Warehouses
List warehouses visible to the active Snowflake role.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
maxRows | number | No | Maximum result rows; defaults to 1000 with a Sim safety limit of 10000 |
nameLike | string | No | Optional SQL LIKE pattern for warehouse names |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Get Warehouse
Get the full details for a Snowflake virtual warehouse.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouseName | string | Yes | Warehouse name |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Resume Warehouse
Resume a Snowflake virtual warehouse if it is suspended.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouseName | string | Yes | Warehouse name |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Suspend Warehouse
Suspend a Snowflake virtual warehouse.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouseName | string | Yes | Warehouse name |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Alter Warehouse
Resize a Snowflake warehouse or change its auto-suspend and auto-resume settings.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouseName | string | Yes | Warehouse name |
warehouseSize | string | No | New warehouse size, one of XSMALL, SMALL, MEDIUM, LARGE, XLARGE, XXLARGE, XXXLARGE, X4LARGE, X5LARGE, X6LARGE |
autoSuspendSeconds | number | No | Seconds of inactivity before the warehouse suspends. Snowflake polls every 30 seconds, so values under 30 or not a multiple of 30 may not behave as expected. 0 means the warehouse never suspends and keeps consuming credits |
autoResume | boolean | No | Whether the warehouse resumes automatically when a statement is submitted |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake List Tasks
List tasks in a Snowflake schema.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
nameLike | string | No | Optional SQL LIKE pattern for task names |
limit | number | No | Maximum task rows, from 1 to 10000 |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Get Task
Describe a Snowflake task.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
taskName | string | Yes | Task name |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Run Task
Run a Snowflake task immediately, optionally retrying its last failed graph.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
taskName | string | Yes | Task name |
retryLast | boolean | No | Retry the last failed task graph run |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Resume Task
Resume a suspended Snowflake task so its schedule runs again.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
taskName | string | Yes | Task name without a database or schema prefix |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Suspend Task
Suspend a Snowflake task so its schedule stops triggering runs.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
taskName | string | Yes | Task name without a database or schema prefix |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake List Task Runs
Query up to seven days of Snowflake task history, capped at 10000 rows.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
taskName | string | No | Optional task name filter. TASK_HISTORY supports only non-qualified task names, so pass DAILY_LOAD rather than DB.SCHEMA.DAILY_LOAD |
startTime | string | No | Optional scheduled-time range start as an ISO timestamp within the last seven days |
endTime | string | No | Optional scheduled-time range end as an ISO timestamp within the last seven days |
errorOnly | boolean | No | Return only task runs that failed or were cancelled |
limit | number | No | Maximum task runs, from 1 to 10000 |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Get Task Run
Find one task history record by query ID within Snowflake’s seven-day window and 10000 most recent records after optional filters.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
queryId | string | Yes | Task run query ID from TASK_HISTORY |
taskName | string | No | Optional task name used to narrow the 10000-record history window. TASK_HISTORY supports only non-qualified task names, so pass DAILY_LOAD rather than DB.SCHEMA.DAILY_LOAD |
startTime | string | No | Optional scheduled-time range start as an ISO timestamp within the last seven days |
endTime | string | No | Optional scheduled-time range end as an ISO timestamp within the last seven days |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Cancel Task Query
Cancel one running task query by query ID with SYSTEM$CANCEL_QUERY. Task runs already in flight are unaffected and must be cancelled individually; a cancelled child marks the task graph run failed, so downstream tasks are skipped.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
queryId | string | Yes | Query ID of the single running task query to cancel, taken from TASK_HISTORY. Cancels only that query. |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Get Task Run Output
Read a task query result with RESULT_SCAN during Snowflake’s 24-hour retention window using the task owner role.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
maxRows | number | No | Maximum result rows; defaults to 1000 with a Sim safety limit of 10000 |
queryId | string | Yes | Completed task query ID; task results require the task owner role, while manual query results require the same user |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake List Query History
List queries that completed in the last seven days, optionally filtered.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
userName | string | No | Only queries run by this user; cannot be combined with warehouseName |
warehouseName | string | No | Only queries run on this warehouse; cannot be combined with userName |
startTime | string | No | ISO-8601 start of the query completion window, within the last seven days |
endTime | string | No | ISO-8601 end of the query completion window, within the last seven days |
errorOnly | boolean | No | Whether to return only queries that failed (execution status FAILED_WITH_ERROR or FAILED_WITH_INCIDENT). Snowflake applies the limit before this filter, so it selects the failures among the most recent queries rather than the most recent failures |
limit | number | No | Maximum query rows, from 1 to 10000 |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake List Copy History
List staged-file load results for a table over the last fourteen days.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
table | string | Yes | Table whose load history to return |
startTime | string | Yes | ISO-8601 start of the load window, within the last fourteen days |
endTime | string | No | ISO-8601 end of the load window, within the last fourteen days; defaults to now |
limit | number | No | Maximum load rows, from 1 to 10000 |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Introspect Schema
Inspect table and column metadata through Snowflake INFORMATION_SCHEMA views.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
maxRows | number | No | Maximum result rows; defaults to 1000 with a Sim safety limit of 10000 |
database | string | Yes | Database containing the INFORMATION_SCHEMA views |
schema | string | No | Optional exact schema name filter |
table | string | No | Optional exact table name filter |
includeViews | boolean | No | Include views and materialized views alongside tables |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Call Procedure
Call a stored procedure with explicitly typed Snowflake bindings.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
role | string | No | Snowflake role to use for this statement |
statementTimeoutSeconds | number | No | Statement timeout in seconds; 0 uses Snowflake maximum of 604800 seconds |
warehouse | string | No | Warehouse to use for this statement; defaults to the PAT user setting |
maxRows | number | No | Maximum result rows; defaults to 1000 with a Sim safety limit of 10000 |
database | string | Yes | Database name |
schema | string | Yes | Schema name |
procedureName | string | Yes | Stored procedure name |
procedureArguments | array | No | Ordered argument bindings with a Snowflake type and string value |
Output
| Parameter | Type | Description |
|---|---|---|
statementHandle | string | Snowflake statement handle |
status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
message | string | Snowflake response message |
result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Cortex Analyst Ask
Ask Snowflake Cortex Analyst a question in natural language against a semantic view or semantic model. Returns its interpretation and the generated SQL, or suggested questions when the question is ambiguous, and can run the SQL to return rows. Pass the returned conversation as history to ask a follow-up.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
question | string | Yes | The question to ask about your data |
semanticView | string | No | Fully qualified semantic view name (for example MY_DB.MY_SCHEMA.MY_VIEW). Provide exactly one semantic source. |
semanticModelFile | string | No | Stage path to a semantic model YAML file (for example @MY_DB.MY_SCHEMA.MY_STAGE/model.yaml). Provide exactly one semantic source. |
semanticModel | string | No | Full semantic model YAML. Provide exactly one semantic source. |
semanticModels | json | No | Several semantic sources for Cortex Analyst to choose between, as a JSON array of {"semantic_view": "..."} or {"semantic_model_file": "@..."} objects. Provide exactly one semantic source. |
history | json | No | Earlier conversation messages in order, as returned in the conversation output of a previous ask |
executeSql | boolean | No | Run the generated SQL with the same credential and return the result rows |
warehouse | string | No | Warehouse for running the generated SQL; defaults to the PAT user setting |
role | string | No | Snowflake role for running the generated SQL. Cortex Analyst itself always answers under the access token role |
maxRows | number | No | Maximum result rows when running the SQL; defaults to 1000 (Sim limit 10000) |
statementTimeoutSeconds | number | No | Timeout in seconds for running the SQL; 0 uses the Snowflake maximum |
Output
| Parameter | Type | Description |
|---|---|---|
requestId | string | Cortex Analyst request ID, used to send feedback on this answer |
text | string | How Cortex Analyst interpreted the question, or why it could not answer it (text content joined in order) |
sql | string | SQL Cortex Analyst generated, or null when the question was ambiguous |
verifiedQuery | object | Verified Query Repository entry used to generate the SQL, or null when none was used |
↳ name | string | Verified query name |
↳ question | string | Question the verified query answers |
↳ sql | string | SQL of the verified query |
↳ verifiedAt | number | When the query was last verified (Unix epoch seconds, UTC) |
↳ verifiedBy | string | Who verified the query |
suggestions | array | Questions the semantic model can answer, returned instead of SQL when the question was ambiguous |
warnings | array | Warnings Cortex Analyst raised about the request |
questionCategory | string | How Cortex Analyst categorized the question (for example CLEAR_SQL) |
modelNames | array | Models used to generate the response |
semanticModelSelection | object | Which semantic source Cortex Analyst chose when several were given, or null for a single source |
↳ index | number | Zero-based position of the chosen source in Semantic Sources |
↳ semanticView | string | Chosen semantic view |
↳ semanticModelFile | string | Chosen staged semantic model file |
↳ inlineSemanticModel | string | Chosen inline semantic model YAML |
cortexSearchRetrieval | json | Entities Cortex Analyst resolved with Cortex Search ([{service, query, response_body}]), passed through as returned |
conversation | array | Full conversation including this question and answer (analyst turns keep their text and SQL); pass it as History to ask a follow-up. Snowflake recommends starting a new conversation after many turns |
↳ role | string | user or analyst |
↳ content | array | Message content blocks (text, sql, suggestions) |
execution | object | Result of running the generated SQL when Run Generated SQL is on, otherwise null. A query still running after 45 seconds returns status RUNNING with a statementHandle; fetch its rows with Get Statement |
↳ statementHandle | string | Snowflake statement handle |
↳ status | string | Statement status: SUCCEEDED, RUNNING, or CANCELED |
↳ message | string | Snowflake response message |
↳ result | object | Completed result partition, or null while running or when no result is available |
↳ columns | array | Documented Snowflake result column metadata, or null when Snowflake returned a metadata-less partition response |
↳ name | string | Column name |
↳ type | string | Snowflake data type |
↳ length | number | Column length |
↳ precision | number | Numeric precision |
↳ scale | number | Numeric scale |
↳ nullable | boolean | Whether the column is nullable |
↳ rows | array | One complete Snowflake result partition as string or null arrays |
↳ totalRows | number | Total result rows |
↳ currentPartition | number | Zero-based partition returned |
↳ partitionCount | number | Total partitions in the result set. Snowflake reports this only on the first partition, so pass it back to Get Statement when fetching later partitions |
↳ nextPartition | number | Next partition to request with Get Statement, if one exists |
↳ truncated | boolean | Whether more result partitions remain to fetch with Get Statement, or null when Snowflake returned a metadata-less partition response and partitionCount was not supplied. Snowflake does not report when the requested row limit capped the result set, so that cap is never reflected here |
↳ dml | object | Completed DML statistics, or null when the statement has no DML statistics |
↳ rowsInserted | number | Rows inserted by the statement |
↳ rowsUpdated | number | Rows updated by the statement |
↳ rowsDeleted | number | Rows deleted by the statement |
↳ duplicateRowsUpdated | number | Duplicate rows updated by the statement |
↳ rowsAffected | number | Total inserted, updated, and deleted rows |
Snowflake Cortex Analyst Feedback
Rate a Cortex Analyst answer thumbs up or down, with an optional comment. Feedback appears in the Snowsight Cortex Analyst monitoring tab.
Inputs and outputs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | Yes | Snowflake credential (account host and programmatic access token) |
requestId | string | Yes | Request ID returned by Cortex Analyst Ask |
positive | boolean | Yes | true for positive (thumbs up) feedback, false for negative (thumbs down) |
feedbackMessage | string | No | Optional feedback comment |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether the feedback was recorded |