The SHOW CLUSTER SETTING
statement displays the values of cluster settings.
To configure cluster settings, use SET CLUSTER SETTING
.
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;
New in v20.1: 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
Only members of the admin
role can display cluster settings. By default, the root
user belongs to the admin
role.
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:
|
description |
A brief description of the cluster setting, including possible values. |
public |
true if the cluster setting is public.This field is only included only if all cluster settings are displayed. |
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
------------------------------------+----------------+--------------+-------------------------------------------------------------------------------------------------------------------
cloudstorage.gs.default.key | | s | if set, JSON key to use during Google Cloud Storage operations
cloudstorage.http.custom_ca | | s | custom root CA (appended to system's default CAs) for verifying certificates when interacting with HTTPS storage
cloudstorage.timeout | 10m0s | d | the timeout for import/export storage operations
...
Show the values of all cluster settings
> SHOW ALL CLUSTER SETTINGS;
variable | value | setting_type | public | description
----------------------------------------+----------------+--------------+--------+-------------------------------------------------------------------------------------------------------------------
changefeed.experimental_poll_interval | 1s | d | false | polling interval for the table descriptors
cloudstorage.gs.default.key | | s | true | if set, JSON key to use during Google Cloud Storage operations
cloudstorage.http.custom_ca | | s | true | custom root CA (appended to system's default CAs) for verifying certificates when interacting with HTTPS storage
cloudstorage.timeout | 10m0s | d | true | the timeout for import/export storage operations
...