ByteHouse provides parameter management at multiple levels, supporting settings for global Param, user Param, and virtual warehouse Param to meet parameter configuration requirements for different business scenarios. This article describes how to configure and manage various types of Param.

ByteHouse currently supports settings for global Param, user Param, and virtual warehouse Param, as described below:

In ByteHouse, virtual warehouse Param requires setting the default write virtual warehouse and default virtual warehouse. This is because ByteHouse natively supports storage and calculate separation (read/write separation). By configuring the default write virtual warehouse and default virtual warehouse Param, data writing and query operations can be assigned to different virtual warehouses to achieve resource isolation and improve operational stability. This is especially suitable for production environments where both read and write workloads are busy, and for business scenarios with high requirements for real-time data writing and query response time.
In addition to supporting settings for the default virtual warehouse and default write virtual warehouse, ByteHouse also allows you to specify the required virtual warehouse during operations:

• Console SQL worksheet: Before running SQL statements in the SQL worksheet, you can select a virtual warehouse as needed. For details, see Select compute group.

• Running SQL statements in other clients: You can specify the virtual warehouse using relevant Param. Example:

  # Query level
  SELECT *
  FROM db.table
  SETTINGS virtual_warehouse='xxx';
  
  # Session level
  SET virtual_warehouse='xxx';
  

  warning

  It is recommended to set virtual warehouse parameters only at the query level or only at the session level; do not set both simultaneously.

• Before use, confirm that your engine is version v2.3 or above. You can view your current engine version on the ByteHouse console's Tenant management > basic information page.
• The following features are Beta features. To use them, submit a ticket or contact the ByteHouse team to obtain allowlist privilege.
  • Set database-level write virtual warehouse
  • Edit virtual warehouse Param
  • Copy virtual warehouse Param
  • Statistics function

Prerequisites #

Only users with SystemAdmin or AccountAdmin roles can configure write virtual warehouse.

Set default write virtual warehouse #

The default write virtual warehouse is the default write virtual warehouse for the current Environment, used as the default Resources for writing Data to the underlying storage of the Database.
The default write virtual warehouse specifies the dedicated virtual warehouse for the current Environment that is responsible for write-type Missions.
Log in to the ByteHouse Console. In Tenant management, click the Parameter settings tab. Under the Global Parameters Modules, click the edit button in the row for the default write virtual warehouse, and select the default write virtual warehouse.

Database-level write virtual warehouse settings #

ByteHouse supports configuring a dedicated write virtual warehouse for a Database. After setting a database-level write virtual warehouse for a Database, writing Data in that Database will by default use the configured virtual warehouse Resources. If not set, Data writing will by default use the default write virtual warehouse set for the current Environment.

1. Log in to the ByteHouse Console. In Tenant management, click the Parameter settings tab. Under the Global Parameters Modules, click Database Level Write Virtual Warehouse to enter the configuration page.
2. Click edit, and select the Database and its corresponding default write virtual warehouse from the dropdown list. You can click Add 1 Row to configure the corresponding default write virtual warehouse for multiple Databases.
   

   warning

   • Only one write virtual warehouse can be set for each database.
   • Frequent changes to the database-level write virtual warehouse are not recommended. This change takes about 5 minutes to take effect, and table write performance may be affected during the modification.
3. Click Save to apply the changes.
4. To delete a database-level write virtual warehouse, click the delete button in the row for the Database. After deletion, the default write virtual warehouse set for the current Environment will be used.

Statistics function settings #

Log in to the ByteHouse Console. In Tenant management, click the Parameter settings tab. Under the Global Parameters Modules, turn on or off the Statistics Info button to enable or disable this function.

Log in to the ByteHouse Console. In Tenant management, click the Parameter settings tab. Under the User Parameters Modules, click the edit button in the param row, and select the corresponding param value. Param configuration description is as follows:

• Default virtual warehouse: The default virtual warehouse is the current user's default virtual warehouse, used as the default Resources for processing SQL.
• Default database: The Database that the User connects to by default when connecting to ByteHouse.
• Language: Default language settings, supports setting to Simplified Chinese or English.

ByteHouse Support project provides OLAP and ELT types of virtual warehouse Groups and corresponding Param Templates, allowing you to select the type of virtual warehouse Group as needed and customize Params according to Business Scenarios. This not only Satisfy the optimization requirements for query performance in OLAP Analysis Scenes, but also adapts to the stability requirements for ELT Missions in batch Processing Scenes. Meanwhile, ByteHouse Support project Add to customize SQL Params to further lift SQL Run efficiency and better adapt to your Business Scenarios and optimize Data Processing experience.

prerequisites #

All Users can View virtual warehouse Params, but only Users with virtual warehouse ALL privilege can edit virtual warehouse Params and Copy virtual warehouses.
You can Log in to the ByteHouse Console, Pass Access control > User > Username > Resource privilegesPath to View virtual warehouse privilege. To obtain edit privilege for virtual warehouse Params, contact the System Administrator for Configuration.

Edit virtual warehouse Params #

ByteHouse Support project provides Fixed Param Templates for virtual warehouse Groups, supporting Configuration of virtual warehouse Params, making it convenient for Users to access and edit virtual warehouse Params at any time, lift Data warehouse performance, and Satisfy the needs of specific Business Scenarios.
In addition to Fixed Param Templates, ByteHouse Support project Add to customize SQL Params to better meet actual Business Scenarios. The Custom parameters List is maintained By ByteHouse. For the complete List of currently supported Custom parameters, please refer to Related reference: Custom parameter list. To Submit new requirements for Custom parameters, contact the ByteHouse team.
How to use

1. Log in to the ByteHouse Console, Pass Tenant management > Parameter settings > Virtual warehouse parametersPath to Entrants the Virtual warehouse parametersModules. In the virtual warehouse dropdown List, Select the virtual warehouse to edit, Input the Parameter name in the Search box, and click the Search button to Search for the Param to change.

2. Click the edit button to edit Current Value. When editing, you can refer to the Param Rangesettings. If the Parameter value you set exceeds the Value range, you will not be able to Submit or Save it.
   

3. (Optional) Add to customize SQL Params.

   1. Click the +Custom Parameters button to enter the Add Custom parameters Page.
   2. Search for the Custom parameters to Add, select the required Params, and click Add.
   3. View and edit the added custom parameter values in the virtual warehouse Parameter List.
   4. To delete a custom parameter, click the Delete button corresponding to the parameter row.

4. After confirming, click Save.

5. (Optional) Some parameters will take effect after the virtual warehouse is restarted. You can restart the virtual warehouse according to the prompt on the interface. The interface will display a prompt box containing the "Restart virtual warehouse" button. After clicking this button, the virtual warehouse state will change to "Restarting". Once the state returns to "Running", the restart is complete.
   

6. In the Parameter List on the current page, confirm that the parameter value has been updated.

Copy virtual warehouse parameters #

ByteHouse supports copying the current virtual warehouse parameters to other virtual warehouses of the same type, helping you improve configuration efficiency and consistency. After copying, the new parameters will overwrite the original parameters.

1. In the virtual warehouse parameter module, select the virtual warehouse as the source and click Copy Parameters.
2. Select the target virtual warehouse for copying parameters and click Confirm.
   
3. Switch to the target virtual warehouse and check whether the parameters were copied successfully.
4. (Optional) Some parameters will take effect after the virtual warehouse is restarted. You can restart the virtual warehouse according to the prompt on the interface. After restarting, in the target virtual warehouse Parameter List, confirm that the parameter value has been updated.
   During restart, the interface will display a prompt box containing the "Restart virtual warehouse" button. After clicking this button, the virtual warehouse state will change to "Restarting". Once the state returns to "Running", the restart is complete.

The description of custom parameters supported by ByteHouse is as follows: