Skip to content

Latest commit

 

History

History
79 lines (62 loc) · 3.27 KB

client-errors-summary-global.md

File metadata and controls

79 lines (62 loc) · 3.27 KB
Raw
title summary
CLIENT_ERRORS_SUMMARY_GLOBAL
Learn about the `CLIENT_ERRORS_SUMMARY_GLOBAL` information_schema table.

CLIENT_ERRORS_SUMMARY_GLOBAL

The table CLIENT_ERRORS_SUMMARY_GLOBAL provides a global summary of all SQL errors and warnings that have been returned to clients that connect to a TiDB server. These include:

  • Malformed SQL statements.
  • Division by zero errors.
  • The attempt to insert out-of-range of duplicate key values.
  • Permission errors.
  • A table does not exist.

Client errors are returned to the client via the MySQL server protocol, where applications are expected to take appropriate action. The information_schema.CLIENT_ERRORS_SUMMARY_GLOBAL table provides a high-level overview, and is useful in the scenario where applications are not correctly handling (or logging) errors returned by the TiDB server.

The summarized counts can be reset with the statement FLUSH CLIENT_ERRORS_SUMMARY. The summary is local to each TiDB server and is only retained in memory. Summaries will be lost if the TiDB server restarts.

{{< copyable "sql" >}}

USE information_schema;
DESC CLIENT_ERRORS_SUMMARY_GLOBAL;
+---------------+---------------+------+------+---------+-------+
| Field         | Type          | Null | Key  | Default | Extra |
+---------------+---------------+------+------+---------+-------+
| ERROR_NUMBER  | bigint(64)    | NO   |      | NULL    |       |
| ERROR_MESSAGE | varchar(1024) | NO   |      | NULL    |       |
| ERROR_COUNT   | bigint(64)    | NO   |      | NULL    |       |
| WARNING_COUNT | bigint(64)    | NO   |      | NULL    |       |
| FIRST_SEEN    | timestamp     | YES  |      | NULL    |       |
| LAST_SEEN     | timestamp     | YES  |      | NULL    |       |
+---------------+---------------+------+------+---------+-------+
6 rows in set (0.00 sec)

Field description:

  • ERROR_NUMBER: The MySQL-compatible error number that was returned.
  • ERROR_MESSAGE: The error message which matches the error number (in prepared statement form).
  • ERROR_COUNT: The number of times this error was returned.
  • WARNING_COUNT: The number of times this warning was returned.
  • FIRST_SEEN: The first time this error (or warning) was sent.
  • LAST_SEEN: The most recent time this error (or warning) was sent.

The following example shows a warning being generated when connecting to a local TiDB server. The summary is reset after executing FLUSH CLIENT_ERRORS_SUMMARY:

{{< copyable "sql" >}}

SELECT 0/0;
SELECT * FROM CLIENT_ERRORS_SUMMARY_GLOBAL;
FLUSH CLIENT_ERRORS_SUMMARY;
SELECT * FROM CLIENT_ERRORS_SUMMARY_GLOBAL;
+-----+
| 0/0 |
+-----+
| NULL |
+-----+
1 row in set, 1 warning (0.00 sec)

+--------------+---------------+-------------+---------------+---------------------+---------------------+
| ERROR_NUMBER | ERROR_MESSAGE | ERROR_COUNT | WARNING_COUNT | FIRST_SEEN          | LAST_SEEN           |
+--------------+---------------+-------------+---------------+---------------------+---------------------+
|         1365 | Division by 0 |           0 |             1 | 2021-03-18 13:10:51 | 2021-03-18 13:10:51 |
+--------------+---------------+-------------+---------------+---------------------+---------------------+
1 row in set (0.00 sec)

Query OK, 0 rows affected (0.00 sec)

Empty set (0.00 sec)