Skip to content

Commit

Permalink
Updated include files used by ui-databases-page.md and cockroachcloud…
Browse files Browse the repository at this point in the history
…/databases-page-v24.3.
  • Loading branch information
florence-crl committed Oct 18, 2024
1 parent 471b7c2 commit 1b139fc
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 20 deletions.
2 changes: 1 addition & 1 deletion src/current/_includes/v24.3/ui/database-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Columns | The number of columns in the table.
Indexes | The number of indexes in the table.
Regions/Nodes | Regions/Nodes on which the table's data is stored.{% if page.cloud == true %}<br><br>NOTE: Not available on Standard or Basic clusters.{% endif %}
% of Live Data | The percentage of total uncompressed logical data that has not been modified (updated or deleted).
Table auto stats enabled | Automatic statistics can help improve query performance. Learn how to [manage statistics collection]({% link {{ version_prefix }}/cost-based-optimizer.md %}#control-automatic-statistics).
Table auto stats enabled | Whether automatic [table statistics]({% link {{ version_prefix }}/cost-based-optimizer.md %}#table-statistics) is enabled. Automatic statistics can help improve query performance.
Stats last updated | The last time table statistics used by the SQL optimizer were updated.

### Search and filter tables
Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/v24.3/ui/index-recommendations.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Index recommendations

The [**Table Indexes**](#table-indexes) and the [**Index**](#index) pages show recommendations to drop indexes based on index usage.
The [**Table Indexes**](#table-indexes) and the [**Index**](#index) pages show recommendations to drop indexes based on index usage. On the **Table Indexes** page, a **Drop index** button accompanies recommendations. Admin users can click this to drop an unused index.

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]({% link {{ version_prefix }}/cluster-settings.md %}). The default value is 7 days.
22 changes: 7 additions & 15 deletions src/current/_includes/v24.3/ui/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,16 @@

To view this page, click on a index name on the [**Table Indexes**](#table-indexes) page.

The **Index** page displays the SQL statement used to [create the index]({% link {{ version_prefix }}/create-index.md %}), an index’s details with possible recommendations.

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]({% link {{ version_prefix }}/security-reference/authorization.md %}#admin-role) also see a list of executed statement fingerprints using the index.
The **Index** page displays the SQL statement used to [create the index]({% link {{ version_prefix }}/create-index.md %}) and an index’s details. The page also allows [admin users]({% link {{ version_prefix }}/security-reference/authorization.md %}#admin-role) to [**Reset all index stats**](#reset-all-index-statistics).

The following information is displayed for the index:

Detail | Description
----------------|-------------
Total Reads | The number of times the index was read since index statistics were reset.
Last Read | The time the index was created, last read, or index statistics were reset.
Recommendations | A recommendation to drop the index if it is unused.
Detail | Description
----------------------|-------------
Total Reads | The number of times the index was read since index statistics were reset.
Last Read | The time the index was created, last read, or index statistics were reset.
Index Recommendations | A [recommendation](#index-recommendations) to drop the index if it is unused.

### Index Usage

The **Index Usage** table displays a list of the most executed statement fingerprints using this index.

The following information is displayed for each statement fingerprint:

Detail | Description
----------------|-------------
TODO |
The **Index Usage** table displays a list of the most executed statement fingerprints using this index. This table is only visible to [Admin users]({% link {{ version_prefix }}/security-reference/authorization.md %}#admin-role). The information displayed for each statement fingerprint is similar to the table on the [**Statements**]({% link {{ version_prefix }}/ui-statements-page.md %}#statements-table) page.
4 changes: 2 additions & 2 deletions src/current/_includes/v24.3/ui/table-indexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ The following information is displayed for each index:
Index Name | The name of the index. Click an index name to view the [**Index**](#index) page for the selected index.
Last Read | The time the index was created, last read, or index statistics were reset.
Total Reads | The number of times the index was read since index statistics were reset.
Recommendations | A recommendation to drop the index if it is unused.
Recommendations | A [recommendation](#index-recommendations) to drop the index if it is unused.
Action | If recommended, a **Drop index** button is displayed. [Admin users]({% link {{ version_prefix }}/security-reference/authorization.md %}#admin-role) can click this to drop an unused index.

### Reset index statistics
### Reset all index statistics

Index statistics accumulate from the time an index was created or when statistics were reset. If desired, [admin users]({% link {{ version_prefix }}/security-reference/authorization.md %}#admin-role) may reset index statistics for the entire cluster by clicking **Reset all index stats**. This link does not appear for non-admin users. **Last reset** is the timestamp at which the last reset started.
2 changes: 1 addition & 1 deletion src/current/_includes/v24.3/ui/table-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Ranges | The number of [ranges]({% link {{ version_prefi
Replicas | The number of [replicas]({% link {{ version_prefix }}/architecture/glossary.md %}#architecture-range) in the table.
Regions/Nodes | Regions/Nodes on which the table's data is stored.{% if page.cloud == true %}<br><br>NOTE: Not available on Standard or Basic clusters.{% endif %}
% of Live Data | The percentage of total uncompressed logical data that has not been modified (updated or deleted).
Auto stats collections | Automatic statistics can help improve query performance. Learn how to [manage statistics collection]({% link {{ version_prefix }}/cost-based-optimizer.md %}#control-automatic-statistics).
Auto stats collections | Whether automatic [table statistics]({% link {{ version_prefix }}/cost-based-optimizer.md %}#table-statistics) is enabled. Automatic statistics can help improve query performance.
Stats last updated | The last time table statistics used by the SQL optimizer were updated.

### Last updated
Expand Down

0 comments on commit 1b139fc

Please sign in to comment.