Skip to content

Commit 8fc6e2c

Browse files
committed
Merge remote-tracking branch 'origin/main' into DOC-11497
2 parents 57fa244 + c215fbd commit 8fc6e2c

26 files changed

+56
-36
lines changed

src/current/_data/versions.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ v23.2,2024-02-05,2025-02-05,2025-08-05,23.2.6,23.2.7,2024-07-08,2025-07-08,2026-
1616
v24.1,2024-05-20,2025-05-20,2025-11-20,24.1.5,24.1.6,2024-10-21,2025-10-21,2026-10-21,v23.2,release-24.1,N/A
1717
v24.2,2024-08-12,2025-02-12,N/A,N/A,N/A,N/A,N/A,N/A,v24.1,release-24.2,2028-08-12
1818
v24.3,2024-11-18,2025-11-18,2026-05-18,24.3.11,24.3.12,2025-05-05,2026-05-05,2027-05-05,v24.2,release-24.3,N/A
19-
v25.1,2025-02-18,2026-08-18,N/A,N/A,N/A,N/A,N/A,N/A,v24.3,release-25.1,N/A
19+
v25.1,2025-02-18,2025-08-18,N/A,N/A,N/A,N/A,N/A,N/A,v24.3,release-25.1,N/A
2020
v25.2,2025-05-09,2026-05-12,2026-11-12,N/A,N/A,N/A,N/A,N/A,v25.1,release-25.2,N/A

src/current/_includes/v23.2/sql/disallow-full-table-scans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- At the cluster level, set `disallow_full_table_scans` for some or all users and roles. For example:
1+
- At the cluster level, set `disallow_full_table_scans` for some or [all users and roles]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users). For example:
22

33
{% include_cached copy-clipboard.html %}
44
~~~ sql

src/current/_includes/v23.2/sql/transactions-limit-rows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- When the `transaction_rows_read_err` [session setting]({% link {{ page.version.version }}/set-vars.md %}#transaction-rows-read-err) is enabled, transactions that read more than the specified number of rows will fail. In addition, the [optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}) will not create query plans with scans that exceed the specified row limit. For example, to set a default value for all users at the cluster level:
1+
- When the `transaction_rows_read_err` [session setting]({% link {{ page.version.version }}/set-vars.md %}#transaction-rows-read-err) is enabled, transactions that read more than the specified number of rows will fail. In addition, the [optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}) will not create query plans with scans that exceed the specified row limit. For example, to set a default value for [all users]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users) at the cluster level:
22

33
{% include_cached copy-clipboard.html %}
44
~~~ sql

src/current/_includes/v24.1/known-limitations/grant-revoke-schema-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ When this session variable is enabled, any user/role management operations issue
1111
To accelerate user/role management operations across your entire application, you have the following options:
1212

1313
1. Set the session variable in all sessions by [passing it in the client connection string]({% link {{ page.version.version }}/connection-parameters.md %}#supported-options-parameters).
14-
1. Apply the `allow_role_memberships_to_change_during_transaction` setting globally to an entire cluster using the [`ALTER ROLE ALL`]({% link {{ page.version.version }}/alter-role.md %}) statement:
14+
1. Apply the `allow_role_memberships_to_change_during_transaction` setting globally to an entire cluster using the [`ALTER ROLE ALL`]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users) statement:
1515

1616
{% include_cached copy-clipboard.html %}
1717
~~~ sql

src/current/_includes/v24.1/sql/disallow-full-table-scans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- At the cluster level, set `disallow_full_table_scans` for some or all users and roles. For example:
1+
- At the cluster level, set `disallow_full_table_scans` for some or [all users and roles]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users). For example:
22

33
{% include_cached copy-clipboard.html %}
44
~~~ sql

src/current/_includes/v24.1/sql/transactions-limit-rows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- When the `transaction_rows_read_err` [session setting]({% link {{ page.version.version }}/set-vars.md %}#transaction-rows-read-err) is enabled, transactions that read more than the specified number of rows will fail. In addition, the [optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}) will not create query plans with scans that exceed the specified row limit. For example, to set a default value for all users at the cluster level:
1+
- When the `transaction_rows_read_err` [session setting]({% link {{ page.version.version }}/set-vars.md %}#transaction-rows-read-err) is enabled, transactions that read more than the specified number of rows will fail. In addition, the [optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}) will not create query plans with scans that exceed the specified row limit. For example, to set a default value for [all users]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users) at the cluster level:
22

33
{% include_cached copy-clipboard.html %}
44
~~~ sql

src/current/_includes/v24.3/known-limitations/grant-revoke-schema-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ When this session variable is enabled, any user/role management operations issue
1111
To accelerate user/role management operations across your entire application, you have the following options:
1212

1313
1. Set the session variable in all sessions by [passing it in the client connection string]({% link {{ page.version.version }}/connection-parameters.md %}#supported-options-parameters).
14-
1. Apply the `allow_role_memberships_to_change_during_transaction` setting globally to an entire cluster using the [`ALTER ROLE ALL`]({% link {{ page.version.version }}/alter-role.md %}) statement:
14+
1. Apply the `allow_role_memberships_to_change_during_transaction` setting globally to an entire cluster using the [`ALTER ROLE ALL`]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users) statement:
1515

1616
{% include_cached copy-clipboard.html %}
1717
~~~ sql

src/current/_includes/v24.3/sql/disallow-full-table-scans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- At the cluster level, set `disallow_full_table_scans` for some or all users and roles. For example:
1+
- At the cluster level, set `disallow_full_table_scans` for some or [all users and roles]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users). For example:
22

33
{% include_cached copy-clipboard.html %}
44
~~~ sql

src/current/_includes/v24.3/sql/transactions-limit-rows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- When the `transaction_rows_read_err` [session setting]({% link {{ page.version.version }}/set-vars.md %}#transaction-rows-read-err) is enabled, transactions that read more than the specified number of rows will fail. In addition, the [optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}) will not create query plans with scans that exceed the specified row limit. For example, to set a default value for all users at the cluster level:
1+
- When the `transaction_rows_read_err` [session setting]({% link {{ page.version.version }}/set-vars.md %}#transaction-rows-read-err) is enabled, transactions that read more than the specified number of rows will fail. In addition, the [optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}) will not create query plans with scans that exceed the specified row limit. For example, to set a default value for [all users]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users) at the cluster level:
22

33
{% include_cached copy-clipboard.html %}
44
~~~ sql

src/current/_includes/v25.1/known-limitations/grant-revoke-schema-changes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ When this session variable is enabled, any user/role management operations issue
1111
To accelerate user/role management operations across your entire application, you have the following options:
1212

1313
1. Set the session variable in all sessions by [passing it in the client connection string]({% link {{ page.version.version }}/connection-parameters.md %}#supported-options-parameters).
14-
1. Apply the `allow_role_memberships_to_change_during_transaction` setting globally to an entire cluster using the [`ALTER ROLE ALL`]({% link {{ page.version.version }}/alter-role.md %}) statement:
14+
1. Apply the `allow_role_memberships_to_change_during_transaction` setting globally to an entire cluster using the [`ALTER ROLE ALL`]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users) statement:
1515

1616
{% include_cached copy-clipboard.html %}
1717
~~~ sql

src/current/_includes/v25.1/misc/session-vars.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
|---|---|---|---|---|
33
| <a id="always-distribute-full-scans"></a> `always_distribute_full_scans` | **New in v25.1:** When set to `on`, full table scans are always [distributed]({% link {{ page.version.version }}/architecture/sql-layer.md %}#distsql). | `off` | Yes | Yes |
44
| <a id="application-name"></a> `application_name` | The current application name for statistics collection. | Empty string, or `cockroach` for sessions from the [built-in SQL client]({% link {{ page.version.version }}/cockroach-sql.md %}). | Yes | Yes |
5-
| <a id="autocommit-before-ddl"></a> `autocommit_before_ddl` | When the [`autocommit_before_ddl` session setting]({% link {{page.version.version}}/set-vars.md %}#autocommit-before-ddl) is set to `on`, any schema change statement that is sent during an [explicit transaction]({% link {{page.version.version}}/transactions.md %}) will cause the transaction to [commit]({% link {{page.version.version}}/commit-transaction.md %}) before executing the schema change. This is useful because [CockroachDB does not fully support multiple schema changes in a single transaction]({% link {{ page.version.version }}/online-schema-changes.md %}#schema-changes-within-transactions). **New in v25.1**: This setting is enabled by default. To disable it for all [roles]({% link {{ page.version.version }}/alter-role.md %}), issue the following statement: `ALTER ROLE ALL SET autocommit_before_ddl = false` | `on` | Yes | Yes |
5+
| <a id="autocommit-before-ddl"></a> `autocommit_before_ddl` | When the [`autocommit_before_ddl` session setting]({% link {{page.version.version}}/set-vars.md %}#autocommit-before-ddl) is set to `on`, any schema change statement that is sent during an [explicit transaction]({% link {{page.version.version}}/transactions.md %}) will cause the transaction to [commit]({% link {{page.version.version}}/commit-transaction.md %}) before executing the schema change. This is useful because [CockroachDB does not fully support multiple schema changes in a single transaction]({% link {{ page.version.version }}/online-schema-changes.md %}#schema-changes-within-transactions). **New in v25.1**: This setting is enabled by default. To disable it for all [roles]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users), issue the following statement: `ALTER ROLE ALL SET autocommit_before_ddl = false` | `on` | Yes | Yes |
66
| <a id="bytea-output"></a> `bytea_output` | The [mode for conversions from `STRING` to `BYTES`]({% link {{ page.version.version }}/bytes.md %}#supported-conversions). | hex | Yes | Yes |
77
| <a id="client-min-messages"></a> `client_min_messages` | The severity level of notices displayed in the [SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}). Accepted values include `debug5`, `debug4`, `debug3`, `debug2`, `debug1`, `log`, `notice`, `warning`, and `error`. | `notice` | Yes | Yes |
88
| <a id="copy-from-atomic-enabled"></a> `copy_from_atomic_enabled` | If set to `on`, [`COPY FROM`]({% link {{ page.version.version }}/copy.md %}) statements are committed atomically, matching PostgreSQL behavior. If set to `off`, `COPY FROM` statements are segmented into batches of 100 rows unless issued within an explicit transaction, matching the CockroachDB behavior in versions prior to v22.2. | `on` | Yes | Yes |

src/current/_includes/v25.1/sql/disallow-full-table-scans.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- At the cluster level, set `disallow_full_table_scans` for some or all users and roles. For example:
1+
- At the cluster level, set `disallow_full_table_scans` for some or [all users and roles]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users). For example:
22

33
{% include_cached copy-clipboard.html %}
44
~~~ sql

src/current/_includes/v25.1/sql/transactions-limit-rows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- When the `transaction_rows_read_err` [session setting]({% link {{ page.version.version }}/set-vars.md %}#transaction-rows-read-err) is enabled, transactions that read more than the specified number of rows will fail. In addition, the [optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}) will not create query plans with scans that exceed the specified row limit. For example, to set a default value for all users at the cluster level:
1+
- When the `transaction_rows_read_err` [session setting]({% link {{ page.version.version }}/set-vars.md %}#transaction-rows-read-err) is enabled, transactions that read more than the specified number of rows will fail. In addition, the [optimizer]({% link {{ page.version.version }}/cost-based-optimizer.md %}) will not create query plans with scans that exceed the specified row limit. For example, to set a default value for [all users]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users) at the cluster level:
22

33
{% include_cached copy-clipboard.html %}
44
~~~ sql

src/current/v23.1/alter-database.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ Subcommand | Description
4444
[`OWNER TO`](#owner-to) | Change the owner of a database.
4545
[`PLACEMENT`](#placement) | Configure the replica placement policy for a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).
4646
[`RENAME TO`](#rename-to) | Change the name of a database.
47-
[`RESET {session variable}`](#reset-session-variable) | Reset the session variable values for the database to the system defaults. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... RESET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}).
48-
[`SET {session variable}`](#set-session-variable) | Set the default session variable values for the database. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... SET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}).
47+
[`RESET {session variable}`](#reset-session-variable) | Reset the session variable values for the database to the system defaults. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... RESET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users).
48+
[`SET {session variable}`](#set-session-variable) | Set the default session variable values for the database. This syntax is identical to [`ALTER ROLE ALL IN DATABASE ... SET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users).
4949
[`SET PRIMARY REGION`](#set-primary-region) | Set the primary region of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).
5050
[`SET SECONDARY REGION`](#set-secondary-region) | Set the [secondary region of a multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}#secondary-regions) for failover purposes.
5151
[`SURVIVE {ZONE,REGION} FAILURE`](#survive-zone-region-failure) | Add a survival goal to a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).
@@ -367,7 +367,7 @@ For usage, see [Synopsis](#synopsis).
367367

368368
In CockroachDB, the following are aliases for `ALTER DATABASE ... RESET {session variable}`:
369369

370-
- [`ALTER ROLE ALL IN DATABASE ... RESET {session variable}`]({% link {{ page.version.version }}/alter-role.md %})
370+
- [`ALTER ROLE ALL IN DATABASE ... RESET {session variable}`]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users)
371371

372372
### `SET {session variable}`
373373

@@ -394,6 +394,8 @@ In CockroachDB, the following are aliases for `ALTER DATABASE ... SET {session v
394394

395395
- `ALTER ROLE ALL IN DATABASE ... SET {session variable}`
396396

397+
For more information, refer to [`ALTER ROLE ALL ...`]({% link {{ page.version.version }}/alter-role.md %}#set-default-session-variable-values-for-all-users).
398+
397399
### `SET PRIMARY REGION`
398400

399401
`ALTER DATABASE .. SET PRIMARY REGION` sets the primary [region]({% link {{ page.version.version }}/multiregion-overview.md %}#database-regions) of a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}).

src/current/v23.1/alter-role.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Parameter | Description
3333
`SET {session variable}` | Set default [session variable]({% link {{ page.version.version }}/set-vars.md %}) values for a role.
3434
`RESET {session variable}`<br>`RESET ALL` <a name="parameters-reset"></a> | Reset one session variable or all session variables to the default value.
3535
`IN DATABASE database_name` | Specify a database for which to apply session variable defaults.<br>When `IN DATABASE` is not specified, the default session variable values apply for a role in all databases.<br>In order for a session to initialize session variable values to database defaults, the database must be specified as a [connection parameter]({% link {{ page.version.version }}/connection-parameters.md %}). Database default values will not appear if the database is set after connection with `USE <dbname>`/`SET database=<dbname>`.
36-
`ROLE ALL ...`/`USER ALL ...` | Apply session variable settings to all roles.<br>Exception: The `root` user is exempt from session variable settings.
36+
`ROLE ALL ...`/`USER ALL ...` | Apply session variable settings to all roles.<br>Exception: The `root` user is exempt from session variable settings. This is a failsafe; if you make a mistake with a session variable setting, you can still log in as `root` and be unaffected.
3737

3838
### Role options
3939

@@ -249,6 +249,8 @@ ALTER ROLE ALL SET sql.spatial.experimental_box2d_comparison_operators.enabled =
249249
ALTER ROLE
250250
~~~
251251

252+
The `root` user is exempt from session variable settings changes. This is a failsafe; if you make a mistake with a session variable setting, you can still log in as `root` and be unaffected.
253+
252254
{% include {{page.version.version}}/sql/sql-defaults-cluster-settings-deprecation-notice.md %}
253255

254256
## See also

0 commit comments

Comments
 (0)