ClickHouse/docs/en/operations/system_tables.md

System tables

System tables are used for implementing part of the system's functionality, and for providing access to information about how the system is working. You can't delete a system table (but you can perform DETACH). System tables don't have files with data on the disk or files with metadata. The server creates all the system tables when it starts. System tables are read-only. They are located in the 'system' database.

system.asynchronous_metrics

Contains metrics that are calculated periodically in the background. For example, the amount of RAM in use.

Columns:

• metric (String) — Metric name.
• value (Float64) — Metric value.

Example

SELECT * FROM system.asynchronous_metrics LIMIT 10

┌─metric──────────────────────────────────┬──────value─┐
│ jemalloc.background_thread.run_interval │          0 │
│ jemalloc.background_thread.num_runs     │          0 │
│ jemalloc.background_thread.num_threads  │          0 │
│ jemalloc.retained                       │  422551552 │
│ jemalloc.mapped                         │ 1682989056 │
│ jemalloc.resident                       │ 1656446976 │
│ jemalloc.metadata_thp                   │          0 │
│ jemalloc.metadata                       │   10226856 │
│ UncompressedCacheCells                  │          0 │
│ MarkCacheFiles                          │          0 │
└─────────────────────────────────────────┴────────────┘

See Also

• Monitoring — Base concepts of ClickHouse monitoring.
• system.metrics — Contains instantly calculated metrics.
• system.events — Contains a number of events that have occurred.
• system.metric_log — Contains a history of metrics values from tables system.metrics и system.events.

system.clusters

Contains information about clusters available in the config file and the servers in them.

Columns:

• cluster (String) — The cluster name.
• shard_num (UInt32) — The shard number in the cluster, starting from 1.
• shard_weight (UInt32) — The relative weight of the shard when writing data.
• replica_num (UInt32) — The replica number in the shard, starting from 1.
• host_name (String) — The host name, as specified in the config.
• host_address (String) — The host IP address obtained from DNS.
• port (UInt16) — The port to use for connecting to the server.
• user (String) — The name of the user for connecting to the server.
• errors_count (UInt32) - number of times this host failed to reach replica.
• estimated_recovery_time (UInt32) - seconds left until replica error count is zeroed and it is considered to be back to normal.

Please note that errors_count is updated once per query to the cluster, but estimated_recovery_time is recalculated on-demand. So there could be a case of non-zero errors_count and zero estimated_recovery_time, that next query will zero errors_count and try to use replica as if it has no errors.

See also

• Table engine Distributed
• distributed_replica_error_cap setting
• distributed_replica_error_half_life setting

system.columns

Contains information about columns in all the tables.

You can use this table to get information similar to the DESCRIBE TABLE query, but for multiple tables at once.

The system.columns table contains the following columns (the column type is shown in brackets):

• database (String) — Database name.
• table (String) — Table name.
• name (String) — Column name.
• type (String) — Column type.
• default_kind (String) — Expression type (DEFAULT, MATERIALIZED, ALIAS) for the default value, or an empty string if it is not defined.
• default_expression (String) — Expression for the default value, or an empty string if it is not defined.
• data_compressed_bytes (UInt64) — The size of compressed data, in bytes.
• data_uncompressed_bytes (UInt64) — The size of decompressed data, in bytes.
• marks_bytes (UInt64) — The size of marks, in bytes.
• comment (String) — Comment on the column, or an empty string if it is not defined.
• is_in_partition_key (UInt8) — Flag that indicates whether the column is in the partition expression.
• is_in_sorting_key (UInt8) — Flag that indicates whether the column is in the sorting key expression.
• is_in_primary_key (UInt8) — Flag that indicates whether the column is in the primary key expression.
• is_in_sampling_key (UInt8) — Flag that indicates whether the column is in the sampling key expression.

system.contributors

Contains information about contributors. All constributors in random order. The order is random at query execution time.

Columns:

• name (String) — Contributor (author) name from git log.

Example

SELECT * FROM system.contributors LIMIT 10

┌─name─────────────┐
│ Olga Khvostikova │
│ Max Vetrov       │
│ LiuYangkuan      │
│ svladykin        │
│ zamulla          │
│ Šimon Podlipský  │
│ BayoNet          │
│ Ilya Khomutov    │
│ Amy Krishnevsky  │
│ Loud_Scream      │
└──────────────────┘

To find out yourself in the table, use a query:

SELECT * FROM system.contributors WHERE name='Olga Khvostikova'

┌─name─────────────┐
│ Olga Khvostikova │
└──────────────────┘

system.databases

This table contains a single String column called 'name' – the name of a database. Each database that the server knows about has a corresponding entry in the table. This system table is used for implementing the SHOW DATABASES query.

system.detached_parts

Contains information about detached parts of MergeTree tables. The reason column specifies why the part was detached. For user-detached parts, the reason is empty. Such parts can be attached with ALTER TABLE ATTACH PARTITION|PART command. For the description of other columns, see system.parts. If part name is invalid, values of some columns may be NULL. Such parts can be deleted with ALTER TABLE DROP DETACHED PART.

system.dictionaries

Contains information about external dictionaries.

Columns:

• name (String) — Dictionary name.
• type (String) — Dictionary type: Flat, Hashed, Cache.
• origin (String) — Path to the configuration file that describes the dictionary.
• attribute.names (Array(String)) — Array of attribute names provided by the dictionary.
• attribute.types (Array(String)) — Corresponding array of attribute types that are provided by the dictionary.
• has_hierarchy (UInt8) — Whether the dictionary is hierarchical.
• bytes_allocated (UInt64) — The amount of RAM the dictionary uses.
• hit_rate (Float64) — For cache dictionaries, the percentage of uses for which the value was in the cache.
• element_count (UInt64) — The number of items stored in the dictionary.
• load_factor (Float64) — The percentage filled in the dictionary (for a hashed dictionary, the percentage filled in the hash table).
• creation_time (DateTime) — The time when the dictionary was created or last successfully reloaded.
• last_exception (String) — Text of the error that occurs when creating or reloading the dictionary if the dictionary couldn't be created.
• source (String) — Text describing the data source for the dictionary.

Note that the amount of memory used by the dictionary is not proportional to the number of items stored in it. So for flat and cached dictionaries, all the memory cells are pre-assigned, regardless of how full the dictionary actually is.

system.events

Contains information about the number of events that have occurred in the system. For example, in the table, you can find how many SELECT queries were processed since the ClickHouse server started.

Columns:

• event (String) — Event name.
• value (UInt64) — Number of events occurred.
• description (String) — Event description.

Example

SELECT * FROM system.events LIMIT 5

┌─event─────────────────────────────────┬─value─┬─description────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Query                                 │    12 │ Number of queries to be interpreted and potentially executed. Does not include queries that failed to parse or were rejected due to AST size limits, quota limits or limits on the number of simultaneously running queries. May include internal queries initiated by ClickHouse itself. Does not count subqueries.                  │
│ SelectQuery                           │     8 │ Same as Query, but only for SELECT queries.                                                                                                                                                                                                                │
│ FileOpen                              │    73 │ Number of files opened.                                                                                                                                                                                                                                    │
│ ReadBufferFromFileDescriptorRead      │   155 │ Number of reads (read/pread) from a file descriptor. Does not include sockets.                                                                                                                                                                             │
│ ReadBufferFromFileDescriptorReadBytes │  9931 │ Number of bytes read from file descriptors. If the file is compressed, this will show the compressed data size.                                                                                                                                              │
└───────────────────────────────────────┴───────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

See Also

• system.asynchronous_metrics — Contains periodically calculated metrics.
• system.metrics — Contains instantly calculated metrics.
• system.metric_log — Contains a history of metrics values from tables system.metrics и system.events.
• Monitoring — Base concepts of ClickHouse monitoring.

system.functions

Contains information about normal and aggregate functions.

Columns:

• name(String) – The name of the function.
• is_aggregate(UInt8) — Whether the function is aggregate.

system.graphite_retentions

Contains information about parameters graphite_rollup which are used in tables with *GraphiteMergeTree engines.

Columns:

• config_name (String) - graphite_rollup parameter name.
• regexp (String) - A pattern for the metric name.
• function (String) - The name of the aggregating function.
• age (UInt64) - The minimum age of the data in seconds.
• precision (UInt64) - How precisely to define the age of the data in seconds.
• priority (UInt16) - Pattern priority.
• is_default (UInt8) - Whether the pattern is the default.
• Tables.database (Array(String)) - Array of names of database tables that use the config_name parameter.
• Tables.table (Array(String)) - Array of table names that use the config_name parameter.

system.merges

Contains information about merges and part mutations currently in process for tables in the MergeTree family.

Columns:

• database (String) — The name of the database the table is in.
• table (String) — Table name.
• elapsed (Float64) — The time elapsed (in seconds) since the merge started.
• progress (Float64) — The percentage of completed work from 0 to 1.
• num_parts (UInt64) — The number of pieces to be merged.
• result_part_name (String) — The name of the part that will be formed as the result of merging.
• is_mutation (UInt8) - 1 if this process is a part mutation.
• total_size_bytes_compressed (UInt64) — The total size of the compressed data in the merged chunks.
• total_size_marks (UInt64) — The total number of marks in the merged parts.
• bytes_read_uncompressed (UInt64) — Number of bytes read, uncompressed.
• rows_read (UInt64) — Number of rows read.
• bytes_written_uncompressed (UInt64) — Number of bytes written, uncompressed.
• rows_written (UInt64) — Number of rows written.

system.metrics

Contains metrics which can be calculated instantly, or have a current value. For example, the number of simultaneously processed queries or the current replica delay. This table is always up to date.

Columns:

• metric (String) — Metric name.
• value (Int64) — Metric value.
• description (String) — Metric description.

The list of supported metrics you can find in the dbms/src/Common/CurrentMetrics.cpp source file of ClickHouse.

Example

SELECT * FROM system.metrics LIMIT 10

┌─metric─────────────────────┬─value─┬─description──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Query                      │     1 │ Number of executing queries                                                                                                                                                                      │
│ Merge                      │     0 │ Number of executing background merges                                                                                                                                                            │
│ PartMutation               │     0 │ Number of mutations (ALTER DELETE/UPDATE)                                                                                                                                                        │
│ ReplicatedFetch            │     0 │ Number of data parts being fetched from replicas                                                                                                                                                │
│ ReplicatedSend             │     0 │ Number of data parts being sent to replicas                                                                                                                                                      │
│ ReplicatedChecks           │     0 │ Number of data parts checking for consistency                                                                                                                                                    │
│ BackgroundPoolTask         │     0 │ Number of active tasks in BackgroundProcessingPool (merges, mutations, fetches, or replication queue bookkeeping)                                                                                │
│ BackgroundSchedulePoolTask │     0 │ Number of active tasks in BackgroundSchedulePool. This pool is used for periodic ReplicatedMergeTree tasks, like cleaning old data parts, altering data parts, replica re-initialization, etc.   │
│ DiskSpaceReservedForMerge  │     0 │ Disk space reserved for currently running background merges. It is slightly more than the total size of currently merging parts.                                                                     │
│ DistributedSend            │     0 │ Number of connections to remote servers sending data that was INSERTed into Distributed tables. Both synchronous and asynchronous mode.                                                          │
└────────────────────────────┴───────┴──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

See Also

• system.asynchronous_metrics — Contains periodically calculated metrics.
• system.events — Contains a number of events that occurred.
• system.metric_log — Contains a history of metrics values from tables system.metrics и system.events.
• Monitoring — Base concepts of ClickHouse monitoring.

system.metric_log

Contains history of metrics values from tables system.metrics and system.events, periodically flushed to disk. To turn on metrics history collection on system.metric_log, create /etc/clickhouse-server/config.d/metric_log.xml with following content:

<yandex>
    <metric_log>
        <database>system</database>
        <table>metric_log</table>
        <flush_interval_milliseconds>7500</flush_interval_milliseconds>
        <collect_interval_milliseconds>1000</collect_interval_milliseconds>
    </metric_log>
</yandex>

Example

SELECT * FROM system.metric_log LIMIT 1 FORMAT Vertical;

Row 1:
──────
event_date:                                                 2020-02-18
event_time:                                                 2020-02-18 07:15:33
milliseconds:                                               554
ProfileEvent_Query:                                         0
ProfileEvent_SelectQuery:                                   0
ProfileEvent_InsertQuery:                                   0
ProfileEvent_FileOpen:                                      0
ProfileEvent_Seek:                                          0
ProfileEvent_ReadBufferFromFileDescriptorRead:              1
ProfileEvent_ReadBufferFromFileDescriptorReadFailed:        0
ProfileEvent_ReadBufferFromFileDescriptorReadBytes:         0
ProfileEvent_WriteBufferFromFileDescriptorWrite:            1
ProfileEvent_WriteBufferFromFileDescriptorWriteFailed:      0
ProfileEvent_WriteBufferFromFileDescriptorWriteBytes:       56
...
CurrentMetric_Query:                                        0
CurrentMetric_Merge:                                        0
CurrentMetric_PartMutation:                                 0
CurrentMetric_ReplicatedFetch:                              0
CurrentMetric_ReplicatedSend:                               0
CurrentMetric_ReplicatedChecks:                             0
...    

See also

• system.asynchronous_metrics — Contains periodically calculated metrics.
• system.events — Contains a number of events that occurred.
• system.metrics — Contains instantly calculated metrics.
• Monitoring — Base concepts of ClickHouse monitoring.

system.numbers

This table contains a single UInt64 column named 'number' that contains almost all the natural numbers starting from zero. You can use this table for tests, or if you need to do a brute force search. Reads from this table are not parallelized.

system.numbers_mt

The same as 'system.numbers' but reads are parallelized. The numbers can be returned in any order. Used for tests.

system.one

This table contains a single row with a single 'dummy' UInt8 column containing the value 0. This table is used if a SELECT query doesn't specify the FROM clause. This is similar to the DUAL table found in other DBMSs.

system.parts

Contains information about parts of MergeTree tables.

Each row describes one data part.

Columns:

• partition (String) – The partition name. To learn what a partition is, see the description of the ALTER query.

  Formats:

  • YYYYMM for automatic partitioning by month.
  • any_string when partitioning manually.

• name (String) – Name of the data part.

• active (UInt8) – Flag that indicates whether the data part is active. If a data part is active, it's used in a table. Otherwise, it's deleted. Inactive data parts remain after merging.

• marks (UInt64) – The number of marks. To get the approximate number of rows in a data part, multiply marks by the index granularity (usually 8192) (this hint doesn't work for adaptive granularity).

• rows (UInt64) – The number of rows.

• bytes_on_disk (UInt64) – Total size of all the data part files in bytes.

• data_compressed_bytes (UInt64) – Total size of compressed data in the data part. All the auxiliary files (for example, files with marks) are not included.

• data_uncompressed_bytes (UInt64) – Total size of uncompressed data in the data part. All the auxiliary files (for example, files with marks) are not included.

• marks_bytes (UInt64) – The size of the file with marks.

• modification_time (DateTime) – The time the directory with the data part was modified. This usually corresponds to the time of data part creation.|

• remove_time (DateTime) – The time when the data part became inactive.

• refcount (UInt32) – The number of places where the data part is used. A value greater than 2 indicates that the data part is used in queries or merges.

• min_date (Date) – The minimum value of the date key in the data part.

• max_date (Date) – The maximum value of the date key in the data part.

• min_time (DateTime) – The minimum value of the date and time key in the data part.

• max_time(DateTime) – The maximum value of the date and time key in the data part.

• partition_id (String) – ID of the partition.

• min_block_number (UInt64) – The minimum number of data parts that make up the current part after merging.

• max_block_number (UInt64) – The maximum number of data parts that make up the current part after merging.

• level (UInt32) – Depth of the merge tree. Zero means that the current part was created by insert rather than by merging other parts.

• data_version (UInt64) – Number that is used to determine which mutations should be applied to the data part (mutations with a version higher than data_version).

• primary_key_bytes_in_memory (UInt64) – The amount of memory (in bytes) used by primary key values.

• primary_key_bytes_in_memory_allocated (UInt64) – The amount of memory (in bytes) reserved for primary key values.

• is_frozen (UInt8) – Flag that shows that a partition data backup exists. 1, the backup exists. 0, the backup doesn't exist. For more details, see FREEZE PARTITION

• database (String) – Name of the database.

• table (String) – Name of the table.

• engine (String) – Name of the table engine without parameters.

• path (String) – Absolute path to the folder with data part files.

• disk (String) – Name of a disk that stores the data part.

• hash_of_all_files (String) – sipHash128 of compressed files.

• hash_of_uncompressed_files (String) – sipHash128 of uncompressed files (files with marks, index file etc.).

• uncompressed_hash_of_compressed_files (String) – sipHash128 of data in the compressed files as if they were uncompressed.

• bytes (UInt64) – Alias for bytes_on_disk.

• marks_size (UInt64) – Alias for marks_bytes.

system.part_log

The system.part_log table is created only if the part_log server setting is specified.

This table contains information about events that occurred with data parts in the MergeTree family tables, such as adding or merging data.

The system.part_log table contains the following columns:

• event_type (Enum) — Type of the event that occurred with the data part. Can have one of the following values:
  • NEW_PART — Inserting of a new data part.
  • MERGE_PARTS — Merging of data parts.
  • DOWNLOAD_PART — Downloading a data part.
  • REMOVE_PART — Removing or detaching a data part using DETACH PARTITION.
  • MUTATE_PART — Mutating of a data part.
  • MOVE_PART — Moving the data part from the one disk to another one.
• event_date (Date) — Event date.
• event_time (DateTime) — Event time.
• duration_ms (UInt64) — Duration.
• database (String) — Name of the database the data part is in.
• table (String) — Name of the table the data part is in.
• part_name (String) — Name of the data part.
• partition_id (String) — ID of the partition that the data part was inserted to. The column takes the 'all' value if the partitioning is by tuple().
• rows (UInt64) — The number of rows in the data part.
• size_in_bytes (UInt64) — Size of the data part in bytes.
• merged_from (Array(String)) — An array of names of the parts which the current part was made up from (after the merge).
• bytes_uncompressed (UInt64) — Size of uncompressed bytes.
• read_rows (UInt64) — The number of rows was read during the merge.
• read_bytes (UInt64) — The number of bytes was read during the merge.
• error (UInt16) — The code number of the occurred error.
• exception (String) — Text message of the occurred error.

The system.part_log table is created after the first inserting data to the MergeTree table.

system.processes

This system table is used for implementing the SHOW PROCESSLIST query.

Columns:

• user (String) – The user who made the query. Keep in mind that for distributed processing, queries are sent to remote servers under the default user. The field contains the username for a specific query, not for a query that this query initiated.
• address (String) – The IP address the request was made from. The same for distributed processing. To track where a distributed query was originally made from, look at system.processes on the query requestor server.
• elapsed (Float64) – The time in seconds since request execution started.
• rows_read (UInt64) – The number of rows read from the table. For distributed processing, on the requestor server, this is the total for all remote servers.
• bytes_read (UInt64) – The number of uncompressed bytes read from the table. For distributed processing, on the requestor server, this is the total for all remote servers.
• total_rows_approx (UInt64) – The approximation of the total number of rows that should be read. For distributed processing, on the requestor server, this is the total for all remote servers. It can be updated during request processing, when new sources to process become known.
• memory_usage (UInt64) – Amount of RAM the request uses. It might not include some types of dedicated memory. See the max_memory_usage setting.
• query (String) – The query text. For INSERT, it doesn't include the data to insert.
• query_id (String) – Query ID, if defined.

system.text_log

Contains logging entries. Logging level which goes to this table can be limited with text_log.level server setting.

Columns:

• event_date (Date) - Date of the entry.
• event_time (DateTime) - Time of the entry.
• microseconds (UInt32) - Microseconds of the entry.
• thread_name (String) — Name of the thread from which the logging was done.
• thread_id (UInt64) — OS thread ID.
• level (Enum8) - Entry level.
  • 'Fatal' = 1
  • 'Critical' = 2
  • 'Error' = 3
  • 'Warning' = 4
  • 'Notice' = 5
  • 'Information' = 6
  • 'Debug' = 7
  • 'Trace' = 8
• query_id (String) - ID of the query.
• logger_name (LowCardinality(String)) - Name of the logger (i.e. DDLWorker)
• message (String) - The message itself.
• revision (UInt32) - ClickHouse revision.
• source_file (LowCardinality(String)) - Source file from which the logging was done.
• source_line (UInt64) - Source line from which the logging was done.

system.query_log

Contains information about execution of queries. For each query, you can see processing start time, duration of processing, error messages and other information.

!!! note "Note" The table doesn't contain input data for INSERT queries.

ClickHouse creates this table only if the query_log server parameter is specified. This parameter sets the logging rules, such as the logging interval or the name of the table the queries will be logged in.

To enable query logging, set the log_queries parameter to 1. For details, see the Settings section.

The system.query_log table registers two kinds of queries:

1. Initial queries that were run directly by the client.
2. Child queries that were initiated by other queries (for distributed query execution). For these types of queries, information about the parent queries is shown in the initial_* columns.

Columns:

• type (Enum8) — Type of event that occurred when executing the query. Values:
  • 'QueryStart' = 1 — Successful start of query execution.
  • 'QueryFinish' = 2 — Successful end of query execution.
  • 'ExceptionBeforeStart' = 3 — Exception before the start of query execution.
  • 'ExceptionWhileProcessing' = 4 — Exception during the query execution.
• event_date (Date) — Query starting date.
• event_time (DateTime) — Query starting time.
• query_start_time (DateTime) — Start time of query execution.
• query_duration_ms (UInt64) — Duration of query execution.
• read_rows (UInt64) — Number of read rows.
• read_bytes (UInt64) — Number of read bytes.
• written_rows (UInt64) — For INSERT queries, the number of written rows. For other queries, the column value is 0.
• written_bytes (UInt64) — For INSERT queries, the number of written bytes. For other queries, the column value is 0.
• result_rows (UInt64) — Number of rows in the result.
• result_bytes (UInt64) — Number of bytes in the result.
• memory_usage (UInt64) — Memory consumption by the query.
• query (String) — Query string.
• exception (String) — Exception message.
• stack_trace (String) — Stack trace (a list of methods called before the error occurred). An empty string, if the query is completed successfully.
• is_initial_query (UInt8) — Query type. Possible values:
  • 1 — Query was initiated by the client.
  • 0 — Query was initiated by another query for distributed query execution.
• user (String) — Name of the user who initiated the current query.
• query_id (String) — ID of the query.
• address (IPv6) — IP address that was used to make the query.
• port (UInt16) — The client port that was used to make the query.
• initial_user (String) — Name of the user who ran the initial query (for distributed query execution).
• initial_query_id (String) — ID of the initial query (for distributed query execution).
• initial_address (IPv6) — IP address that the parent query was launched from.
• initial_port (UInt16) — The client port that was used to make the parent query.
• interface (UInt8) — Interface that the query was initiated from. Possible values:
  • 1 — TCP.
  • 2 — HTTP.
• os_user (String) — OS's username who runs clickhouse-client.
• client_hostname (String) — Hostname of the client machine where the clickhouse-client or another TCP client is run.
• client_name (String) — The clickhouse-client or another TCP client name.
• client_revision (UInt32) — Revision of the clickhouse-client or another TCP client.
• client_version_major (UInt32) — Major version of the clickhouse-client or another TCP client.
• client_version_minor (UInt32) — Minor version of the clickhouse-client or another TCP client.
• client_version_patch (UInt32) — Patch component of the clickhouse-client or another TCP client version.
• http_method (UInt8) — HTTP method that initiated the query. Possible values:
  • 0 — The query was launched from the TCP interface.
  • 1 — GET method was used.
  • 2 — POST method was used.
• http_user_agent (String) — The UserAgent header passed in the HTTP request.
• quota_key (String) — The "quota key" specified in the quotas setting (see keyed).
• revision (UInt32) — ClickHouse revision.
• thread_numbers (Array(UInt32)) — Number of threads that are participating in query execution.
• ProfileEvents.Names (Array(String)) — Counters that measure different metrics. The description of them could be found in the table system.events
• ProfileEvents.Values (Array(UInt64)) — Values of metrics that are listed in the ProfileEvents.Names column.
• Settings.Names (Array(String)) — Names of settings that were changed when the client ran the query. To enable logging changes to settings, set the log_query_settings parameter to 1.
• Settings.Values (Array(String)) — Values of settings that are listed in the Settings.Names column.

Each query creates one or two rows in the query_log table, depending on the status of the query:

1. If the query execution is successful, two events with types 1 and 2 are created (see the type column).
2. If an error occurred during query processing, two events with types 1 and 4 are created.
3. If an error occurred before launching the query, a single event with type 3 is created.

By default, logs are added to the table at intervals of 7.5 seconds. You can set this interval in the query_log server setting (see the flush_interval_milliseconds parameter). To flush the logs forcibly from the memory buffer into the table, use the SYSTEM FLUSH LOGS query.

When the table is deleted manually, it will be automatically created on the fly. Note that all the previous logs will be deleted.

!!! note The storage period for logs is unlimited. Logs aren't automatically deleted from the table. You need to organize the removal of outdated logs yourself.

You can specify an arbitrary partitioning key for the system.query_log table in the query_log server setting (see the partition_by parameter).

system.query_thread_log

The table contains information about each query execution thread.

ClickHouse creates this table only if the query_thread_log server parameter is specified. This parameter sets the logging rules, such as the logging interval or the name of the table the queries will be logged in.

To enable query logging, set the log_query_threads parameter to 1. For details, see the Settings section.

Columns:

• event_date (Date) — the date when the thread has finished execution of the query.
• event_time (DateTime) — the date and time when the thread has finished execution of the query.
• query_start_time (DateTime) — Start time of query execution.
• query_duration_ms (UInt64) — Duration of query execution.
• read_rows (UInt64) — Number of read rows.
• read_bytes (UInt64) — Number of read bytes.
• written_rows (UInt64) — For INSERT queries, the number of written rows. For other queries, the column value is 0.
• written_bytes (UInt64) — For INSERT queries, the number of written bytes. For other queries, the column value is 0.
• memory_usage (Int64) — The difference between the amount of allocated and freed memory in context of this thread.
• peak_memory_usage (Int64) — The maximum difference between the amount of allocated and freed memory in context of this thread.
• thread_name (String) — Name of the thread.
• thread_number (UInt32) — Internal thread ID.
• os_thread_id (Int32) — OS thread ID.
• master_thread_id (UInt64) — OS initial ID of initial thread.
• query (String) — Query string.
• is_initial_query (UInt8) — Query type. Possible values:
  • 1 — Query was initiated by the client.
  • 0 — Query was initiated by another query for distributed query execution.
• user (String) — Name of the user who initiated the current query.
• query_id (String) — ID of the query.
• address (IPv6) — IP address that was used to make the query.
• port (UInt16) — The client port that was used to make the query.
• initial_user (String) — Name of the user who ran the initial query (for distributed query execution).
• initial_query_id (String) — ID of the initial query (for distributed query execution).
• initial_address (IPv6) — IP address that the parent query was launched from.
• initial_port (UInt16) — The client port that was used to make the parent query.
• interface (UInt8) — Interface that the query was initiated from. Possible values:
  • 1 — TCP.
  • 2 — HTTP.
• os_user (String) — OS's username who runs clickhouse-client.
• client_hostname (String) — Hostname of the client machine where the clickhouse-client or another TCP client is run.
• client_name (String) — The clickhouse-client or another TCP client name.
• client_revision (UInt32) — Revision of the clickhouse-client or another TCP client.
• client_version_major (UInt32) — Major version of the clickhouse-client or another TCP client.
• client_version_minor (UInt32) — Minor version of the clickhouse-client or another TCP client.
• client_version_patch (UInt32) — Patch component of the clickhouse-client or another TCP client version.
• http_method (UInt8) — HTTP method that initiated the query. Possible values:
  • 0 — The query was launched from the TCP interface.
  • 1 — GET method was used.
  • 2 — POST method was used.
• http_user_agent (String) — The UserAgent header passed in the HTTP request.
• quota_key (String) — The "quota key" specified in the quotas setting (see keyed).
• revision (UInt32) — ClickHouse revision.
• ProfileEvents.Names (Array(String)) — Counters that measure different metrics for this thread. The description of them could be found in the table system.events
• ProfileEvents.Values (Array(UInt64)) — Values of metrics for this thread that are listed in the ProfileEvents.Names column.

By default, logs are added to the table at intervals of 7.5 seconds. You can set this interval in the query_thread_log server setting (see the flush_interval_milliseconds parameter). To flush the logs forcibly from the memory buffer into the table, use the SYSTEM FLUSH LOGS query.

When the table is deleted manually, it will be automatically created on the fly. Note that all the previous logs will be deleted.

!!! note The storage period for logs is unlimited. Logs aren't automatically deleted from the table. You need to organize the removal of outdated logs yourself.

You can specify an arbitrary partitioning key for the system.query_thread_log table in the query_thread_log server setting (see the partition_by parameter).

system.trace_log

Contains stack traces collected by the sampling query profiler.

ClickHouse creates this table when the trace_log server configuration section is set. Also the query_profiler_real_time_period_ns and query_profiler_cpu_time_period_ns settings should be set.

To analyze logs, use the addressToLine, addressToSymbol and demangle introspection functions.

Columns:

• event_date(Date) — Date of sampling moment.

• event_time(DateTime) — Timestamp of sampling moment.

• revision(UInt32) — ClickHouse server build revision.

  When connecting to server by clickhouse-client, you see the string similar to Connected to ClickHouse server version 19.18.1 revision 54429.. This field contains the revision, but not the version of a server.

• timer_type(Enum8) — Timer type:

  • Real represents wall-clock time.
  • CPU represents CPU time.

• thread_number(UInt32) — Thread identifier.

• query_id(String) — Query identifier that can be used to get details about a query that was running from the query_log system table.

• trace(Array(UInt64)) — Stack trace at the moment of sampling. Each element is a virtual memory address inside ClickHouse server process.

Example

SELECT * FROM system.trace_log LIMIT 1 \G

Row 1:
──────
event_date:    2019-11-15
event_time:    2019-11-15 15:09:38
revision:      54428
timer_type:    Real
thread_number: 48
query_id:      acc4d61f-5bd1-4a3e-bc91-2180be37c915
trace:         [94222141367858,94222152240175,94222152325351,94222152329944,94222152330796,94222151449980,94222144088167,94222151682763,94222144088167,94222151682763,94222144088167,94222144058283,94222144059248,94222091840750,94222091842302,94222091831228,94222189631488,140509950166747,140509942945935]

system.replicas

Contains information and status for replicated tables residing on the local server. This table can be used for monitoring. The table contains a row for every Replicated* table.

Example:

SELECT *
FROM system.replicas
WHERE table = 'visits'
FORMAT Vertical

Row 1:
──────
database:                   merge
table:                      visits
engine:                     ReplicatedCollapsingMergeTree
is_leader:                  1
can_become_leader:          1
is_readonly:                0
is_session_expired:         0
future_parts:               1
parts_to_check:             0
zookeeper_path:             /clickhouse/tables/01-06/visits
replica_name:               example01-06-1.yandex.ru
replica_path:               /clickhouse/tables/01-06/visits/replicas/example01-06-1.yandex.ru
columns_version:            9
queue_size:                 1
inserts_in_queue:           0
merges_in_queue:            1
part_mutations_in_queue:    0
queue_oldest_time:          2020-02-20 08:34:30
inserts_oldest_time:        0000-00-00 00:00:00
merges_oldest_time:         2020-02-20 08:34:30
part_mutations_oldest_time: 0000-00-00 00:00:00
oldest_part_to_get:
oldest_part_to_merge_to:    20200220_20284_20840_7
oldest_part_to_mutate_to:
log_max_index:              596273
log_pointer:                596274
last_queue_update:          2020-02-20 08:34:32
absolute_delay:             0
total_replicas:             2
active_replicas:            2

Columns:

• database (String) - Database name
• table (String) - Table name
• engine (String) - Table engine name
• is_leader (UInt8) - Whether the replica is the leader.
  Only one replica at a time can be the leader. The leader is responsible for selecting background merges to perform.
  Note that writes can be performed to any replica that is available and has a session in ZK, regardless of whether it is a leader.
• can_become_leader (UInt8) - Whether the replica can be elected as a leader.
• is_readonly (UInt8) - Whether the replica is in read-only mode.
  This mode is turned on if the config doesn't have sections with ZooKeeper, if an unknown error occurred when reinitializing sessions in ZooKeeper, and during session reinitialization in ZooKeeper.
• is_session_expired (UInt8) - the session with ZooKeeper has expired. Basically the same as is_readonly.
• future_parts (UInt32) - The number of data parts that will appear as the result of INSERTs or merges that haven't been done yet.
• parts_to_check (UInt32) - The number of data parts in the queue for verification. A part is put in the verification queue if there is suspicion that it might be damaged.
• zookeeper_path (String) - Path to table data in ZooKeeper.
• replica_name (String) - Replica name in ZooKeeper. Different replicas of the same table have different names.
• replica_path (String) - Path to replica data in ZooKeeper. The same as concatenating 'zookeeper_path/replicas/replica_path'.
• columns_version (Int32) - Version number of the table structure. Indicates how many times ALTER was performed. If replicas have different versions, it means some replicas haven't made all of the ALTERs yet.
• queue_size (UInt32) - Size of the queue for operations waiting to be performed. Operations include inserting blocks of data, merges, and certain other actions. It usually coincides with future_parts.
• inserts_in_queue (UInt32) - Number of inserts of blocks of data that need to be made. Insertions are usually replicated fairly quickly. If this number is large, it means something is wrong.
• merges_in_queue (UInt32) - The number of merges waiting to be made. Sometimes merges are lengthy, so this value may be greater than zero for a long time.
• part_mutations_in_queue (UInt32) - The number of mutations waiting to be made.
• queue_oldest_time (DateTime) - If queue_size greater than 0, shows when the oldest operation was added to the queue.
• inserts_oldest_time (DateTime) - See queue_oldest_time
• merges_oldest_time (DateTime) - See queue_oldest_time
• part_mutations_oldest_time (DateTime) - See queue_oldest_time

The next 4 columns have a non-zero value only where there is an active session with ZK.

• log_max_index (UInt64) - Maximum entry number in the log of general activity.
• log_pointer (UInt64) - Maximum entry number in the log of general activity that the replica copied to its execution queue, plus one. If log_pointer is much smaller than log_max_index, something is wrong.
• last_queue_update (DateTime) - When the queue was updated last time.
• absolute_delay (UInt64) - How big lag in seconds the current replica has.
• total_replicas (UInt8) - The total number of known replicas of this table.
• active_replicas (UInt8) - The number of replicas of this table that have a session in ZooKeeper (i.e., the number of functioning replicas).

If you request all the columns, the table may work a bit slowly, since several reads from ZooKeeper are made for each row. If you don't request the last 4 columns (log_max_index, log_pointer, total_replicas, active_replicas), the table works quickly.

For example, you can check that everything is working correctly like this:

SELECT
    database,
    table,
    is_leader,
    is_readonly,
    is_session_expired,
    future_parts,
    parts_to_check,
    columns_version,
    queue_size,
    inserts_in_queue,
    merges_in_queue,
    log_max_index,
    log_pointer,
    total_replicas,
    active_replicas
FROM system.replicas
WHERE
       is_readonly
    OR is_session_expired
    OR future_parts > 20
    OR parts_to_check > 10
    OR queue_size > 20
    OR inserts_in_queue > 10
    OR log_max_index - log_pointer > 10
    OR total_replicas < 2
    OR active_replicas < total_replicas

If this query doesn't return anything, it means that everything is fine.

system.settings

Contains information about settings that are currently in use. I.e. used for executing the query you are using to read from the system.settings table.

Columns:

• name (String) — Setting name.
• value (String) — Setting value.
• changed (UInt8) — Whether the setting was explicitly defined in the config or explicitly changed.

Example:

SELECT *
FROM system.settings
WHERE changed

┌─name───────────────────┬─value───────┬─changed─┐
│ max_threads            │ 8           │       1 │
│ use_uncompressed_cache │ 0           │       1 │
│ load_balancing         │ random      │       1 │
│ max_memory_usage       │ 10000000000 │       1 │
└────────────────────────┴─────────────┴─────────┘

system.table_engines

Contains description of table engines supported by server and their feature support information.

This table contains the following columns (the column type is shown in brackets):

• name (String) — The name of table engine.
• supports_settings (UInt8) — Flag that indicates if table engine supports SETTINGS clause.
• supports_skipping_indices (UInt8) — Flag that indicates if table engine supports skipping indices.
• supports_ttl (UInt8) — Flag that indicates if table engine supports TTL.
• supports_sort_order (UInt8) — Flag that indicates if table engine supports clauses PARTITION_BY, PRIMARY_KEY, ORDER_BY and SAMPLE_BY.
• supports_replication (UInt8) — Flag that indicates if table engine supports data replication.
• supports_duduplication (UInt8) — Flag that indicates if table engine supports data deduplication.

Example:

SELECT *
FROM system.table_engines
WHERE name in ('Kafka', 'MergeTree', 'ReplicatedCollapsingMergeTree')

┌─name──────────────────────────┬─supports_settings─┬─supports_skipping_indices─┬─supports_sort_order─┬─supports_ttl─┬─supports_replication─┬─supports_deduplication─┐
│ Kafka                         │                 1 │                         0 │                   0 │            0 │                    0 │                      0 │
│ MergeTree                     │                 1 │                         1 │                   1 │            1 │                    0 │                      0 │
│ ReplicatedCollapsingMergeTree │                 1 │                         1 │                   1 │            1 │                    1 │                      1 │
└───────────────────────────────┴───────────────────┴───────────────────────────┴─────────────────────┴──────────────┴──────────────────────┴────────────────────────┘

See also

• MergeTree family query clauses
• Kafka settings
• Join settings

system.tables

Contains metadata of each table that the server knows about. Detached tables are not shown in system.tables.

This table contains the following columns (the column type is shown in brackets):

• database (String) — The name of the database the table is in.
• name (String) — Table name.
• engine (String) — Table engine name (without parameters).
• is_temporary (UInt8) - Flag that indicates whether the table is temporary.
• data_path (String) - Path to the table data in the file system.
• metadata_path (String) - Path to the table metadata in the file system.
• metadata_modification_time (DateTime) - Time of latest modification of the table metadata.
• dependencies_database (Array(String)) - Database dependencies.
• dependencies_table (Array(String)) - Table dependencies (MaterializedView tables based on the current table).
• create_table_query (String) - The query that was used to create the table.
• engine_full (String) - Parameters of the table engine.
• partition_key (String) - The partition key expression specified in the table.
• sorting_key (String) - The sorting key expression specified in the table.
• primary_key (String) - The primary key expression specified in the table.
• sampling_key (String) - The sampling key expression specified in the table.

The system.tables table is used in SHOW TABLES query implementation.

system.zookeeper

The table does not exist if ZooKeeper is not configured. Allows reading data from the ZooKeeper cluster defined in the config. The query must have a 'path' equality condition in the WHERE clause. This is the path in ZooKeeper for the children that you want to get data for.

The query SELECT * FROM system.zookeeper WHERE path = '/clickhouse' outputs data for all children on the /clickhouse node. To output data for all root nodes, write path = '/'. If the path specified in 'path' doesn't exist, an exception will be thrown.

Columns:

• name (String) — The name of the node.
• path (String) — The path to the node.
• value (String) — Node value.
• dataLength (Int32) — Size of the value.
• numChildren (Int32) — Number of descendants.
• czxid (Int64) — ID of the transaction that created the node.
• mzxid (Int64) — ID of the transaction that last changed the node.
• pzxid (Int64) — ID of the transaction that last deleted or added descendants.
• ctime (DateTime) — Time of node creation.
• mtime (DateTime) — Time of the last modification of the node.
• version (Int32) — Node version: the number of times the node was changed.
• cversion (Int32) — Number of added or removed descendants.
• aversion (Int32) — Number of changes to the ACL.
• ephemeralOwner (Int64) — For ephemeral nodes, the ID of the session that owns this node.

Example:

SELECT *
FROM system.zookeeper
WHERE path = '/clickhouse/tables/01-08/visits/replicas'
FORMAT Vertical

Row 1:
──────
name:           example01-08-1.yandex.ru
value:
czxid:          932998691229
mzxid:          932998691229
ctime:          2015-03-27 16:49:51
mtime:          2015-03-27 16:49:51
version:        0
cversion:       47
aversion:       0
ephemeralOwner: 0
dataLength:     0
numChildren:    7
pzxid:          987021031383
path:           /clickhouse/tables/01-08/visits/replicas

Row 2:
──────
name:           example01-08-2.yandex.ru
value:
czxid:          933002738135
mzxid:          933002738135
ctime:          2015-03-27 16:57:01
mtime:          2015-03-27 16:57:01
version:        0
cversion:       37
aversion:       0
ephemeralOwner: 0
dataLength:     0
numChildren:    7
pzxid:          987021252247
path:           /clickhouse/tables/01-08/visits/replicas

system.mutations

The table contains information about mutations of MergeTree tables and their progress. Each mutation command is represented by a single row. The table has the following columns:

database, table - The name of the database and table to which the mutation was applied.

mutation_id - The ID of the mutation. For replicated tables these IDs correspond to znode names in the <table_path_in_zookeeper>/mutations/ directory in ZooKeeper. For unreplicated tables the IDs correspond to file names in the data directory of the table.

command - The mutation command string (the part of the query after ALTER TABLE [db.]table).

create_time - When this mutation command was submitted for execution.

block_numbers.partition_id, block_numbers.number - A nested column. For mutations of replicated tables, it contains one record for each partition: the partition ID and the block number that was acquired by the mutation (in each partition, only parts that contain blocks with numbers less than the block number acquired by the mutation in that partition will be mutated). In non-replicated tables, block numbers in all partitions form a single sequence. This means that for mutations of non-replicated tables, the column will contain one record with a single block number acquired by the mutation.

parts_to_do - The number of data parts that need to be mutated for the mutation to finish.

is_done - Is the mutation done? Note that even if parts_to_do = 0 it is possible that a mutation of a replicated table is not done yet because of a long-running INSERT that will create a new data part that will need to be mutated.

If there were problems with mutating some parts, the following columns contain additional information:

latest_failed_part - The name of the most recent part that could not be mutated.

latest_fail_time - The time of the most recent part mutation failure.

latest_fail_reason - The exception message that caused the most recent part mutation failure.

system.disks

Contains information about disks defined in the server configuration.

Columns:

• name (String) — Name of a disk in the server configuration.
• path (String) — Path to the mount point in the file system.
• free_space (UInt64) — Free space on disk in bytes.
• total_space (UInt64) — Disk volume in bytes.
• keep_free_space (UInt64) — Amount of disk space that should stay free on disk in bytes. Defined in the keep_free_space_bytes parameter of disk configuration.

system.storage_policies

Contains information about storage policies and volumes defined in the server configuration.

Columns:

• policy_name (String) — Name of the storage policy.
• volume_name (String) — Volume name defined in the storage policy.
• volume_priority (UInt64) — Volume order number in the configuration.
• disks (Array(String)) — Disk names, defined in the storage policy.
• max_data_part_size (UInt64) — Maximum size of a data part that can be stored on volume disks (0 — no limit).
• move_factor (Float64) — Ratio of free disk space. When the ratio exceeds the value of configuration parameter, ClickHouse start to move data to the next volume in order.

If the storage policy contains more then one volume, then information for each volume is stored in the individual row of the table.

Original article