engines

relationalai.api

engines

A view that provides information about available RelationalAI (RAI) engines. Requires the eng_user application role.

Columns

Column	Type	Description
`NAME`	`STRING`	The name of the engine.
`ID`	`STRING`	The unique identifier of the engine.
`SIZE`	`STRING`	The size of the engine. May be one of: `S` (corresponds to `HIGHMEM_X64_S` instance family) `M` (corresponds to `HIGHMEM_X64_M` instance family) `L` (corresponds to `HIGHMEM_X64_L` instance family) `SL` (corresponds to `HIGHMEM_X64_SL` instance family) See Engine Sizes for more information.
`STATUS`	`STRING`	The current status of the engine. See Engine statuses.
`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.
`VERSION`	`STRING`	The engine version number.
`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.
`WARM_PROVISION`	`BOOLEAN`	Whether the engine was provisioned from a warm engine.

Engine statuses

Status	Description
`READY`	The reasoner is running and ready to use.
`PENDING`	The reasoner is not ready yet. It might be starting, resuming, provisioning an endpoint, or finishing its configuration. Wait and check the status again.
`SUSPENDING`	The reasoner is being suspended. Wait until the status changes to `SUSPENDED`.
`SUSPENDED`	The reasoner is suspended. Call `api.resume_reasoner_async()` to resume it before use.
`UPGRADING`	The reasoner is being upgraded. Wait and check the status again before using it.
`DELETING`	The reasoner is being deleted. Wait until it no longer appears in `api.reasoners`.
`FAILED`	The reasoner’s service failed. Delete it with `api.delete_reasoner()`, then recreate it with `api.create_reasoner()`.
`GONE`	The reasoner’s service no longer exists, but its metadata remains. Delete the stale reasoner with `api.delete_reasoner()`, then recreate it with `api.create_reasoner()`.

Example

Use the api.engines view to retrieve available engines:

SELECT * FROM relationalai.api.engines;
/*+------------------------+--------------+------+-------+-----------------------+--------------------------------+-------------------------------+-----------------------------+-------------------------+-------------------+-------------------------+----------------------+----------------+
  | NAME                   | ID           | SIZE | STATUS | CREATED_BY           | CREATED_ON                     | UPDATED_ON                    | COMPUTE_POOL                | VERSION                 | AUTO_SUSPEND_MINS | SUSPENDS_AT             | AWAIT_STORAGE_VACUUM | WARM_PROVISION |
  |------------------------+--------------+------+--------+----------------------+--------------------------------+-------------------------------+-----------------------------+-------------------------|-------------------+-------------------------+----------------------|----------------+
  | CDC_MANAGED_ENGINE     | b7c1d8f9a2b3 | S    | READY  | SYSTEM               | 2024-10-27 15:22:15.500 -0700  | 2024-10-27 15:22:16.731 -0700 | RELATIONAL_AI_HIGHMEM_X64_S | 2024.10.27-e829e39d     | 0                 | NULL                    | false                | false          |
  | john_doe               | e4f5a6d7c8e9 | M    | READY  | john.doe@company.com | 2024-10-27 17:29:53.110 -0700  | 2024-10-27 17:29:54.319 -0700 | RELATIONAL_AI_CPU_X64_M     | 2024.10.27-e829e39d     | 60                | 2024-10-27 18:29:53.110 | true                 | true           |
  +------------------------+--------------+------+--------+----------------------+--------------------------------+-------------------------------+-----------------------------+-------------------------+-------------------+-------------------------+----------------------+----------------+ */

See Also