Categories:: Snowpark Container Services functions

<service_name>!SPCS_WAIT_FOR¶

Waits for the Snowpark Container Services service to reach the specified state, with a timeout.

When you execute an asynchronous job, use this helper function to wait for the job to complete.
When you create a service, use this helper function to wait until the service is running.

See also:: Snowpark Container Services: Working with services

Syntax¶

<service_name>!SPCS_WAIT_FOR( <status>, <timeout_sec> );

Copy

Arguments¶

Required arguments

'status': Status to wait for. For a list of service status values, see the output section of the DESCRIBE SERVICE command.
timeout_sec: The maximum duration, in seconds, to wait for the specified status. If specified status isn’t reached within the timeout, the function returns an error message that includes the current service status.

Returns¶

If the service doesn’t reach the specified status within the timeout or Snowflake determines that the status can never be reached, the function returns an error message that also provides the current service status. Otherwise, it returns a success message.

Access control requirements¶

A role used to execute this SQL command must have at least one of the following privileges at a minimum:

Privilege	Object	Notes
Any one of these privileges: OWNERSHIP, USAGE, MONITOR or OPERATE	Service

The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Examples¶

Wait for two minutes for the specified job to complete (job status is DONE).

CALL my_job!spcs_wait_for('DONE', 120)

Copy

Wait for three minutes for the specified service to start (service status is RUNNING).

CALL my_service!SPCS_WAIT_FOR('RUNNING', 180)

Copy