get_engine()#
relationalai.api
#get_engine(name STRING)
A procedure that gets details about the specified RelationalAI (RAI) engine.
Requires the eng_user application role.
Parameters#
| Name | Type | Description |
|---|---|---|
name | STRING | The name of the engine to retrieve details for (case-sensitive). |
Returns#
A table with the following columns:
| Column | Type | Description |
|---|---|---|
NAME | STRING | The name of the engine. |
ID | STRING | The unique identifier of the engine. |
VERSION | STRING | The version of the engine. |
SIZE | STRING | The size of the engine. May be one of:
|
STATUS | STRING | The current status of the engine. May be one of:
|
CREATED_BY | STRING | The user who created the engine. |
CREATED_ON | TIMESTAMP | The timestamp when the engine was created. |
UPDATED_ON | TIMESTAMP | The timestamp when the engine was last updated. |
COMPUTE_POOL | STRING | The name of the engine’s host compute pool. |
AUTO_SUSPEND_MINS | INT | The number of minutes of inactivity before the engine is automatically suspended. If 0, the engine will never auto-suspend. |
SUSPENDS_AT | TIMESTAMP | The timestamp when the engine will auto-suspend due to inactivity. NULL if the engine is not scheduled for suspension. |
AWAIT_STORAGE_VACUUM | BOOLEAN | Whether the engine waits for garbage collection tasks to finish before suspending. |
Example#
Use the api.get_engine() procedure to retrieve details about an engine:
#-- Get details about the CDC engine. Note that if CDC is disabled, this engine may not exist.
CALL relationalai.api.get_engine('CDC_MANAGED_ENGINE');
/*+---------------------+--------------+-------------------------+------+--------+------------+-------------------------------+------------------------------ +-----------------------------+-------------------+-------------------------+----------------------+
| NAME | ID | VERSION | SIZE | STATUS | CREATED_BY | CREATED_ON | UPDATED_ON | COMPUTE_POOL | AUTO_SUSPEND_MINS | SUSPENDS_AT | AWAIT_STORAGE_VACUUM |
|---------------------+--------------+-------------------------+------+--------+------------+-------------------------------+-------------------------------+-----------------------------+-------------------+-------------------------+----------------------|
| CDC_MANAGED_ENGINE | a9d7f3b2c8e4 | 2024.10.27-e829e39d | S | READY | SYSTEM | 2024-10-27 15:22:15.500 -0700 | 2024-10-27 15:22:16.731 -0700 | RELATIONAL_AI_HIGHMEM_X64_S | 0 | NULL | false |
+---------------------+--------------+-------------------------+------+--------+------------+-------------------------------+-------------------------------+-----------------------------+-------------------+-------------------------+----------------------+ */
See Compute Resources for more information on managing engines.