Skip to content
RelationalAI Docs

relationalai.api.alter_engine_pool_node_limits()

alter_engine_pool_node_limits(
    engine_size STRING,
    min_nodes INT,
    max_nodes INT
)

A procedure that updates the Snowflake compute pool node limits used by RelationalAI (RAI) engines of the specified engine size. Each RAI engine uses one compute pool node. Adjusting these limits controls how many engines of that size can run at the same time. Requires the eng_admin application role.

Parameters

Section titled “Parameters”
NameTypeDescription
engine_sizeSTRINGThe engine size whose backing compute pool should be updated (for example, 'HIGHMEM_X64_M'). Case-insensitive. See Engine Sizes for supported sizes.
min_nodesINTThe minimum number of nodes reserved for this engine size (i.e., guaranteed concurrent engines). Raises baseline capacity and cost floor. Must be less than or equal to max_nodes. Use NULL to leave the current minimum unchanged.
max_nodesINTThe maximum number of nodes allowed for this engine size (i.e., the upper bound on concurrently running engines). Caps overall capacity and cost ceiling. Must be greater than or equal to min_nodes. Use NULL to leave the current maximum unchanged.

Returns

Section titled “Returns”

STRING — Returns “Success” on completion. If the request to update the compute pool fails, the procedure raises an error.

Example

Section titled “Example”

Update the node limits for the compute pool used by HIGHMEM_X64_S engines:

CALL relationalai.api.alter_engine_pool_node_limits('HIGHMEM_X64_S', 1, 5);
/*+---------+
  | Success |
  +---------+ */

Update only the minimum (leave maximum unchanged) for HIGHMEM_X64_S engines by passing NULL:

CALL relationalai.api.alter_engine_pool_node_limits('HIGHMEM_X64_S', 3, NULL);
/*+---------+
  | Success |
  +---------+ */

Update only the maximum (leave minimum unchanged) for HIGHMEM_X64_S engines:

CALL relationalai.api.alter_engine_pool_node_limits('HIGHMEM_X64_S', NULL, 8);
/*+---------+
  | Success |
  +---------+ */

Refer to Compute Pools to learn more about compute pools and how they relate to RAI engines.

See Also

Section titled “See Also”