CHECK TABLE Statement

Documentation for Check Table

The CHECK TABLE query in ClickHouse is used to perform a validation check on a specific table or its partitions. It ensures the integrity of the data by verifying the checksums and other internal data structures.

Particularly it compares actual file sizes with the expected values which are stored on the server. If the file sizes do not match the stored values, it means the data is corrupted. This can be caused, for example, by a system crash during query execution.

The CHECK TABLE query may read all the data in the table and hold some resources, making it resource-intensive. Consider the potential impact on performance and resource utilization before executing this query. This query will not improve performance of the system and you should not execute it if you are not sure of what you are doing.

Syntax

The basic syntax of the query is as follows:

CHECK TABLE table_name [PARTITION partition_expression | PART part_name] [FORMAT format] [SETTINGS check_query_single_value_result = (0|1) [, other_settings]]

• table_name: Specifies the name of the table that you want to check.
• partition_expression: (Optional) If you want to check a specific partition of the table, you can use this expression to specify the partition.
• part_name: (Optional) If you want to check a specific part in the table, you can add string literal to specify a part name.
• FORMAT format: (Optional) Allows you to specify the output format of the result.
• SETTINGS: (Optional) Allows additional settings.
  • (Optional): check_query_single_value_result: This setting controls if the output is detailed (0) or summarized (1).
  • Other settings can be applied as well. If you don’t require a deterministic order for the results, you can set max_threads to a value greater than one to speed up the query.

The query response depends on the value of the check_query_single_value_result setting. In case of check_query_single_value_result = 1 only result column with a single row is returned. Value inside this row is 1 if the integrity check is passed and 0 if data is corrupted.

With check_query_single_value_result = 0 the query returns the following columns:

• part_path: Indicates the path to the data part or file name.
• is_passed: Returns 1 if the check for this part is successful, 0 otherwise.
• message: Any additional messages related to the check, such as errors or success messages.

The CHECK TABLE query supports the following table engines:

• Log
• TinyLog
• StripeLog
• MergeTree family

Performed over the tables with another table engines causes an NOT_IMPLEMENTED exception.

Engines from the *Log family do not provide automatic data recovery on failure. Use the CHECK TABLE query to track data loss in a timely manner.

Examples

By default CHECK TABLE query shows the general table check status:

CHECK TABLE test_table;

┌─result─┐
│      1 │
└────────┘

If you want to see the check status for every individual data part you may use check_query_single_value_result setting.

Also, to check a specific partition of the table, you can use the PARTITION keyword.

CHECK TABLE t0 PARTITION ID '201003'
FORMAT PrettyCompactMonoBlock
SETTINGS check_query_single_value_result = 0

Output:

┌─part_path────┬─is_passed─┬─message─┐
│ 201003_7_7_0 │         1 │         │
│ 201003_3_3_0 │         1 │         │
└──────────────┴───────────┴─────────┘

Similarly, you can check a specific part of the table by using the PART keyword.

CHECK TABLE t0 PART '201003_7_7_0'
FORMAT PrettyCompactMonoBlock
SETTINGS check_query_single_value_result = 0

Output:

┌─part_path────┬─is_passed─┬─message─┐
│ 201003_7_7_0 │         1 │         │
└──────────────┴───────────┴─────────┘

Note that when part does not exist, the query returns an error:

CHECK TABLE t0 PART '201003_111_222_0'

DB::Exception: No such data part '201003_111_222_0' to check in table 'default.t0'. (NO_SUCH_DATA_PART)

Receiving a ‘Corrupted’ Result

Disclaimer: The procedure described here, including the manual manipulating or removing files directly from the data directory, is for experimental or development environments only. Do not attempt this on a production server, as it may lead to data loss or other unintended consequences.

Remove the existing checksum file:

rm /var/lib/clickhouse-server/data/default/t0/201003_3_3_0/checksums.txt

CHECK TABLE t0 PARTITION ID '201003'
FORMAT PrettyCompactMonoBlock
SETTINGS check_query_single_value_result = 0

Output:

```text
┌─part_path────┬─is_passed─┬─message──────────────────────────────────┐
│ 201003_7_7_0 │         1 │                                          │
│ 201003_3_3_0 │         1 │ Checksums recounted and written to disk. │
└──────────────┴───────────┴──────────────────────────────────────────┘

If the checksums.txt file is missing, it can be restored. It will be recalculated and rewritten during the execution of the CHECK TABLE command for the specific partition, and the status will still be reported as ‘is_passed = 1’.

You can check all existing (Replicated)MergeTree tables at once by using the CHECK ALL TABLES query.

CHECK ALL TABLES
FORMAT PrettyCompactMonoBlock
SETTINGS check_query_single_value_result = 0

┌─database─┬─table────┬─part_path───┬─is_passed─┬─message─┐
│ default  │ t2       │ all_1_95_3  │         1 │         │
│ db1      │ table_01 │ all_39_39_0 │         1 │         │
│ default  │ t1       │ all_39_39_0 │         1 │         │
│ db1      │ t1       │ all_39_39_0 │         1 │         │
│ db1      │ table_01 │ all_1_6_1   │         1 │         │
│ default  │ t1       │ all_1_6_1   │         1 │         │
│ db1      │ t1       │ all_1_6_1   │         1 │         │
│ db1      │ table_01 │ all_7_38_2  │         1 │         │
│ db1      │ t1       │ all_7_38_2  │         1 │         │
│ default  │ t1       │ all_7_38_2  │         1 │         │
└──────────┴──────────┴─────────────┴───────────┴─────────┘

If the Data Is Corrupted

If the table is corrupted, you can copy the non-corrupted data to another table. To do this:

1. Create a new table with the same structure as damaged table. To do this execute the query CREATE TABLE <new_table_name> AS <damaged_table_name>.
2. Set the max_threads value to 1 to process the next query in a single thread. To do this run the query SET max_threads = 1.
3. Execute the query INSERT INTO <new_table_name> SELECT * FROM <damaged_table_name>. This request copies the non-corrupted data from the damaged table to another table. Only the data before the corrupted part will be copied.
4. Restart the clickhouse-client to reset the max_threads value.