Skip to main content
The SHOW RANGES shows information about the that comprise the data for a table, index, database, or the current catalog. This information is useful for verifying how SQL data maps to underlying , and where the for those ranges are located. The statement syntax and output documented on this page use the updated SHOW RANGES that will become the default in CockroachDB v23.2. To enable this syntax and output, set the to false:
The pre-v23.1 output of SHOW RANGES is deprecated in v23.1 and will be removed in v23.2. When you use the deprecated version of the SHOW RANGES statement, the following message will appear, reminding you to update :
To show range information for a specific row in a table or index, use the statement.

Synopsis

show_ranges syntax diagram

Required privileges

To use the SHOW RANGES statement, a user must either be a member of the role (the root user belongs to the admin role by default) or have the ZONECONFIG defined.

Parameters

ParameterDescription
The name of the you want information about.
The name of the you want information about.
The name of the you want information about.
The options used to configure what fields appear in the response.

Options

The following are available to affect the output. Multiple options can be passed at once, separated by commas.
  • TABLES: List contained per .
  • INDEXES: List contained per .
  • DETAILS: Add size, and other details. Note that this incurs a large computational overhead because it needs to fetch data across nodes.
  • KEYS: Include binary start and end keys.

Response

The specific fields in the response vary depending on the values passed as options. The following fields may be returned:
FieldDescriptionEmitted for option(s)
start_keyThe start key for the .Always emitted.
end_keyThe end key for the .Always emitted.
raw_start_keyThe start key for the , displayed as a .KEYS
raw_end_keyThe end key for the , displayed as a .KEYS
range_idThe internal ID.Always emitted.
voting_replicasThe that contain the range’s voting replicas (that is, the replicas that participate in elections).Always emitted.
non_voting_replicasThe that contain the range’s .Always emitted.
replicasThe that contain the range’s .Always emitted.
replica_localitiesThe of the range’s .Always emitted.
range_sizeThe size of the in bytes.DETAILS
range_size_mbThe size of the in MiB.DETAILS
lease_holderThe that contains the range’s .DETAILS
lease_holder_localityThe of the range’s .DETAILS
learner_replicasThe learner replicas of the range. A learner replica is a replica that has just been added to a range, and is thus in an interim state. It accepts messages but doesn’t vote in elections. This means it doesn’t affect quorum and thus doesn’t affect the stability of the range, even if it’s very far behind.Always emitted.
split_enforced_untilThe time a is enforced until. This can be set using using the . Example: 2262-04-11 23:47:16.854776 (this is a default value which means “never”).Always emitted.
schema_nameThe name of the this holds data for.TABLES, INDEXES
table_nameThe name of the this holds data for.TABLES, INDEXES
table_idThe internal ID of the this holds data for.TABLES, INDEXES
table_start_keyThe start key of the first that holds data for this table.TABLES
table_end_keyThe end key of the last that holds data for this table.TABLES
raw_table_start_keyThe start key of the first that holds data for this table, expressed as .TABLES, KEYS
raw_table_end_keyThe end key of the last that holds data for this table, expressed as .TABLES, KEYS
index_nameThe name of the this holds data for.INDEXES
index_idThe internal ID of the this holds data for.INDEXES
index_start_keyThe start key of the first of data.INDEXES
index_end_keyThe end key of the last of data.INDEXES
raw_index_start_keyThe start key of the first of data, expressed as .INDEXES, KEYS
raw_index_end_keyThe end key of the last of data, expressed as .INDEXES, KEYS

Examples

The statement syntax and output documented on this page use the updated SHOW RANGES that will become the default in CockroachDB v23.2. To enable this syntax and output, set the to false:
The pre-v23.1 output of SHOW RANGES is deprecated in v23.1 and will be removed in v23.2. When you use the deprecated version of the SHOW RANGES statement, the following message will appear, reminding you to update :

Setup

The following examples use MovR, a fictional vehicle-sharing application, to demonstrate CockroachDB SQL statements. For more information about the MovR example application and dataset, see . To follow along, run with the --geo-partitioned-replicas flag. This command opens an interactive SQL shell to a temporary, 9-node in-memory cluster with the movr database.

Show ranges for a database

Show ranges for a database (without options)

Show ranges for a database (with tables, keys, details)

Show ranges for a database (with tables)

Show ranges for a database (with indexes)

Show ranges for a database (with details)

Show ranges for a database (with keys)

Show ranges for a table

Show ranges for a table (without options)

Show ranges for a table (with indexes, keys, details)

Show ranges for a table (with indexes)

Show ranges for a table (with details)

Show ranges for a table (with keys)

Show ranges for an index

Show ranges for an index (without options)

Show ranges for an index (with keys, details)

Show ranges for an index (with details)

Show ranges for an index (with keys)

See also