Note:
Cockroach Labs supports the current stable release and two releases prior. Therefore, this version will no longer be supported after the Spring 2019 release.

The SET CLUSTER SETTING statement modifies a cluster-wide setting.

Warning:
Many cluster settings are intended for tuning CockroachDB internals. Before changing these settings, we strongly encourage you to discuss your goals with CockroachDB; otherwise, you use them at your own risk.

Required Privileges

Only the root user can modify cluster settings.

Synopsis

SET CLUSTER SETTING var_name = TO var_value DEFAULT
Note:
The SET CLUSTER SETTING statement is unrelated to the other SET TRANSACTION and SET (session variable) statements.

Parameters

Parameter Description
var_name The name of the cluster setting (case-insensitive).
var_value The value for the cluster setting.
DEFAULT Reset the cluster setting to its default value.

The RESET CLUSTER SETTING resets a cluster setting as well.

Examples

Change the Default Distributed Execution Parameter

You can configure a cluster so that new sessions automatically try to run queries in a distributed fashion:

> SET CLUSTER SETTING sql.defaults.distsql = 1;

You can also disable distributed execution for all new sessions:

> SET CLUSTER SETTING sql.defaults.distsql = 0;

Disable Automatic Diagnostic Reporting

You can opt out of automatic diagnostic reporting of usage data to Cockroach Labs using the following:

> SET CLUSTER SETTING diagnostics.reporting.enabled = false;
> SHOW CLUSTER SETTING diagnostics.reporting.enabled;
+-------------------------------+
| diagnostics.reporting.enabled |
+-------------------------------+
| false                         |
+-------------------------------+
(1 row)

Reset a Setting to Its Default Value

Tip:
You can use RESET CLUSTER SETTING to reset a cluster setting as well.
> SET CLUSTER SETTING sql.metrics.statement_details.enabled = false;
> SHOW CLUSTER SETTING sql.metrics.statement_details.enabled;
+---------------------------------------+
| sql.metrics.statement_details.enabled |
+---------------------------------------+
| false                                 |
+---------------------------------------+
(1 row)
> SET CLUSTER SETTING sql.metrics.statement_details.enabled = DEFAULT;
> SHOW CLUSTER SETTING sql.metrics.statement_details.enabled;
+---------------------------------------+
| sql.metrics.statement_details.enabled |
+---------------------------------------+
| true                                  |
+---------------------------------------+
(1 row)

See Also



Yes No