Skip to content

relationalai.api.suspend_engine()

suspend_engine(name STRING, headers OBJECT DEFAULT NULL)

A procedure that suspends the specified RelationalAI (RAI) engine if it is running. Requires the eng_admin application role.

Parameters

Name	Type	Description
`name`	`STRING`	The name of the engine to resume (case-sensitive).
`headers`	`OBJECT` or `NULL`	Specifies HTTP headers to include in the request. Pass `NULL` to use the default headers. (Default: `NULL`)

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

Use the api.suspend_engine() procedure to suspend a running engine:

-- Suspend the engine 'my_engine' if it is running.
CALL relationalai.api.suspend_engine('my_engine');
/*+-------------+------------------------+
  | NAME        | MESSAGE                |
  +-------------+------------------------+
  | my_engine   | suspended successfully |
  +-------------+------------------------+ */

See Also