On a secure cluster, you must be an admin user to access this area of the DB Console. Refer to DB Console security.
The Databases page of the DB Console provides details of the following:
- The databases configured.
- The tables in each database and the indexes on each table.
- The grants assigned to each role and user.
- Index recommendations.
To view this page, access the DB Console and click Databases in the left-hand navigation.
Index recommendations
The Databases, table details, and index details pages show recommendations to drop indexes based on index usage. You can traverse the Databases page and Tables view to determine which indexes have recommendations.
To configure the threshold for when CockroachDB will recommend that you drop an index due to low usage, change the sql.index_recommendation.drop_unused_duration cluster setting. The default value is 7 days.
Databases
The Databases page shows:
- Whether automatic statistics collection is enabled for the cluster.
- A list of the databases on the cluster.
The following information is displayed for each database:
| Column | Description |
|---|---|
| Databases | The name of the database. |
| Size | Approximate disk size across all table replicas in the database. |
| Tables | The number of tables in the database. |
| Regions/Nodes | The regions and nodes on which the tables in the database are located. This is not displayed on a single-node cluster. On a multi-node cluster, the display of this information is controlled by the cluster setting ui.database_locality_metadata.enabled (default true). |
| Index Recommendations | The number of index recommendations for the database. |
- Select View: Tables in the pulldown menu to display the Tables view.
- Select View: Grants in the pulldown menu to display the Grants view.
ui.database_locality_metadata.enabled cluster setting
New in v24.1.8:
Retrieving extended database and table region information can cause significant CPU load on large multi-node clusters with many ranges. You can prevent the retrieval of this data and the associated CPU load by disabling the ui.database_locality_metadata.enabled cluster setting. When set to false, “No data” will be displayed for region data and replica counts. If you require this data, use the SQL statement SHOW RANGES FROM {DATABASE|TABLE} to compute this information.
Search and filter
By default, the Databases page shows all databases running on the cluster. By default, the Tables view and the Grants view show all tables in a selected database.
Search databases or tables
To search using the search field:
- Enter a string in the search box at the top of the tab. To search for exact terms in order, wrap the search string in quotes.
Press
Enter.The list of databases or tables is filtered by the string.
Filter
To filter the databases on the Databases page or tables on the Tables view or the Grants view:
- Click the Filters field.
- To filter by one or more nodes on which the data reside for the database or table, select Node and select one or more nodes.
- Click Apply.
Tables view
The Tables view shows the tables in your database.
The following information is displayed for each table:
| Column | Description |
|---|---|
| Tables | The name of the table. |
| Replication Size | The approximate disk size of all replicas of this table on the cluster. |
| Ranges | The number of ranges in the table. |
| Indexes | The number of indexes in the table. |
| Regions | The regions and nodes on which the table data is stored. This is not displayed on a single-node cluster. On a multi-node cluster, the display of this information is controlled by the cluster setting ui.database_locality_metadata.enabled (default true). |
| % of Live Data | Percent of total uncompressed logical data that has not been modified (updated or deleted). |
| Table Stats Last Updated (UTC) | The last time table statistics were created or updated. |
Click a table name to view table details.
Table details
The table details page contains details of a table. It contains an Overview tab and a Grants tab displays the users and grants associated with the table.
Overview tab
The Overview tab displays the SQL statements used to create the table, table details, and index statistics.
The table details include:
- Size: The approximate disk size of all replicas of this table on the cluster.
- Replicas: The number of replicas of this table on the cluster. On a multi-node cluster, the display of this information is controlled by the cluster setting
ui.database_locality_metadata.enabled(defaulttrue). - Ranges: The number of ranges in this table.
- % of Live Data: Percentage of total uncompressed logical data that has not been modified (updated or deleted).
Table Stats Last Updated: The last time table statistics were created or updated.
Auto Stats Collection: Whether automatic statistics collection is enabled.
Regions/Nodes: The regions and nodes on which the table data is stored. This is not displayed on a single-node cluster. On a multi-node cluster, the display of this information is controlled by the cluster setting
ui.database_locality_metadata.enabled(defaulttrue).Database: The database in which the table is found.
Indexes: The names of the indexes defined on the table.
Index details
The Index Stats table displays index statistics for a table.
Index statistics accumulate from the time an index was created or when statistics were reset. If desired, admin users may reset index statistics for the cluster by clicking Reset all index stats. This link does not appear for non-admin users.
The following information is displayed for each index:
| Column | Description |
|---|---|
| Indexes | The name of the index. |
| Total Reads | The number of times the index was read since index statistics were reset. |
| Last Used (UTC) | The time the index was created, last read, or index statistics were reset. |
| Index Recommendations | A recommendation to drop the index if it is unused. |
| Drop index button | Admin users can click this to drop an unused index. |
Click an index name to view index details. The index details page displays the query used to create the index, the number of times the index was read since index statistics were reset, the time the index was last read, and the reason for the index recommendation. Admin users also see a list of executed statement fingerprints using the index.
Grants view
The Grants view shows the privileges granted to users and roles for each database.
The following information is displayed for each table:
| Column | Description |
|---|---|
| Tables | The name of the table. |
| Users | The number of users of the table. |
| Roles | The list of roles on the table. |
| Grants | The list of grants of the table. |
For more details about grants and privileges, see GRANT.
See also
Was this helpful?
