Skip to content

Commit a3e42d2

Browse files
committed
Update with wenyihu6 feedback (1)
1 parent 3484131 commit a3e42d2

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

src/current/v25.2/alter-index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Subcommand | Description |
3838
[`CONFIGURE ZONE`](#configure-zone) | [Replication Controls]({% link {{ page.version.version }}/configure-replication-zones.md %}) for an index. |
3939
[`PARTITION BY`](#partition-by) | Partition, re-partition, or un-partition an index.
4040
[`RENAME TO`](#rename-to) | Change the name of an index.
41-
[`SCATTER`](#scatter) | Redistribute leaseholders for the ranges of a table or index. |
41+
[`SCATTER`](#scatter) | Makes a best-effort attempt to redistribute replicas and leaseholders for the ranges of a table or index. Note that it does not return an error even if replicas are not moved. |
4242
[`SPLIT AT`](#split-at) | Force a [range split]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-splits) at the specified row in the index.
4343
[`UNSPLIT AT`](#unsplit-at) | Remove a range split enforcement in the index.
4444
[`VISIBILITY`](#visibility) | Set the visibility of an index between a range of `0.0` and `1.0`.
@@ -122,7 +122,9 @@ For usage, see [Synopsis](#synopsis).
122122

123123
### `SCATTER`
124124

125-
`ALTER INDEX ... SCATTER` runs a specified set of ranges for a table or index through the [replication layer]({% link {{ page.version.version }}/architecture/replication-layer.md %}) queue. If many ranges have been created recently, the replication queue may transfer some leases to other replicas to balance load across the cluster. Some leaseholders may not update as a result of this command.
125+
`ALTER INDEX ... SCATTER` runs a specified set of ranges for a table or index through the [replication layer]({% link {{ page.version.version }}/architecture/replication-layer.md %}) queue. If many ranges have been created recently, the replication queue may transfer some leases to other replicas to balance load across the cluster.
126+
127+
Note that this statement makes a best-effort attempt to redistribute replicas and leaseholders for the ranges of an index. It does not return an error even if replicas are not moved.
126128

127129
{{site.data.alerts.callout_info}}
128130
`SCATTER` has the potential to result in data movement proportional to the size of the table or index being scattered, thus taking additional time and resources to complete.

src/current/v25.2/alter-table.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Subcommand | Description | Can combine with other subcommands?
6565
[`SET {storage parameter}`](#set-storage-parameter) | Set a storage parameter on a table. | Yes
6666
[`SET LOCALITY`](#set-locality) | Set the table locality for a table in a [multi-region database]({% link {{ page.version.version }}/multiregion-overview.md %}). | No
6767
[`SET SCHEMA`](#set-schema) | Change the [schema]({% link {{ page.version.version }}/sql-name-resolution.md %}) of a table. | No
68-
[`SCATTER`](#scatter) | Redistribute leaseholders for the ranges of a table or index. | No
68+
[`SCATTER`](#scatter) | Makes a best-effort attempt to redistribute replicas and leaseholders for the ranges of a table or index. Note that it does not return an error even if replicas are not moved. | No
6969
[`SPLIT AT`](#split-at) | Force a [range split]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-splits) at the specified row in the table. | No
7070
[`UNSPLIT AT`](#unsplit-at) | Remove a range split enforcement in the table. | No
7171
[`VALIDATE CONSTRAINT`](#validate-constraint) | Check whether values in a column match a [constraint]({% link {{ page.version.version }}/constraints.md %}) on the column. | Yes
@@ -605,7 +605,9 @@ For usage, see [Synopsis](#synopsis).
605605

606606
### `SCATTER`
607607

608-
`ALTER TABLE ... SCATTER` runs a specified set of ranges for a table or index through the [replication layer]({% link {{ page.version.version }}/architecture/replication-layer.md %}) queue. If many ranges have been created recently, the replication queue may transfer some leases to other replicas to balance load across the cluster. Some leaseholders may not update as a result of this command.
608+
`ALTER TABLE ... SCATTER` runs a specified set of ranges for a table or index through the [replication layer]({% link {{ page.version.version }}/architecture/replication-layer.md %}) queue. If many ranges have been created recently, the replication queue may transfer some leases to other replicas to balance load across the cluster.
609+
610+
Note that this statement makes a best-effort attempt to redistribute replicas and leaseholders for the ranges of an index. It does not return an error even if replicas are not moved.
609611

610612
{{site.data.alerts.callout_info}}
611613
`SCATTER` has the potential to result in data movement proportional to the size of the table or index being scattered, thus taking additional time and resources to complete.

0 commit comments

Comments
 (0)