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.

NameTypeDescription
nameSTRINGThe name of the engine to resume (case-sensitive).
headersOBJECT or NULLSpecifies HTTP headers to include in the request. Pass NULL to use the default headers. (Default: NULL)

A table with the following columns:

ColumnTypeDescription
NAMESTRINGThe name of the engine.
MESSAGESTRINGA message indicating the result of the operation.

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 |
+-------------+------------------------+ */