relationalai.api.resume_engine()
resume_engine(name STRING)
A procedure that resumes the specified RelationalAI (RAI) engine if it is suspended and blocks until the engine is ready to accept transactions.
Requires the eng_admin
application role.
Parameters
Section titled “Parameters”Name | Type | Description |
---|---|---|
name | STRING | The name of the engine to resume (case-sensitive). |
Returns
Section titled “Returns”A table with the following columns:
Column | Type | Description |
---|---|---|
NAME | STRING | The name of the engine. |
MESSAGE | STRING | A message indicating the result of the operation. |
Example
Section titled “Example”Use the api.resume_engine()
procedure to resume a suspended engine:
-- Resume the engine 'my_rai_engine' if it is suspended.CALL relationalai.api.resume_engine('my_rai_engine');/*+-----------------+----------------------+ | NAME | MESSAGE | +-----------------+----------------------+ | my_rai_engine | resumed successfully | +-----------------+----------------------+ */
Refer to the Compute Resources guide for more information on managing engines.