Categories:

System functions (Query Information)

SYSTEM$GET_RESULTSET_STATUS

Returns the status of a RESULTSET in a Snowflake Scripting stored procedure.

This function can be useful for getting the status an asynchronous child job that is running for a RESULTSET.

Syntax

SYSTEM$GET_RESULTSET_STATUS( <resultset_name> )

Arguments

resultset_name

The name of the RESULTSET.

Returns

This function returns the status of the RESULTSET in a value of type VARCHAR. The following status values are possible:

StatusDescription
RUNNINGThe query is still running.
SUCCESSThe query finished successfully.
ABORTINGThe query is in the process of being aborted on the server side.
FAILED_WITH_ERRORThe query finished unsuccessfully due to an error in the query.
FAILED_WITH_INCIDENTThe query finished unsuccessfully due to an incident on the server side.
ABORTEDThe query was aborted on the server side.
QUEUEDThe query is queued for execution (that is, hasn’t yet started running), typically because it is waiting for resources.
DISCONNECTEDThe session’s connection is broken. The query’s state will change to FAILED_WITH_ERROR soon.
RESUMING_WAREHOUSEThe warehouse is starting up, and the query isn’t yet running.
QUEUED_REPAIRING_WAREHOUSEThe warehouse is being repaired, and the query is queued for execution.
RESTARTEDThe query restarted.
BLOCKEDThe query is waiting on a lock held by another statement.

Usage notes

This function can only be called in a Snowflake Scripting block.

Examples

The following example calls SYSTEM$GET_RESULTSET_STATUS twice to return the status of an asynchronous child job that is running for a RESULTSET. The example calls the function while the asynchronous child job is running and after it completes.

EXECUTE IMMEDIATE $$
DECLARE
  status2 VARCHAR DEFAULT 'invalid';
BEGIN
  LET res RESULTSET := ASYNC (SELECT SYSTEM$WAIT(3));
  LET status VARCHAR := SYSTEM$GET_RESULTSET_STATUS(res);

  AWAIT res;
  status2 := SYSTEM$GET_RESULTSET_STATUS(res);
  RETURN [status, status2];
END;
$$;
+------------------+
| GET_QUERY_STATUS |
+------------------+
| [                |
|   "RUNNING",     |
|   "SUCCESS"      |
| ]                |
+------------------+