Reference and syntax for the ALTER ENGINE command.
Modify the configuration of an existing Firebolt engine.
Updates the configuration of the specified engine.
Parameter | Description |
---|---|
<engine_name> | The name of the engine to be altered. |
AUTO_START = <true/false> | When set to TRUE , sending a query to a stopped engine will automatically start the engine before processing the query. |
AUTO_STOP = <minutes> | Specifies the number of minutes after which an engine automatically stops. Setting minutes to 0 disables AUTO_STOP . |
AUTO_VACUUM = <on/off> | When on , the engine will automatically assess the health of tables’ data layout after processing a DML operation, and will run the VACUUM command when necessary to maintain the underlying table health. |
DEFAULT_DATABASE = <database_name> | Specifies the default database that an engine will attempt to use when processing queries that require a database. To remove the default database, set DEFAULT_DATABASE=default . |
CLUSTERS = <clusters> (deprecated) | Specifies the number of clusters in an engine. Each cluster is a group of nodes, and all clusters within an engine are identical in terms of node type and number of nodes. |
MIN_CLUSTERS = <clusters> | Specifies a minimum number of clusters in an engine. If MIN_CLUSTERS is different from MAX_CLUSTERS , the engine will automatically change the number of clusters depending on load. If not specified, 1 is used as default. |
MAX_CLUSTERS = <clusters> | Specifies a maximum number of clusters in an engine. If MIN_CLUSTERS is different from MAX_CLUSTERS , the engine will automatically change the number of clusters depending on load. If not specified, 1 is used as default. |
NODES = <nodes> | Specifies the number of nodes in each cluster within an engine. You can specify any integer between 1 to 128 , inclusive. |
TYPE =<type> | Specifies the node type for the engine. You can choose S , M , L , or XL . |
FAMILY =<family> | Defines the family of node used in the engine. Options include STORAGE_OPTIMIZED (alias SO ) or COMPUTE_OPTIMIZED (alias CO ). |
Limitations:
If you would like to remove the following limitations, reach out to Firebolt support at support@firebolt.io to do the following:
The following code example scales out, or increases the number of nodes, in an engine by setting the engine’s NODES
to 3
:
The following code example scales up an engine by increasing its capacity from small (S
) to large (L
) by setting the engine’s TYPE
parameter to L
:
The following code example changes engine’s family type to compute-optimized by setting the engine’s FAMILY
parameter to CO
:
The following code example both scales up and scales out an engine by increasing node capacity and the number of nodes:
If you need to use a large or extra-large engine, reach out to support@firebolt.io.
The following code example adjusts the maximum number of engine clusters to enable concurrency auto-scaling:
Renames an engine.
Parameter | Description |
---|---|
<engine_name> | The name of the engine to rename. |
<new_engine_name> | The new name of the engine. |
Changes the owner of an engine. You can view the current owner in the the engine_owner
column of the information_schema.engines
view.
For more information, see ownership.
Parameter | Description |
---|---|
<engine_name> | The name of the engine to change the owner of. |
<user> | The new owner of the engine. |