Skip to main content
On a , you must be an admin user to access this area of the DB Console. Refer to .
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, 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 . The default value is 7 days.

​
Databases

The Databases page shows:
  • Whether is enabled for the cluster.
  • A list of the databases on the cluster.
The following information is displayed for each 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 v23.2.17: 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 . When set to false, “No data” will be displayed for region data and replica counts. If you require this data, use the SQL statement 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:
  1. 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.
  2. 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:
  1. 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.
  2. Click Apply.

​
Tables view

The Tables view shows the tables in your database. The following information is displayed for each table: 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 associated with the table.

​
Overview tab

The Overview tab displays the SQL statements used to , 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 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 (default true ).
  • Ranges: The number of 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 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 (default true).
  • 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, 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: 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. also see a list of executed statement fingerprints using the index.

​
Grants view

The Grants view shows the granted to users and roles for each database. The following information is displayed for each table: For more details about grants and privileges, see .

​
See also