-
Notifications
You must be signed in to change notification settings - Fork 718
statistics: add docs for the FLUSH STATS_DELTA statement #23258
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
0xPoe
wants to merge
9
commits into
pingcap:master
Choose a base branch
from
0xPoe:add-flush-stats-delta-doc
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+114
−1
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
c65cf26
statistics: add docs for the FLUSH STATS_DELTA statement
0xPoe 7ca8f42
address review comments: use active voice and second person
0xPoe 9be219a
move the version support info to the title
qiancai bca87a2
Apply suggestion from @qiancai
0xPoe e71fc29
Apply suggestion from @qiancai
0xPoe 28a42e9
Apply suggestion from @qiancai
0xPoe 33895fa
Apply suggestion from @qiancai
0xPoe 4449753
Apply suggestion from @qiancai
0xPoe 747e500
Apply suggestion from @qiancai
0xPoe File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| --- | ||
| title: FLUSH STATS_DELTA | ||
| summary: An overview of the usage of FLUSH STATS_DELTA for the TiDB database. | ||
| --- | ||
|
|
||
| # FLUSH STATS_DELTA <span class="version-mark">New in v8.5.7 and v9.0.0</span> | ||
|
|
||
| `FLUSH STATS_DELTA` persists the pending statistics delta buffered in TiDB memory to the [`mysql.stats_meta`](/mysql-schema/mysql-schema.md#statistics-system-tables) system table immediately. | ||
|
|
||
| When you change data using DML statements (such as `INSERT`, `UPDATE`, and `DELETE`), TiDB records changes to the total row count and modified row count of each affected table, buffers these changes (called the statistics delta) in the memory of the TiDB node that executes the statements, and persists them to the `mysql.stats_meta` system table every 20 * [`stats-lease`](/tidb-configuration-file.md#stats-lease) (60 seconds by default). For more information, see [Automatic update](/statistics.md#automatic-update). | ||
|
|
||
| Because the [health state of tables](/sql-statements/sql-statement-show-stats-healthy.md), the output of [`SHOW STATS_META`](/sql-statements/sql-statement-show-stats-meta.md), and the scheduling of automatic statistics collection depend on the persisted statistics metadata, `FLUSH STATS_DELTA` is useful when you need the persisted statistics metadata to reflect recent data changes immediately, such as in testing scenarios that verify optimizer behavior. You do not need to execute this statement before [`ANALYZE TABLE`](/sql-statements/sql-statement-analyze-table.md), because TiDB automatically flushes the pending statistics delta of a table before collecting statistics on it. | ||
|
|
||
| ## Synopsis | ||
|
|
||
| ```ebnf+diagram | ||
| FlushStatsDeltaStmt ::= | ||
| 'FLUSH' 'STATS_DELTA' FlushTargetList ClusterOption? | ||
|
|
||
| FlushTargetList ::= | ||
| FlushTarget (',' FlushTarget)* | ||
|
|
||
| FlushTarget ::= | ||
| TableName | ||
| | SchemaWildcard | ||
| | GlobalWildcard | ||
|
|
||
| TableName ::= | ||
| Identifier ('.' Identifier)? | ||
|
|
||
| SchemaWildcard ::= | ||
| Identifier '.' '*' | ||
|
|
||
| GlobalWildcard ::= | ||
| '*' '.' '*' | ||
|
|
||
| ClusterOption ::= | ||
| 'CLUSTER' | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| - **Targets (`FlushTargetList`)**: specifies which tables to flush. You must specify at least one target. | ||
| - `table_name`: flushes the statistics delta of a table in the current database. If you do not select a database, TiDB returns the `No database selected` error. | ||
| - `db_name.table_name`: flushes the statistics delta of a table in the specified database. | ||
| - `db_name.*`: flushes the statistics delta of all tables in the specified database. | ||
| - `*.*`: flushes the statistics delta of all tables. | ||
| - **`CLUSTER`**: broadcasts the statement to all TiDB nodes in the cluster. Each TiDB node buffers the statistics delta of the DML statements that it executes. Without this option, TiDB only persists the delta buffered on the TiDB node you are connected to. | ||
|
|
||
| Note the following behavior: | ||
|
|
||
| - TiDB deduplicates overlapping targets. For example, in `FLUSH STATS_DELTA *.*, test.t`, the `test.t` target is ignored because `*.*` already includes all tables. Similarly, in `FLUSH STATS_DELTA test.*, test.t`, the `test.t` target is ignored because `test.*` already includes all tables in the `test` database. | ||
| - For a partitioned table, TiDB persists the statistics delta of the table and all its partitions. | ||
| - If a specified database or table does not exist, TiDB returns a warning and skips that target. | ||
|
0xPoe marked this conversation as resolved.
|
||
|
|
||
| ## Examples | ||
|
|
||
| Persist the statistics delta of a single table immediately after data changes: | ||
|
|
||
| ```sql | ||
| USE test; | ||
| CREATE TABLE t (a INT, b INT); | ||
| INSERT INTO t VALUES (1, 1), (2, 2), (3, 3); | ||
| FLUSH STATS_DELTA t; | ||
| ``` | ||
|
|
||
| ``` | ||
| Query OK, 0 rows affected (0.01 sec) | ||
| ``` | ||
|
|
||
| TiDB has now persisted the row count changes of the table to the `mysql.stats_meta` system table. You can view persisted values using `SHOW STATS_META`. Note that `SHOW STATS_META` reads statistics from the memory of the TiDB node you are connected to. Because this TiDB node loads the persisted values within [`stats-lease`](/tidb-configuration-file.md#stats-lease) (`3s` by default), the flushed values might appear in the output after a short delay: | ||
|
|
||
| ```sql | ||
| SHOW STATS_META WHERE table_name = 't'; | ||
| ``` | ||
|
|
||
| ``` | ||
| +---------+------------+----------------+---------------------+--------------+-----------+-------------------+ | ||
| | Db_name | Table_name | Partition_name | Update_time | Modify_count | Row_count | Last_analyze_time | | ||
| +---------+------------+----------------+---------------------+--------------+-----------+-------------------+ | ||
| | test | t | | 2026-07-13 15:30:00 | 3 | 3 | NULL | | ||
| +---------+------------+----------------+---------------------+--------------+-----------+-------------------+ | ||
| 1 row in set (0.01 sec) | ||
| ``` | ||
|
|
||
| Persist the statistics delta of a table in the current database and every table in the `sales` database: | ||
|
|
||
| ```sql | ||
| FLUSH STATS_DELTA t, sales.*; | ||
| ``` | ||
|
|
||
| Persist the statistics delta of all tables buffered on every TiDB node in the cluster: | ||
|
|
||
| ```sql | ||
| FLUSH STATS_DELTA *.* CLUSTER; | ||
| ``` | ||
|
|
||
| ## Privileges | ||
|
|
||
| To execute `FLUSH STATS_DELTA`, you must have the `SELECT` privilege on the target objects: the target table for `table_name` or `db_name.table_name` targets, the target database for `db_name.*` targets, and the global `SELECT` privilege for `*.*` targets. Unlike other `FLUSH` statements, `FLUSH STATS_DELTA` does not require the `RELOAD` privilege. | ||
|
|
||
| ## MySQL compatibility | ||
|
|
||
| `FLUSH STATS_DELTA` is a TiDB extension to MySQL syntax. | ||
|
|
||
| ## See also | ||
|
|
||
| - [Statistics](/statistics.md) | ||
| - [`SHOW STATS_META`](/sql-statements/sql-statement-show-stats-meta.md) | ||
| - [`ANALYZE TABLE`](/sql-statements/sql-statement-analyze-table.md) | ||
| - [`REFRESH STATS`](/sql-statements/sql-statement-refresh-stats.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.