SHOW CLUSTER SETTING

On this page

The SHOW CLUSTER SETTING statement displays the values of cluster settings.

To configure cluster settings, use SET CLUSTER SETTING.

Note:

The SHOW statement for cluster settings is unrelated to the other SHOW statements: SHOW {session variable}, SHOW CREATE, SHOW USERS, SHOW DATABASES, SHOW COLUMNS, SHOW GRANTS, and SHOW CONSTRAINTS.

Details

To display the value of a specific cluster setting, use the following syntax:
```
SHOW CLUSTER SETTING <setting>;
```
To display the values of public cluster settings (i.e., cluster settings that are documented and for which tuning is supported), use one of the following:
```
SHOW CLUSTER SETTINGS;
```
```
SHOW PUBLIC CLUSTER SETTINGS;
```
To display the values of all cluster settings use one of the following:
```
SHOW ALL CLUSTER SETTINGS;
```
```
SHOW CLUSTER SETTING ALL;
```
When you display all cluster settings, the table output includes a public column that denotes whether a setting is public or not.

Required privileges

To use the SHOW CLUSTER SETTING statement, a user must have one of the following attributes:

Be a member of the admin role (the root user belongs to the admin role by default).
Have the MODIFYCLUSTERSETTING system-level privilege granted.
Have the VIEWCLUSTERSETTING system-level privilege (or the legacy VIEWCLUSTERSETTING role option) defined.
Have the MODIFYSQLCLUSTERSETTING system-level privilege granted. Users with this privilege are allowed to view only sql.defaults.* cluster settings, not all cluster settings.

Synopsis

Parameters

Parameter	Description
`var_name`	The name of the cluster setting (case-insensitive).
`ALL`	Display all cluster settings.
`PUBLIC`	Display only the public cluster settings. By default, only public settings are listed by `SHOW CLUSTER SETTINGS`. `SHOW PUBLIC CLUSTER SETTINGS` and `SHOW CLUSTER SETTINGS` are equivalent.

Response

When you query multiple cluster settings (e.g., with SHOW CLUSTER SETTINGS, or with SHOW ALL CLUSTER SETTINGS), the following fields are returned:

Field	Description
`variable`	The name of the cluster setting.
`value`	The value of the cluster setting.
`setting_type`	The type of the cluster setting. Possible values for `setting_type` include: `b` (`true` or `false`) `z` (size, in bytes) `d` (duration) `e` (one of a set of possible values) `f` (floating-point value) `i` (integer) `s` (string)
`description`	A brief description of the cluster setting, including possible values.
`public`	`true` if the cluster setting is public. This field is only included if all cluster settings are displayed.
`default_value`	The default value of the cluster setting.
`origin`	The origin of the current value of the cluster setting. Possible values for `origin` include: `default` (The current value has not been changed from the default value.) `override` (The current value has been changed from the default value.)

Examples

Show the value of a single cluster setting

> SHOW CLUSTER SETTING diagnostics.reporting.enabled;

  diagnostics.reporting.enabled
---------------------------------
              true
(1 row)

Show the values of all public cluster settings

> SHOW CLUSTER SETTINGS;

                     variable                    | value | setting_type |                                                 description
-------------------------------------------------+-------+--------------+---------------------------------------------------------------------------------------------------------------
  admission.kv.enabled                           | false | b            | when true, work performed by the KV layer is subject to admission control
  admission.sql_kv_response.enabled              | false | b            | when true, work performed by the SQL layer when receiving a KV response is subject to admission control
  admission.sql_sql_response.enabled             | false | b            | when true, work performed by the SQL layer when receiving a DistSQL response is subject to admission control
  bulkio.stream_ingestion.minimum_flush_interval | 5s    | d            | the minimum timestamp between flushes; flushes may still occur if internal buffers fill up
  ...

Show the values of all cluster settings

> SHOW ALL CLUSTER SETTINGS;

                     variable                     | value | setting_type | public |                                                             description
--------------------------------------------------+-------+--------------+--------+--------------------------------------------------------------------------------------------------------------------------------------
  admission.kv.enabled                            | false | b            |  true  | when true, work performed by the KV layer is subject to admission control
  admission.kv_slot_adjuster.overload_threshold   | 32    | i            | false  | when the number of runnable goroutines per CPU is greater than this threshold, the slot adjuster considers the cpu to be overloaded
  admission.l0_file_count_overload_threshold      | 1000  | i            | false  | when the L0 file count exceeds this threshold, the store is considered overloaded
  admission.l0_sub_level_count_overload_threshold | 20    | i            | false  | when the L0 sub-level count exceeds this threshold, the store is considered overloaded
  ...

Pricing

Contact us

Sign In