System Tables
Comments and columns for RawTree system tables.
System tables
This page describes the RawTree engine binary used to generate this reference. It does not define Query API support. Descriptions retain upstream ClickHouse terminology. See SQL interface scope.
aggregate_function_combinators
Contains a list of all available aggregate function combinators, which could be applied to aggregate functions and change the way they work.
| Column | Type | Comment |
|---|---|---|
name | String | The name of the combinator. |
is_internal | UInt8 | Whether this combinator is for internal usage only. |
description | String | A high-level description of what the combinator does. |
syntax | String | How the combinator is applied to an aggregate function name. |
examples | String | Usage examples. |
introduced_in | String | The ClickHouse version in which the combinator was first introduced, in the form major.minor. |
related | Array(String) | The names of related combinators. |
asynchronous_inserts
Contains information about pending asynchronous inserts in queue in server's memory.
| Column | Type | Comment |
|---|---|---|
query | String | Query text. |
database | String | Database name. |
table | String | Table name. |
format | String | Format name. |
first_update | DateTime64(6) | First insert time with microseconds resolution. |
total_bytes | UInt64 | Total number of bytes waiting in the queue. |
entries.query_id | Array(String) | Array of query ids of the inserts waiting in the queue. |
entries.bytes | Array(UInt64) | Array of bytes of each insert query waiting in the queue. |
asynchronous_loader
Contains information and status for recent asynchronous jobs (e.g. for tables loading). The table contains a row for every job.
| Column | Type | Comment |
|---|---|---|
job | String | Job name (may be not unique). |
job_id | UInt64 | Unique ID of the job. |
dependencies | Array(UInt64) | List of IDs of jobs that should be done before this job. |
dependencies_left | UInt64 | Current number of dependencies left to be done. |
status | Enum8('PENDING' = 0, 'OK' = 1, 'FAILED' = 2, 'CANCELED' = 3) | Current load status of a job: PENDING: Load job is not started yet. OK: Load job executed and was successful. FAILED: Load job executed and failed. CANCELED: Load job is not going to be executed due to removal or dependency failure. |
is_executing | UInt8 | The job is currently being executed by a worker. |
is_blocked | UInt8 | The job waits for its dependencies to be done. |
is_ready | UInt8 | The job is ready to be executed and waits for a worker. |
elapsed | Float64 | Seconds elapsed since start of execution. Zero if job is not started. Total execution time if job finished. |
pool_id | UInt64 | ID of a pool currently assigned to the job. |
pool | String | Name of pool_id pool. |
priority | Int64 | Priority of pool_id pool. |
execution_pool_id | UInt64 | ID of a pool the job is executed in. Equals initially assigned pool before execution starts. |
execution_pool | String | Name of execution_pool_id pool. |
execution_priority | Int64 | Priority of execution_pool_id pool. |
ready_seqno | Nullable(UInt64) | Not null for ready jobs. Worker pulls the next job to be executed from a ready queue of its pool. If there are multiple ready jobs, then job with the lowest value of ready_seqno is picked. |
waiters | UInt64 | The number of threads waiting on this job. |
exception | Nullable(String) | Not null for failed and canceled jobs. Holds error message raised during query execution or error leading to cancelling of this job along with dependency failure chain of job names. |
schedule_time | DateTime64(6) | Time when job was created and scheduled to be executed (usually with all its dependencies). |
enqueue_time | Nullable(DateTime64(6)) | Time when job became ready and was enqueued into a ready queue of it's pool. Null if the job is not ready yet. |
start_time | Nullable(DateTime64(6)) | Time when worker dequeues the job from ready queue and start its execution. Null if the job is not started yet. |
finish_time | Nullable(DateTime64(6)) | Time when job execution is finished. Null if the job is not finished yet. |
azure_queue_metadata
Contains the current number of processed, processing and failed nodes in keeper for each AzureQueue metadata object and, on demand, their contents. Unlike system.azure_queue_metadata_cache, which shows the in-memory cache, this table reads the state directly from keeper.
| Column | Type | Comment |
|---|---|---|
zookeeper_path | String | Path in zookeeper to metadata. For a queue on an auxiliary zookeeper this is the factory key <zookeeper_name>:<path>, not the raw keeper path. |
processed_nodes_count | Nullable(UInt64) | Number of nodes in the processed directory in keeper. Only set for unordered mode: in ordered mode there are no per-file processed nodes (see processed_path instead), so the value is NULL. |
processing_nodes_count | UInt64 | Number of nodes in the processing directory in keeper |
failed_nodes_count | UInt64 | Number of nodes in the failed directory in keeper |
processed_nodes | Map(String, String) | Contents (node name -> node data) of the processed directory in keeper. Only filled for unordered mode. Fetched only when this column is selected. |
processing_nodes | Map(String, String) | Contents (node name -> node data) of the processing directory in keeper. Fetched only when this column is selected. |
failed_nodes | Map(String, String) | Contents (node name -> node data) of the failed directory in keeper. Fetched only when this column is selected. |
processed_path | Map(String, String) | Last processed path per processed pointer in keeper (relative pointer path -> last processed file path). Only filled for ordered mode, where it covers the single, per-bucket and per-partition pointers. Fetched only when this column is selected. |
azure_queue_metadata_cache
Contains in-memory state of AzureQueue metadata and currently processed rows per file.
| Column | Type | Comment |
|---|---|---|
zookeeper_path | String | Path in zookeeper to metadata |
file_path | String | File path of a file which is being processed |
file_name | String | File name of a file which is being processed |
rows_processed | UInt64 | Currently processed number of rows |
status | String | Status of processing: Processed, Processing, Failed |
processing_start_time | Nullable(DateTime) | Time at which processing of the file started |
processing_end_time | Nullable(DateTime) | Time at which processing of the file ended |
exception | String | Exception which happened during processing |
azure_queue_settings
Contains a list of settings of AzureQueue tables.
| Column | Type | Comment |
|---|---|---|
database | String | Database of the table with AzureQueue engine. |
table | String | Name of the table with AzureQueue engine. |
name | String | Setting name. |
value | String | Setting value. |
type | String | Setting type (implementation specific string value). |
changed | UInt8 | 1 if the setting was explicitly defined in the config or explicitly changed. |
description | String | Setting description. |
alterable | UInt8 | Shows whether the current user can change the setting via ALTER TABLE MODIFY SETTING: 0 — Current user can't change the setting, 1 — Current user can change the setting. |
background_schedule_pool
Contains information about tasks in all BackgroundSchedulePool instances. Each row represents a task.
| Column | Type | Comment |
|---|---|---|
pool | String | Pool name. Possible values: schedule (general purpose schedule pool), buffer_flush (pool for flushing Buffer table data), distributed (pool for distributed table operations), message_broker (pool for message broker operations), streaming (pool for streaming queries background jobs), iceberg (pool for Iceberg table metadata refresh). |
database | String | Database name. |
table | String | Table name. |
table_uuid | UUID | Table UUID. |
query_id | String | Query ID (if executing now). Note: this is not a real query, but a randomly generated ID for matching logs in system.text_log. |
elapsed_ms | UInt64 | Task execution time (if executing now). |
log_name | String | Log name for the task. |
deactivated | UInt8 | Whether the task is deactivated (always false, since deactivated tasks are removed from the pool). |
scheduled | UInt8 | Whether the task is scheduled for execution. |
delayed | UInt8 | Whether the task is scheduled with delay. |
executing | UInt8 | Whether the task is currently executing. |
backups
Contains a list of all BACKUP or RESTORE operations with their current states and other properties. Note, that table is not persistent and it shows only operations executed after the last server restart.
| Column | Type | Comment |
|---|---|---|
id | String | Operation ID, can be either passed via SETTINGS id=... or be randomly generated UUID. |
name | String | Operation name, a string like Disk('backups', 'my_backup') |
base_backup_name | String | Base Backup Operation name, a string like Disk('backups', 'my_base_backup') |
query_id | String | Query ID of a query that started backup. |
status | Enum8('CREATING_BACKUP' = 0, 'BACKUP_CREATED' = 1, 'BACKUP_FAILED' = 2, 'RESTORING' = 3, 'RESTORED' = 4, 'RESTORE_FAILED' = 5, 'BACKUP_CANCELLED' = 6, 'RESTORE_CANCELLED' = 7) | Status of backup or restore operation. |
error | String | The error message if any. |
start_time | DateTime64(6) | The time when operation started. |
end_time | DateTime64(6) | The time when operation finished. |
num_files | UInt64 | The number of files stored in the backup. |
total_size | UInt64 | The total size of files stored in the backup. |
num_entries | UInt64 | The number of entries in the backup, i.e. the number of files inside the folder if the backup is stored as a folder. |
uncompressed_size | UInt64 | The uncompressed size of the backup. |
compressed_size | UInt64 | The compressed size of the backup. |
files_read | UInt64 | Returns the number of files read during RESTORE from this backup. |
bytes_read | UInt64 | Returns the total size of files read during RESTORE from this backup. |
ProfileEvents | Map(LowCardinality(String), UInt64) | All the profile events captured during this operation. |
settings | Map(LowCardinality(String), String) | Backup/restore-specific settings effectively used for this operation (from the SETTINGS clause, including defaults). Sensitive settings are not exposed. |
engine_settings | Map(LowCardinality(String), String) | Settings effectively used by the backup engine's reader/writer (e.g. S3 allow_native_copy). Empty when the operation involves more than one engine that a flat map cannot represent: incremental backups and restores, lightweight snapshot restores, and non-internal ON CLUSTER operations. |
build_options
Contains a list of all build flags, compiler options and commit hash for used build.
| Column | Type | Comment |
|---|---|---|
name | String | Name of the build option. |
value | String | Value of the build option. |
certificates
Contains information about available certificates and their sources.
| Column | Type | Comment |
|---|---|---|
version | Int32 | Version of the certificate. Values are 0 for v1, 1 for v2, 2 for v3. |
serial_number | Nullable(String) | Serial Number of the certificate assigned by the issuer. |
signature_algo | Nullable(String) | Signature Algorithm - an algorithm used by the issuer to sign this certificate. |
issuer | Nullable(String) | Issuer - a unique identifier for the Certificate Authority issuing this certificate. |
not_before | Nullable(String) | The beginning of the time window when this certificate is valid. |
not_after | Nullable(String) | The end of the time window when this certificate is valid. |
subject | Nullable(String) | Subject - identifies the owner of the public key. |
pkey_algo | Nullable(String) | Public Key Algorithm defines the algorithm the public key can be used with. |
path | String | Path to the file or directory containing this certificate. |
default | UInt8 | Certificate is in the default certificate location. |
protocol | String | Protocol name if certificate is from per-protocol TLS config, otherwise empty. |
clusters
Contains information about clusters defined in the configuration file or generated by a Replicated database.
| Column | Type | Comment |
|---|---|---|
cluster | String | The cluster name. |
shard_num | UInt32 | The shard number in the cluster, starting from 1. |
shard_name | String | The name of the shard in the cluster. |
shard_weight | UInt32 | The relative weight of the shard when writing data. |
internal_replication | UInt8 | Flag that indicates whether this host is a part on ensemble which can replicate the data on its own. |
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. |
is_local | UInt8 | Flag that indicates whether the host is local. |
user | String | The name of the user for connecting to the server. |
default_database | String | The default database name. |
errors_count | UInt32 | The number of times this host failed to reach replica. |
slowdowns_count | UInt32 | The number of slowdowns that led to changing replica when establishing a connection with hedged requests. |
estimated_recovery_time | UInt32 | Seconds remaining until the replica error count is zeroed and it is considered to be back to normal. |
database_shard_name | String | The name of the Replicated database shard (for clusters that belong to a Replicated database). |
database_replica_name | String | The name of the Replicated database replica (for clusters that belong to a Replicated database). |
is_shared_catalog_cluster | UInt8 | Bool indicating if the cluster belongs to shared catalog. |
is_active | Nullable(UInt8) | The status of the Replicated database replica (for clusters that belong to a Replicated database): 1 means 'replica is online', 0 means 'replica is offline', NULL means 'unknown'. |
unsynced_after_recovery | Nullable(UInt8) | Indicates if a Replicated database replica has replication lag more than max_replication_lag_to_enqueue after creating or recovering the replica. |
replication_lag | Nullable(UInt32) | The replication lag of the Replicated database replica (for clusters that belong to a Replicated database). |
recovery_time | Nullable(UInt64) | The recovery time of the Replicated database replica (for clusters that belong to a Replicated database), in milliseconds. |
name | String | — |
codecs
Contains information about system codecs.
| Column | Type | Comment |
|---|---|---|
name | String | Codec name. |
method_byte | UInt8 | Byte which indicates codec in compressed file. |
is_compression | UInt8 | True if this codec compresses something. Otherwise it can be just a transformation that helps compression. |
is_generic_compression | UInt8 | The codec is a generic compression algorithm like lz4, zstd. |
is_encryption | UInt8 | The codec encrypts. |
is_timeseries_codec | UInt8 | The codec is for floating point timeseries codec. |
is_experimental | UInt8 | The codec is experimental. |
description | String | A high-level description of the codec. |
collations
Contains a list of all available collations for alphabetical comparison of strings.
| Column | Type | Comment |
|---|---|---|
name | String | Name of the collation. |
language | Nullable(String) | The language. |
columns
Lists all columns from all tables of the current server.
| Column | Type | Comment |
|---|---|---|
database | String | Database name. |
table | String | Table name. |
name | String | Column name. |
type | String | Column type. |
position | UInt64 | Ordinal position of a column in a table starting with 1. |
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. |
compression_codec | String | Compression codec name. |
character_octet_length | Nullable(UInt64) | Maximum length in bytes for binary data, character data, or text data and images. In RawTree makes sense only for FixedString data type. Otherwise, the NULL value is returned. |
numeric_precision | Nullable(UInt64) | Accuracy of approximate numeric data, exact numeric data, integer data, or monetary data. In RawTree it is bit width for integer types and decimal precision for Decimal types. Otherwise, the NULL value is returned. |
numeric_precision_radix | Nullable(UInt64) | The base of the number system is the accuracy of approximate numeric data, exact numeric data, integer data or monetary data. In RawTree it's 2 for integer types and 10 for Decimal types. Otherwise, the NULL value is returned. |
numeric_scale | Nullable(UInt64) | The scale of approximate numeric data, exact numeric data, integer data, or monetary data. In RawTree makes sense only for Decimal types. Otherwise, the NULL value is returned. |
datetime_precision | Nullable(UInt64) | Decimal precision of DateTime64 data type. For other data types, the NULL value is returned. |
serialization_hint | Nullable(String) | A hint for column to choose serialization on inserts according to statistics. |
statistics | String | The types of statistics created in this columns. |
column | String | — |
completions
Contains a list of completion tokens.
| Column | Type | Comment |
|---|---|---|
word | String | Completion token. |
context | String | Token entity kind (e.g. table). |
belongs | Nullable(String) | Token for entity, this token belongs to (e.g. name of owning database). |
constraints
Contains all the information about all the constraints in tables, similar to system.data_skipping_indices.
| Column | Type | Comment |
|---|---|---|
database | String | Database name. |
table | String | Table name. |
name | String | Constraint name. |
type | Enum8('CHECK' = 0, 'ASSUME' = 1) | Constraint type. |
expression | String | Constraint expression. |
contributors
Contains a list of all RawTree contributors <3
| Column | Type | Comment |
|---|---|---|
name | String | Contributor (author) name from git log. |
current_roles
Contains active roles of a current user. SET ROLE changes the contents of this table.
| Column | Type | Comment |
|---|---|---|
role_name | String | Role name. |
with_admin_option | UInt8 | 1 if the role has ADMIN OPTION privilege. |
is_default | UInt8 | 1 if role is set to be a default. |
dashboards
Contains queries used by /dashboard page accessible though HTTP interface. This table can be useful for monitoring and troubleshooting. The table contains a row for every chart in a dashboard.
| Column | Type | Comment |
|---|---|---|
dashboard | String | The dashboard name. |
title | String | The title of a chart. |
query | String | The query to obtain data to be displayed. |
data_skipping_index_types
Contains a list of all available data skipping index types along with their embedded documentation.
| Column | Type | Comment |
|---|---|---|
name | String | The name of the data skipping index type, as specified in the TYPE of an INDEX declaration. |
description | String | A high-level description of what the data skipping index type does. |
syntax | String | How the index is declared in an INDEX clause of a CREATE TABLE query. |
examples | String | Usage examples. |
introduced_in | String | The ClickHouse version in which the index type was first introduced, in the form major.minor. |
related | Array(String) | The names of related data skipping index types. |
data_skipping_indices
Contains all the information about all the data skipping indices in tables, similar to system.columns.
| Column | Type | Comment |
|---|---|---|
database | String | Database name. |
table | String | Table name. |
name | String | Index name. |
type | String | Index type. |
type_full | String | Index type expression from create statement. |
expr | String | Expression for the index calculation. |
creation | Enum8('Explicit' = 0, 'Implicit' = 1) | Whether the index was created implicitly (via add_minmax_index_for_numeric_columns or similar) |
granularity | UInt64 | The number of granules in the block. |
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. |
data_type_families
Contains a list of all available native data types along with all the aliases used for compatibility with other DBMS.
| Column | Type | Comment |
|---|---|---|
name | String | Data type name. |
case_insensitive | UInt8 | Property that shows whether you can use a data type name in a query in case insensitive manner or not. For example, Date and date are both valid. |
alias_to | String | Data type name for which name is an alias. |
description | String | A high-level description of what the data type is. |
syntax | String | How the data type is spelled in a query. |
examples | String | Usage examples. |
introduced_in | String | The ClickHouse version in which the data type was first introduced, in the form major.minor. |
related | Array(String) | The names of related data types. |
database_engines
Contains a list of all available database engines
| Column | Type | Comment |
|---|---|---|
name | String | The name of database engine. |
description | String | A high-level description of what the database engine does. |
syntax | String | How the database engine is specified in the ENGINE clause of a CREATE DATABASE query. |
examples | String | Usage examples. |
introduced_in | String | The ClickHouse version in which the database engine was first introduced, in the form major.minor. |
related | Array(String) | The names of related database engines. |
database_replicas
Contains information and status of all database replicas on current server. Each database replica is represented by a single row.
| Column | Type | Comment |
|---|---|---|
database | String | The name of the Replicated database is in. |
is_readonly | UInt8 | Whether the database replica is in read-only mode. |
max_log_ptr | Int32 | Maximum entry number in the log of general activity. |
replica_name | String | Replica name in RawTree Keeper. |
replica_path | String | Path to replica data in RawTree Keeper. |
zookeeper_path | String | Path to database data in RawTree Keeper. |
shard_name | String | The name of the shard in the cluster. |
log_ptr | Int32 | Maximum entry number in the log of general activity that the replica copied to its execution queue, plus one. |
total_replicas | UInt32 | The total number of known replicas of this database. |
zookeeper_exception | String | The last exception message, got if the error happened when fetching the info from RawTree Keeper. |
is_session_expired | UInt8 | The session with RawTree Keeper has expired. Basically the same as is_readonly. |
databases
Lists all databases of the current server.
| Column | Type | Comment |
|---|---|---|
name | String | Database name. |
engine | String | Database engine. |
data_path | String | Data path. |
metadata_path | String | Metadata path. |
uuid | UUID | Database UUID. |
engine_full | String | Parameters of the database engine. |
comment | String | Database comment. |
is_external | UInt8 | Database is external (i.e. PostgreSQL/DataLakeCatalog). |
database | String | — |
detached_parts
Contains a list of all parts which are being found in /detached directory along with a reason why it was detached. RawTree server doesn't use such parts anyhow.
| Column | Type | Comment |
|---|---|---|
database | String | The name of the database this part belongs to. |
table | String | The name of the table this part belongs to. |
partition_id | Nullable(String) | The identifier of the partition this part belongs to. |
name | String | The name of the part. |
bytes_on_disk | UInt64 | Total size of all the data part files in bytes. |
modification_time | DateTime | The time the directory with the data part was modified. This usually corresponds to the time when detach happened. |
disk | String | The name of the disk that stores this data part. |
path | String | The path of the disk to the file of this data part. |
reason | Nullable(String) | The explanation why this part was detached. |
min_block_number | Nullable(Int64) | The minimum number of data parts that make up the current part after merging. |
max_block_number | Nullable(Int64) | The maximum number of data parts that make up the current part after merging. |
level | Nullable(UInt32) | Depth of the merge tree. Zero means that the current part was created by insert rather than by merging other parts. |
detached_tables
Lists all detached tables of the current server.
| Column | Type | Comment |
|---|---|---|
database | String | The name of the database the table is in. |
table | String | Table name. |
uuid | UUID | Table uuid (Atomic database). |
metadata_path | String | Path to the table metadata in the file system. |
is_permanently | UInt8 | Table was detached permanently. |
dictionaries
Contains information about dictionaries.
| Column | Type | Comment |
|---|---|---|
database | String | Name of the database containing the dictionary created by DDL query. Empty string for other dictionaries. |
name | String | Dictionary name. |
uuid | UUID | Dictionary UUID. |
status | Enum8('NOT_LOADED' = 0, 'LOADED' = 1, 'FAILED' = 2, 'LOADING' = 3, 'FAILED_AND_RELOADING' = 4, 'LOADED_AND_RELOADING' = 5, 'NOT_EXIST' = 6) | Dictionary status. Possible values: NOT_LOADED — Dictionary not currently loaded in memory, LOADED — Dictionary loaded successfully, FAILED — Unable to load the dictionary as a result of an error, LOADING — Dictionary is loading now, LOADED_AND_RELOADING — Dictionary is loaded successfully, and is being reloaded right now (frequent reasons: SYSTEM RELOAD DICTIONARY query, timeout, dictionary config has changed), FAILED_AND_RELOADING — Could not load the dictionary as a result of an error and is loading now. |
origin | String | Path to the configuration file that describes the dictionary. |
type | String | Type of a dictionary allocation. Storing Dictionaries in Memory. |
key.names | Array(String) | Array of key names provided by the dictionary. |
key.types | Array(String) | Corresponding array of key types provided by the dictionary. |
attribute.names | Array(String) | Array of attribute names provided by the dictionary. |
attribute.types | Array(String) | Corresponding array of attribute types provided by the dictionary. |
bytes_allocated | UInt64 | Amount of RAM allocated for the dictionary. |
hierarchical_index_bytes_allocated | UInt64 | Amount of RAM allocated for hierarchical index. |
query_count | UInt64 | Number of queries since the dictionary was loaded or since the last successful reboot. |
hit_rate | Float64 | For cache dictionaries, the percentage of uses for which the value was in the cache. |
found_rate | Float64 | The percentage of uses for which the value was found. |
element_count | UInt64 | Number of items stored in the dictionary. |
load_factor | Float64 | Percentage filled in the dictionary (for a hashed dictionary, the percentage filled in the hash table). |
source | String | Text describing the data source for the dictionary. |
lifetime_min | UInt64 | Minimum lifetime of the dictionary in memory, after which RawTree tries to reload the dictionary (if invalidate_query is set, then only if it has changed). Set in seconds. |
lifetime_max | UInt64 | Maximum lifetime of the dictionary in memory, after which RawTree tries to reload the dictionary (if invalidate_query is set, then only if it has changed). Set in seconds. |
loading_start_time | DateTime | Start time for loading the dictionary. |
last_successful_update_time | DateTime | End time for loading or updating the dictionary. Helps to monitor some troubles with dictionary sources and investigate the causes. |
error_count | UInt64 | Number of errors since last successful loading. Helps to monitor some troubles with dictionary sources and investigate the causes. |
loading_duration | Float32 | Duration of a dictionary loading. |
last_exception | String | Text of the error that occurs when creating or reloading the dictionary if the dictionary couldn't be created. |
comment | String | Text of the comment to dictionary. |
dictionary_layouts
Contains a list of all available dictionary layouts along with their embedded documentation.
| Column | Type | Comment |
|---|---|---|
name | String | The name of the dictionary layout, as specified in the LAYOUT clause. |
is_complex | UInt8 | Whether the layout requires a complex key (a key consisting of several attributes or of a non-integer type). |
description | String | A description of what the dictionary layout does. For layouts that have a dedicated documentation page, this contains the full Markdown body of that page; for the remaining layouts it is a concise summary. |
syntax | String | How the layout is specified in the LAYOUT clause of a CREATE DICTIONARY query. |
examples | String | Usage examples. |
introduced_in | String | The ClickHouse version in which the layout was first introduced, in the form major.minor. |
related | Array(String) | The names of related dictionary layouts. |
dictionary_sources
Contains a list of all available dictionary sources along with their embedded documentation.
| Column | Type | Comment |
|---|---|---|
name | String | The name of the dictionary source, as specified in the SOURCE clause. |
description | String | A description of what the dictionary source does. For sources that have a dedicated documentation page, this contains the full Markdown body of that page; for the remaining sources it is a concise summary. |
syntax | String | The structure of the SOURCE clause used to specify the source. Note that some sources are subject to access control when a dictionary is created from a DDL query (as opposed to a server configuration file); see the description of the individual source for details. |
examples | String | Usage examples. |
introduced_in | String | The ClickHouse version in which the source was first introduced, in the form major.minor. |
related | Array(String) | The names of related dictionary sources. |
dimensional_metrics
Contains dimensional metrics, which have multiple dimensions (labels) to provide more granular information. For example, counting failed merges by their error code. This table is always up to date.
| Column | Type | Comment |
|---|---|---|
metric | String | Metric name. |
value | Float64 | Metric value. |
description | String | Metric description. |
labels | Map(String, String) | Metric labels. |
name | String | — |
disk_types
Contains a list of all available disk types along with their embedded documentation.
| Column | Type | Comment |
|---|---|---|
name | String | The name of the disk type, as specified in the type of a disk configuration. |
description | String | A high-level description of what the disk type does. |
syntax | String | How the disk type is specified in a disk configuration. |
examples | String | Usage examples. |
introduced_in | String | The ClickHouse version in which the disk type was first introduced, in the form major.minor. |
related | Array(String) | The names of related disk types. |
disks
Contains information about disks defined in the server configuration.
| Column | Type | Comment |
|---|---|---|
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. |
unreserved_space | UInt64 | Free space which is not taken by reservations (free_space minus the size of reservations taken by merges, inserts, and other disk write operations currently running). |
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. |
type | String | The disk type which tells where this disk stores the data - RAM, local drive or remote storage. |
object_storage_type | String | Type of object storage if disk type is object_storage |
metadata_type | String | Type of metadata storage if disk type is object_storage |
is_encrypted | UInt8 | Flag which shows whether this disk encrypts the underlying data. |
is_read_only | UInt8 | Flag which indicates that you can only perform read operations with this disk. |
is_write_once | UInt8 | Flag which indicates if disk is write-once. Which means that it does support BACKUP to this disk, but does not support INSERT into MergeTree table on this disk. |
is_remote | UInt8 | Flag which indicated what operations with this disk involve network interaction. |
is_broken | UInt8 | Flag which indicates if disk is broken. Broken disks will have 0 space and cannot be used. |
cache_path | String | The path to the cache directory on local drive in case when the disk supports caching. |
distributed_ddl_queue
Contains information about distributed DDL queries (ON CLUSTER clause) that were executed on a cluster.
| Column | Type | Comment |
|---|---|---|
entry | String | Query id. |
entry_version | Nullable(UInt8) | Version of the entry. |
initiator_host | Nullable(String) | Host that initiated the DDL operation. |
initiator_port | Nullable(UInt16) | Port used by the initiator. |
cluster | String | Cluster name, empty if not determined. |
query | String | Query executed. |
settings | Map(String, String) | Settings used in the DDL operation. |
query_create_time | DateTime | Query created time. |
host | Nullable(String) | Hostname. |
port | Nullable(UInt16) | Host Port. |
status | Nullable(Enum8('Inactive' = 0, 'Active' = 1, 'Finished' = 2, 'Removing' = 3, 'Unknown' = 4)) | Status of the query. |
exception_code | Nullable(UInt16) | Exception code. |
exception_text | Nullable(String) | Exception message. |
query_finish_time | Nullable(DateTime) | Query finish time. |
query_duration_ms | Nullable(UInt64) | Duration of query execution (in milliseconds). |
distribution_queue
Contains information about local files that are in the queue to be sent to the shards. These local files contain new parts that are created by inserting new data into the Distributed table in asynchronous mode.
| Column | Type | Comment |
|---|---|---|
database | String | Name of the database. |
table | String | Name of the table. |
data_path | String | Path to the folder with local files. |
is_blocked | UInt8 | Flag indicates whether sending local files to the server is blocked. |
error_count | UInt64 | Number of errors. |
data_files | UInt64 | Number of local files in a folder. |
data_compressed_bytes | UInt64 | Size of compressed data in local files, in bytes. |
broken_data_files | UInt64 | Number of files that has been marked as broken (due to an error). |
broken_data_compressed_bytes | UInt64 | Size of compressed data in broken files, in bytes. |
last_exception | String | Text message about the last error that occurred (if any). |
last_exception_time | DateTime | Time when last exception occurred. |
dns_cache
Contains information about cached DNS records.
| Column | Type | Comment |
|---|---|---|
hostname | String | Hostname. |
ip_address | String | IP address. |
ip_family | Enum8('IPv4' = 0, 'IPv6' = 1, 'UNIX_LOCAL' = 2) | IP address family. |
cached_at | DateTime | Record cached timestamp. |
documentation
Collects the embedded documentation of the components of the system (functions, table engines, data types, settings, profile events, metrics, system tables, etc.) into a single table, with the reference documentation rendered as Markdown and the path to the source file where it is defined.
| Column | Type | Comment |
|---|---|---|
name | String | The name of the entity, e.g. domainWithoutWWW or MergeTree. |
type | Enum8('Function' = 1, 'Aggregate Function' = 2, 'Table Function' = 3, 'Table Engine' = 4, 'Database Engine' = 5, 'Data Type' = 6, 'Dictionary Layout' = 7, 'Dictionary Source' = 8, 'Aggregate Function Combinator' = 9, 'Data Skipping Index' = 10, 'Disk Type' = 11, 'Setting' = 12, 'MergeTree Setting' = 13, 'Server Setting' = 14, 'Format' = 15, 'Compression Codec' = 16, 'Profile Event' = 17, 'Current Metric' = 18, 'Asynchronous Metric' = 19, 'System Table' = 20) | The kind of the entity, e.g. Function or Table Engine. |
description | String | The reference documentation of the entity rendered as Markdown, assembled from the embedded documentation (the same content as published on the website), including syntax, examples and other structured parts, if any. |
source | String | The path to the source file where the entity's documentation is defined, relative to the repository root. Empty if the source location is unknown. |
dropped_tables
Contains a list of tables which were dropped from Atomic databases but not completely removed yet.
| Column | Type | Comment |
|---|---|---|
index | UInt32 | Index in marked_dropped_tables queue. |
database | String | Database name. |
table | String | Table name. |
uuid | UUID | Table UUID. |
engine | String | Table engine name. |
metadata_dropped_path | String | Path of table's metadata file in metadata_dropped directory. |
table_dropped_time | DateTime | The time when the next attempt to remove table's data is scheduled on. Usually it's the table when the table was dropped plus database_atomic_delay_before_drop_table_sec. |
dropped_tables_parts
Contains parts of system.dropped_tables tables
| Column | Type | Comment |
|---|---|---|
partition | String | Partition identifier (string representation derived from the table partition key expression). |
name | String | Name of the data part. The part naming structure can be used to determine many aspects of the data, ingest, and merge patterns. The part naming format is the following: text <partition_id>_<minimum_block_number>_<maximum_block_number>_<level>_<data_version> * Definitions: - partition_id - identifies the partition key - minimum_block_number - identifies the minimum block number in the part. RawTree always merges continuous blocks - maximum_block_number - identifies the maximum block number in the part - level - incremented by one with each additional merge on the part. A level of 0 indicates this is a new part that has not been merged. It is important to remember that all parts in RawTree are always immutable - data_version - optional value, incremented when a part is mutated (again, mutated data is always only written to a new part, since parts are immutable) |
uuid | UUID | The UUID of data part. |
part_type | String | The data part storing format. Possible values: Wide — each column is stored in a separate file, Compact — all columns are stored in one file. Data storing format is controlled by the min_bytes_for_wide_part and min_rows_for_wide_part settings of the MergeTree table. |
part_storage_type | String | The type of DataPartStorage. Possible values: Packed - most part files are stored in a single archive (projections and a few service files such as txn_version.txt are written separately), Full - each file is stored separately. |
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 about to be deleted. Inactive data parts appear after merging and mutating operations. |
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 does not work for adaptive granularity). |
rows | UInt64 | The number of rows. |
files | UInt64 | The number of files in the data part. |
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. |
primary_key_size | UInt64 | The amount of memory (in bytes) used by primary key values in the primary.idx/cidx file on disk. |
marks_bytes | UInt64 | The size of the file with marks. |
secondary_indices_compressed_bytes | UInt64 | Total size of compressed data for secondary indices in the data part. All the auxiliary files (for example, files with marks) are not included. |
secondary_indices_uncompressed_bytes | UInt64 | Total size of uncompressed data for secondary indices in the data part. All the auxiliary files (for example, files with marks) are not included. |
secondary_indices_marks_bytes | UInt64 | The size of the file with marks for secondary indices. |
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 | Int64 | The minimum number of data parts that make up the current part after merging. |
max_block_number | Int64 | 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. Will be 0 when primary_key_lazy_load is enabled and the key is not loaded. When non-zero the bytes live in the part itself and are accounted within jemalloc.mergetree_arena.active_bytes. They are NEVER counted in PrimaryIndexCacheBytes — those are mutually exclusive per part: an index lives either in the part (this metric) or in the shared PrimaryIndexCache (the other), depending on primary_key_lazy_load and use_primary_key_cache. |
primary_key_bytes_in_memory_allocated | UInt64 | The amount of memory (in bytes) reserved for primary key values. Will be 0 when primary_key_lazy_load is enabled and the key is not loaded. When non-zero, included in jemalloc.mergetree_arena.active_bytes. See the note on primary_key_bytes_in_memory for the relationship with PrimaryIndexCacheBytes. |
index_granularity_bytes_in_memory | UInt64 | The amount of memory (in bytes) used by index granularity values (will be 0 in case of primary_key_lazy_load=1 and use_primary_key_cache=1). When non-zero the bytes are part-owned and accounted within jemalloc.mergetree_arena.active_bytes. |
index_granularity_bytes_in_memory_allocated | UInt64 | The amount of memory (in bytes) reserved for index granularity values (will be 0 in case of primary_key_lazy_load=1 and use_primary_key_cache=1). When non-zero, included in jemalloc.mergetree_arena.active_bytes. |
is_frozen | UInt8 | Flag that shows that a partition data backup exists. 1, the backup exists. 0, the backup does not 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. |
disk_name | String | Name of a disk that stores the data part. |
path | String | Absolute path to the folder with data part files. |
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. |
delete_ttl_info_min | DateTime | The minimum value of the date and time key for TTL DELETE rule. |
delete_ttl_info_max | DateTime | The maximum value of the date and time key for TTL DELETE rule. |
move_ttl_info.expression | Array(String) | Array of expressions. Each expression defines a TTL MOVE rule. |
move_ttl_info.min | Array(DateTime) | Array of date and time values. Each element describes the minimum key value for a TTL MOVE rule. |
move_ttl_info.max | Array(DateTime) | Array of date and time values. Each element describes the maximum key value for a TTL MOVE rule. |
default_compression_codec | String | The name of the codec used to compress this data part when a column has no explicit codec or uses CODEC(Default). With enable_adaptive_codec_selection, individual blocks of such columns may use other codecs; see mergeTreeCodecBlockCounts. |
recompression_ttl_info.expression | Array(String) | The TTL expression. |
recompression_ttl_info.min | Array(DateTime) | The minimum value of the calculated TTL expression within this part. Used to understand whether we have at least one row with expired TTL. |
recompression_ttl_info.max | Array(DateTime) | The maximum value of the calculated TTL expression within this part. Used to understand whether we have all rows with expired TTL. |
group_by_ttl_info.expression | Array(String) | The TTL expression. |
group_by_ttl_info.min | Array(DateTime) | The minimum value of the calculated TTL expression within this part. Used to understand whether we have at least one row with expired TTL. |
group_by_ttl_info.max | Array(DateTime) | The maximum value of the calculated TTL expression within this part. Used to understand whether we have all rows with expired TTL. |
rows_where_ttl_info.expression | Array(String) | The TTL expression. |
rows_where_ttl_info.min | Array(DateTime) | The minimum value of the calculated TTL expression within this part. Used to understand whether we have at least one row with expired TTL. |
rows_where_ttl_info.max | Array(DateTime) | The maximum value of the calculated TTL expression within this part. Used to understand whether we have all rows with expired TTL. |
projections | Array(String) | The list of projection names calculated for this part. |
secondary_indices.name | Array(String) | The names of secondary (data skipping) indices materialized in this part. An index declared in the table but missing here was not built for this part yet (see ALTER TABLE ... MATERIALIZE INDEX). |
secondary_indices.data_compressed_bytes | Array(UInt64) | The size of compressed data of each secondary index in the data part, in the same order as secondary_indices.name. |
secondary_indices.data_uncompressed_bytes | Array(UInt64) | The size of uncompressed data of each secondary index in the data part, in the same order as secondary_indices.name. |
secondary_indices.marks_bytes | Array(UInt64) | The size of the file with marks of each secondary index in the data part, in the same order as secondary_indices.name. |
visible | UInt8 | Flag which indicated whether this part is visible for SELECT queries. |
creation_tid | Tuple(UInt64, UInt64, UUID) | ID of transaction that has created/is trying to create this object. |
removal_tid_lock | UInt64 | Hash of removal_tid, used to lock an object for removal. |
removal_tid | Tuple(UInt64, UInt64, UUID) | ID of transaction that has removed/is trying to remove this object |
creation_csn | UInt64 | CSN of transaction that has created this object |
removal_csn | UInt64 | CSN of transaction that has removed this object |
has_lightweight_delete | UInt8 | The flag which indicated whether the part has lightweight delete mask. |
last_removal_attempt_time | DateTime | The last time the server tried to delete this part. |
removal_state | String | The current state of part removal process. |
sorting_key | String | The per-part sorting key expression for raw tables. Empty for regular tables or parts without a per-part key. |
is_unique_by_sorting_key | UInt8 | For raw tables, whether no two rows of the part have the same per-part sorting key (sorting_key), as after an insert with optimize_on_insert or a merge with replacing_enable. 0 for regular tables. |
filter_columns_stats | Map(String, UInt64) | Per-part column access statistics for raw tables. Maps column names that appeared in WHERE/PREWHERE predicates to the number of times they were accessed. |
bytes | UInt64 | — |
marks_size | UInt64 | — |
part_name | String | — |
enabled_roles
Contains all active roles at the moment, including current role of the current user and granted roles for current role.
| Column | Type | Comment |
|---|---|---|
role_name | String | Role name. |
with_admin_option | UInt8 | 1 if the role has ADMIN OPTION privilege. |
is_current | UInt8 | Flag that shows whether enabled_role is a current role of a current user. |
is_default | UInt8 | Flag that shows whether enabled_role is a default role. |
errors
Contains a list of all errors which have ever happened including the error code, last time and message with unsymbolized stacktrace.
| Column | Type | Comment |
|---|---|---|
name | String | Name of the error (errorCodeToName). |
code | Int32 | Code number of the error. |
value | UInt64 | The number of times this error happened. |
last_error_time | DateTime | The time when the last error happened. |
last_error_message | String | Message for the last error. |
last_error_format_string | String | Format string for the last error. |
last_error_trace | Array(UInt64) | A stack trace that represents a list of physical addresses where the called methods are stored. |
remote | UInt8 | Remote exception (i.e. received during one of the distributed queries). |
query_id | String | Id of a query that caused an error (if available). |
events
Contains profiling events and their current value.
| Column | Type | Comment |
|---|---|---|
event | String | Event name. |
value | UInt64 | Number of events occurred. |
description | String | Event description. |
name | String | — |
fail_points
Contains a list of all available failpoints with their type and enabled status. Only available in debug builds.
| Column | Type | Comment |
|---|---|---|
name | String | Name of the failpoint. |
type | Enum8('once' = 0, 'regular' = 1, 'pauseable_once' = 2, 'pauseable' = 3) | Type of failpoint: 'once' fires a single time then auto-disables, 'regular' fires every time, 'pauseable_once' blocks execution once, 'pauseable' blocks execution every time until resumed. |
enabled | UInt8 | Whether the failpoint is currently enabled (1) or disabled (0). |
filesystem_cache
Contains information about all entries inside filesystem cache for remote objects.
| Column | Type | Comment |
|---|---|---|
cache_name | String | Name of the cache object. Can be used in SYSTEM DESCRIBE FILESYSTEM CACHE <name>, SYSTEM DROP FILESYSTEM CACHE <name> commands |
cache_base_path | String | Path to the base directory where all cache files (of a cache identified by cache_name) are stored. |
cache_path | String | Path to a particular cache file, corresponding to a file segment in a source file |
key | String | Cache key of the file segment |
file_segment_range_begin | UInt64 | Offset corresponding to the beginning of the file segment range |
file_segment_range_end | UInt64 | Offset corresponding to the (including) end of the file segment range |
size | UInt64 | Size of the file segment |
state | String | File segment state (DOWNLOADED, DOWNLOADING, PARTIALLY_DOWNLOADED, ...) |
finished_download_time | DateTime | Time when file segment finished downloading. |
cache_hits | UInt64 | Number of cache hits of corresponding file segment |
references | UInt64 | Number of references to corresponding file segment. Value 1 means that nobody uses it at the moment (the only existing reference is in cache storage itself) |
downloaded_size | UInt64 | Downloaded size of the file segment |
kind | String | File segment kind (used to distinguish between file segments added as a part of 'Temporary data in cache') |
unbound | UInt8 | Internal implementation flag |
user_id | String | User id of the user which created the file segment |
segment_type | String | Type of the segment. Used to separate data files(.json, .txt and etc) from data file(.bin, mark files). |
file_size | Nullable(UInt64) | File size of the file to which current file segment belongs |
filesystem_cache_settings
Contains information about all filesystem cache settings
| Column | Type | Comment |
|---|---|---|
cache_name | String | Cache name |
path | String | Cache directory path |
max_size | UInt64 | Maximum cache size |
max_elements | UInt64 | Maximum number of cache elements, e.g. file segments (limits number of files on filesystem) |
max_file_segment_size | UInt64 | Maximum size of a single file segment |
boundary_alignment | UInt64 | File segment alignment |
reserve_granularity | UInt64 | Maximum size to reserve ahead of the downloaded size of a file segment, to take the cache lock less often. Starts from 0 for each reader/writer and grows with its repeated reservations up to this value. 0 disables reserve-ahead. |
cache_on_write_operations | UInt8 | Enables write-through cache (cache on INSERT and MERGE) |
cache_policy | String | Cache eviction policy |
slru_size_ratio | Float64 | SLRU cache policy size ratio of protected to probationary elements |
background_download_threads | UInt64 | Number of background download threads. Value 0 disables background download |
background_download_queue_size_limit | UInt64 | Size of background download queue. Value 0 disables background download |
background_download_max_file_segment_size | UInt64 | Maximum size which can be downloaded in background download |
load_metadata_threads | UInt64 | Maximum number of threads used to load cache metadata at server startup |
load_metadata_asynchronously | UInt8 | Enables asynchronous loading of metadata on server startup |
keep_free_space_size_ratio | Float64 | A ratio of free space which cache would try to uphold in the background |
keep_free_space_elements_ratio | Float64 | A ratio of free elements which cache would try to uphold in the background |
keep_free_space_remove_batch | UInt64 | A remove batch size of cache elements made by background thread which upholds free space/elements ratio |
keep_free_space_eviction_threads | UInt64 | Number of threads which perform the actual file segment removal (filesystem deletion) for the background free space/elements ratio keeping. The single background thread collects eviction candidates and frees their priority queue entries, while these threads do the lock-free removal in parallel |
invalidated_entries_cleanup_interval_ms | UInt64 | Idle interval in milliseconds of the background task which purges invalidated (lazily-removed) priority queue entries |
invalidated_entries_cleanup_threshold | UInt64 | Number of accumulated invalidated priority queue entries which triggers their background removal |
invalidated_entries_cleanup_remove_batch | UInt64 | Maximum number of invalidated priority queue entries removed under a single write lock per background iteration |
enable_filesystem_query_cache_limit | UInt8 | Enable limiting maximum size of cache which can be written within a query |
cache_hits_threshold | UInt64 | Deprecated setting |
enable_bypass_cache_with_threshold | UInt8 | Undocumented. Not recommended for use |
bypass_cache_threshold | UInt64 | Undocumented. Not recommended for use |
write_cache_per_user_id_directory | UInt8 | Internal RawTree Cloud setting |
allow_dynamic_cache_resize | UInt8 | Allow dynamic resize of filesystem cache |
dynamic_resize_lock_wait_ms | UInt64 | Timeout in milliseconds to acquire the dynamic resize exclusive lock before skipping the resize attempt |
max_size_ratio_to_total_space | Float64 | Ratio of max_size to total disk space |
skip_cache_on_disk_failure | UInt8 | If true, bypass filesystem cache operations silently on disk IO errors. If false (default), disk IO errors are propagated as startup failures. |
use_split_cache | UInt8 | Use separation of files to system/data. |
split_cache_ratio | Float64 | Ratio of system segment to total size of cache for split_cache. |
system_cache_extensions | String | Comma-separated list of file extensions that are classified as system cache segments when use_split_cache is enabled. When changed, existing cache entries remain in their previous segment type and are evicted naturally over time. Restart is required to change this setting. |
overcommit_eviction_evict_step | UInt64 | Eviction step in bytes for overcommit eviction policy. Used for keep_free_space_*_ratio settings |
check_cache_probability | Float64 | Works only for debug or sanitizer build. Checks cache correctness by going through all cache and checking state of each cache element |
idle_client_ttl_sec | UInt64 | If non-zero and write_cache_per_user_id_directory is enabled, all cache entries that belong to a client (user_id) which has not been accessed for this many seconds are fully removed from the cache. Each access by the client refreshes the timer. Default is 1 week. Used by the distributed cache server. |
idle_client_check_interval_sec | UInt64 | How often the idle client eviction task runs, in seconds. Only meaningful when idle_client_ttl_sec is non-zero. 0 means an automatic value (max(1, idle_client_ttl_sec / 10)). |
idle_client_eviction_threads | UInt64 | Maximum number of threads used to purge idle clients' cache. Only meaningful when idle_client_ttl_sec is non-zero. |
expose_prometheus_eviction_metrics | UInt8 | Expose Prometheus metrics for filesystem cache eviction activity (filesystem_cache_evictions_total etc.). Off by default. Can be toggled at runtime via SYSTEM RELOAD CONFIG. |
expose_prometheus_eviction_metrics_per_user | UInt8 | Additionally expose per-user-id eviction metrics. Requires expose_prometheus_eviction_metrics. Cardinality grows with distinct evicting users. |
drop_cache_threads | UInt64 | Maximum number of threads used to remove cache keys in parallel on SYSTEM DROP FILESYSTEM CACHE. Value 1 means the removal is performed by the query thread alone |
is_initialized | UInt8 | Indicates whether cache was successfully initialized |
current_size | UInt64 | Current cache size |
current_elements_num | UInt64 | Current cache elements (file segments) number |
formats
Contains a list of all the formats along with flags whether a format is suitable for input/output or whether it supports parallelization.
| Column | Type | Comment |
|---|---|---|
name | String | Format name. |
is_input | UInt8 | Flag that indicates whether the format is suitable for data input. |
is_output | UInt8 | Flag that indicates whether the format is suitable for data output. |
supports_parallel_parsing | UInt8 | Flag that indicates whether the format supports parallel parsing. |
supports_parallel_formatting | UInt8 | Flag that indicates whether the format supports parallel formatting. |
is_tty_friendly | UInt8 | Flag that indicates whether the format usually displays fine in the terminal. For other formats, CLI will ask before output. |
content_type | String | HTTP Content-Type corresponding to the output format. May depend on the current format settings. |
supports_random_access | UInt8 | Flag that indicates whether the format supports random access in the input. |
has_schema_inference | UInt8 | The format can dynamically determine the schema from the data (either from embedded header/metadata or from the piece of data). |
has_external_schema | UInt8 | The format either has a fixed schema or accepts a predefined schema in its own format. |
prefers_large_blocks | UInt8 | The format will write larger blocks into output and generate larger blocks on input. |
supports_append | UInt8 | It's possible to append into a single file with this format. |
supports_subsets_of_columns | UInt8 | The input format can recognize when certain columns are omitted. |
description | String | A high-level description of what the format is. |
examples | String | Usage examples. |
introduced_in | String | The ClickHouse version in which the format was first introduced, in the form major.minor. |
related | Array(String) | The names of related formats. |
functions
Contains a list of all available ordinary and aggregate functions with their descriptions.
| Column | Type | Comment |
|---|---|---|
name | String | The name of the function. |
is_aggregate | UInt8 | Whether the function is an aggregate function. |
case_insensitive | UInt8 | Whether the function name can be used case-insensitively. |
alias_to | String | The original function name, if the function name is an alias. |
create_query | String | Obsolete. |
origin | Enum8('System' = 0, 'SQLUserDefined' = 1, 'ExecutableUserDefined' = 2, 'WasmUserDefined' = 3) | Obsolete. |
description | String | A high-level description what the function does. |
syntax | String | Signature of the function. |
arguments | String | The function arguments. |
parameters | String | The function parameters (only for aggregate function). |
returned_value | String | What does the function return. |
examples | String | Usage example. |
introduced_in | String | RawTree version in which the function was first introduced. |
categories | String | The category of the function. |
deterministic | Nullable(UInt8) | Whether the function returns the same result for the same arguments. NULL when unknown (e.g. aggregate or user-defined functions). |
higher_order | Nullable(UInt8) | Whether the function is higher-order — i.e. accepts at least one lambda expression as an argument (e.g. arrayMap, arrayFilter, mapApply). NULL when unknown. |
grants
Contains the information about privileges granted to RawTree user accounts.
| Column | Type | Comment |
|---|---|---|
user_name | Nullable(String) | User name. |
role_name | Nullable(String) | Role assigned to user account. |
access_type | Enum16('SHOW DATABASES' = 0, 'SHOW TABLES' = 1, 'CHECK' = 2, 'SHOW COLUMNS' = 3, 'SHOW DICTIONARIES' = 4, 'SHOW' = 5, 'SHOW FILESYSTEM CACHES' = 6, 'SELECT' = 7, 'INSERT' = 8, 'ALTER UPDATE' = 9, 'ALTER DELETE' = 10, 'ALTER ADD COLUMN' = 11, 'ALTER MODIFY COLUMN' = 12, 'ALTER DROP COLUMN' = 13, 'ALTER COMMENT COLUMN' = 14, 'ALTER CLEAR COLUMN' = 15, 'ALTER RENAME COLUMN' = 16, 'ALTER MATERIALIZE COLUMN' = 17, 'ALTER COLUMN' = 18, 'ALTER MODIFY COMMENT' = 19, 'ALTER MODIFY DATABASE COMMENT' = 20, 'ALTER ORDER BY' = 21, 'ALTER SAMPLE BY' = 22, 'ALTER ADD INDEX' = 23, 'ALTER DROP INDEX' = 24, 'ALTER MATERIALIZE INDEX' = 25, 'ALTER CLEAR INDEX' = 26, 'ALTER INDEX' = 27, 'ALTER ADD STATISTICS' = 28, 'ALTER DROP STATISTICS' = 29, 'ALTER MODIFY STATISTICS' = 30, 'ALTER MATERIALIZE STATISTICS' = 31, 'ALTER STATISTICS' = 32, 'ALTER ADD PROJECTION' = 33, 'ALTER DROP PROJECTION' = 34, 'ALTER MODIFY PROJECTION' = 35, 'ALTER MATERIALIZE PROJECTION' = 36, 'ALTER CLEAR PROJECTION' = 37, 'ALTER PROJECTION' = 38, 'ALTER ADD CONSTRAINT' = 39, 'ALTER DROP CONSTRAINT' = 40, 'ALTER MODIFY CONSTRAINT' = 41, 'ALTER CONSTRAINT' = 42, 'ALTER TTL' = 43, 'ALTER MATERIALIZE TTL' = 44, 'ALTER REWRITE PARTS' = 45, 'ALTER MATERIALIZE PRIMARY KEY' = 46, 'ALTER SETTINGS' = 47, 'ALTER MOVE PARTITION' = 48, 'ALTER FETCH PARTITION' = 49, 'ALTER FREEZE PARTITION' = 50, 'ALTER UNLOCK SNAPSHOT' = 51, 'ALTER EXECUTE' = 52, 'ALTER DATABASE SETTINGS' = 53, 'ALTER NAMED COLLECTION' = 54, 'ALTER HANDLER' = 55, 'ALTER TABLE' = 56, 'ALTER DATABASE' = 57, 'ALTER VIEW MODIFY QUERY' = 58, 'ALTER VIEW MODIFY REFRESH' = 59, 'ALTER VIEW MODIFY SQL SECURITY' = 60, 'ALTER VIEW' = 61, 'ALTER' = 62, 'CREATE DATABASE' = 63, 'CREATE TABLE' = 64, 'CREATE VIEW' = 65, 'CREATE DICTIONARY' = 66, 'CREATE TEMPORARY TABLE' = 67, 'CREATE ARBITRARY TEMPORARY TABLE' = 68, 'CREATE TEMPORARY VIEW' = 69, 'CREATE FUNCTION' = 70, 'CREATE WORKLOAD' = 71, 'CREATE RESOURCE' = 72, 'CREATE NAMED COLLECTION' = 73, 'CREATE HANDLER' = 74, 'CREATE' = 75, 'DROP DATABASE' = 76, 'DROP TABLE' = 77, 'DROP VIEW' = 78, 'DROP DICTIONARY' = 79, 'DROP FUNCTION' = 80, 'DROP WORKLOAD' = 81, 'DROP RESOURCE' = 82, 'DROP NAMED COLLECTION' = 83, 'DROP HANDLER' = 84, 'DROP' = 85, 'UNDROP TABLE' = 86, 'TRUNCATE' = 87, 'OPTIMIZE' = 88, 'BACKUP' = 89, 'KILL QUERY' = 90, 'KILL TRANSACTION' = 91, 'MOVE PARTITION BETWEEN SHARDS' = 92, 'CREATE USER' = 93, 'ALTER USER' = 94, 'DROP USER' = 95, 'CREATE ROLE' = 96, 'ALTER ROLE' = 97, 'DROP ROLE' = 98, 'ROLE ADMIN' = 99, 'CREATE ROW POLICY' = 100, 'ALTER ROW POLICY' = 101, 'DROP ROW POLICY' = 102, 'CREATE MASKING POLICY' = 103, 'ALTER MASKING POLICY' = 104, 'DROP MASKING POLICY' = 105, 'CREATE QUOTA' = 106, 'ALTER QUOTA' = 107, 'DROP QUOTA' = 108, 'CREATE SETTINGS PROFILE' = 109, 'ALTER SETTINGS PROFILE' = 110, 'DROP SETTINGS PROFILE' = 111, 'ALLOW SQL SECURITY NONE' = 112, 'SHOW USERS' = 113, 'SHOW ROLES' = 114, 'SHOW ROW POLICIES' = 115, 'SHOW QUOTAS' = 116, 'SHOW SETTINGS PROFILES' = 117, 'SHOW MASKING POLICIES' = 118, 'SHOW ACCESS' = 119, 'IMPERSONATE' = 120, 'ACCESS MANAGEMENT' = 121, 'SHOW NAMED COLLECTIONS' = 122, 'SHOW NAMED COLLECTIONS SECRETS' = 123, 'NAMED COLLECTION' = 124, 'NAMED COLLECTION ADMIN' = 125, 'SHOW HANDLERS' = 126, 'SET DEFINER' = 127, 'TABLE ENGINE' = 128, 'SYSTEM SHUTDOWN' = 129, 'SYSTEM DROP DNS CACHE' = 130, 'SYSTEM DROP CONNECTIONS CACHE' = 131, 'SYSTEM PREWARM MARK CACHE' = 132, 'SYSTEM DROP MARK CACHE' = 133, 'SYSTEM DROP ICEBERG METADATA CACHE' = 134, 'SYSTEM DROP PAIMON METADATA CACHE' = 135, 'SYSTEM DROP AVRO SCHEMA CACHE' = 136, 'SYSTEM DROP PARQUET METADATA CACHE' = 137, 'SYSTEM DROP POINT IN POLYGON CACHE' = 138, 'SYSTEM PREWARM PRIMARY INDEX CACHE' = 139, 'SYSTEM DROP PRIMARY INDEX CACHE' = 140, 'SYSTEM DROP UNCOMPRESSED CACHE' = 141, 'SYSTEM DROP VECTOR SIMILARITY INDEX CACHE' = 142, 'SYSTEM DROP TEXT INDEX TOKENS CACHE' = 143, 'SYSTEM DROP TEXT INDEX HEADER CACHE' = 144, 'SYSTEM DROP TEXT INDEX POSTINGS CACHE' = 145, 'SYSTEM DROP TEXT INDEX CACHES' = 146, 'SYSTEM DROP MMAP CACHE' = 147, 'SYSTEM DROP QUERY CONDITION CACHE' = 148, 'SYSTEM DROP ENCRYPTION HEADERS CACHE' = 149, 'SYSTEM DROP QUERY CACHE' = 150, 'SYSTEM DROP RUNTIME PROJECTIONS CACHE' = 151, 'SYSTEM DROP COMPILED EXPRESSION CACHE' = 152, 'SYSTEM DROP FILESYSTEM CACHE' = 153, 'SYSTEM DROP DISTRIBUTED CACHE' = 154, 'SYSTEM SYNC FILESYSTEM CACHE' = 155, 'SYSTEM DROP PAGE CACHE' = 156, 'SYSTEM DROP SCHEMA CACHE' = 157, 'SYSTEM DROP FORMAT SCHEMA CACHE' = 158, 'SYSTEM DROP S3 CLIENT CACHE' = 159, 'SYSTEM DROP CACHE' = 160, 'SYSTEM RELOAD CONFIG' = 161, 'SYSTEM RELOAD USERS' = 162, 'SYSTEM RELOAD DICTIONARY' = 163, 'SYSTEM RELOAD MODEL' = 164, 'SYSTEM RELOAD FUNCTION' = 165, 'SYSTEM RELOAD EMBEDDED DICTIONARIES' = 166, 'SYSTEM RELOAD ASYNCHRONOUS METRICS' = 167, 'SYSTEM RECONNECT ZOOKEEPER' = 168, 'SYSTEM RELOAD' = 169, 'SYSTEM RESTART DISK' = 170, 'SYSTEM WAIT BLOBS CLEANUP' = 171, 'SYSTEM MERGES' = 172, 'SYSTEM TTL MERGES' = 173, 'SYSTEM FETCHES' = 174, 'SYSTEM MOVES' = 175, 'SYSTEM PULLING REPLICATION LOG' = 176, 'SYSTEM CLEANUP' = 177, 'SYSTEM VIEWS' = 178, 'SYSTEM STREAMING ENGINES' = 179, 'SYSTEM BACKGROUND' = 180, 'SYSTEM DISTRIBUTED SENDS' = 181, 'SYSTEM REPLICATED SENDS' = 182, 'SYSTEM SENDS' = 183, 'SYSTEM REPLICATION QUEUES' = 184, 'SYSTEM VIRTUAL PARTS UPDATE' = 185, 'SYSTEM REDUCE BLOCKING PARTS' = 186, 'SYSTEM DROP REPLICA' = 187, 'SYSTEM SYNC REPLICA' = 188, 'SYSTEM REPLICA READINESS' = 189, 'SYSTEM RESTART REPLICA' = 190, 'SYSTEM RESTORE REPLICA' = 191, 'SYSTEM RESTORE DATABASE REPLICA' = 192, 'SYSTEM WAIT LOADING PARTS' = 193, 'SYSTEM WAIT QUERY RUNNER' = 194, 'SYSTEM SYNC DATABASE REPLICA' = 195, 'SYSTEM SYNC TRANSACTION LOG' = 196, 'SYSTEM SYNC FILE CACHE' = 197, 'SYSTEM FLUSH DISTRIBUTED' = 198, 'SYSTEM FLUSH LOGS' = 199, 'SYSTEM FLUSH ASYNC INSERT QUEUE' = 200, 'SYSTEM FLUSH OBJECT STORAGE QUEUE' = 201, 'SYSTEM FLUSH' = 202, 'SYSTEM THREAD FUZZER' = 203, 'SYSTEM UNFREEZE' = 204, 'SYSTEM UNLOCK SNAPSHOT' = 205, 'SYSTEM FAILPOINT' = 206, 'SYSTEM MEMORY' = 207, 'SYSTEM LISTEN' = 208, 'SYSTEM JEMALLOC' = 209, 'SYSTEM LOAD PRIMARY KEY' = 210, 'SYSTEM UNLOAD PRIMARY KEY' = 211, 'SYSTEM INSTRUMENT ADD' = 212, 'SYSTEM INSTRUMENT REMOVE' = 213, 'SYSTEM RESET DDL WORKER' = 214, 'SYSTEM' = 215, 'dictGet' = 216, 'displaySecretsInShowAndSelect' = 217, 'addressToLine' = 218, 'addressToLineWithInlines' = 219, 'addressToSymbol' = 220, 'demangle' = 221, 'INTROSPECTION' = 222, 'READ' = 223, 'WRITE' = 224, 'CLUSTER' = 225, 'FILE' = 226, 'URL' = 227, 'REMOTE' = 228, 'MONGO' = 229, 'REDIS' = 230, 'MYSQL' = 231, 'POSTGRES' = 232, 'SQLITE' = 233, 'ODBC' = 234, 'JDBC' = 235, 'HDFS' = 236, 'S3' = 237, 'HIVE' = 238, 'AZURE' = 239, 'KAFKA' = 240, 'NATS' = 241, 'RABBITMQ' = 242, 'YTSAURUS' = 243, 'ARROW FLIGHT' = 244, 'BIGQUERY' = 245, 'DISK' = 246, 'SOURCES' = 247, 'aiClassify' = 248, 'aiEmbed' = 249, 'aiExtract' = 250, 'aiFilter' = 251, 'aiGenerate' = 252, 'aiRedact' = 253, 'aiSimilarity' = 254, 'aiTranslate' = 255, 'AI FUNCTIONS' = 256, 'ALL' = 257, 'NONE' = 258) | Access parameters for RawTree user account. |
access_object | String | Parameter for access_type. Contains: 1 - Name of the source type for READ/WRITE grants.2 - Name of the table engine for TABLE ENGINE grants.3 - Name of the user for grants like SET DEFINER. |
database | Nullable(String) | Name of a database. |
table | Nullable(String) | Name of a table. |
column | Nullable(String) | Name of a column to which access is granted. |
is_partial_revoke | UInt8 | Logical value. It shows whether some privileges have been revoked. Possible values: 0 — The row describes a grant, 1 — The row describes a partial revoke. |
grant_option | UInt8 | Permission is granted WITH GRANT OPTION. |
is_wildcard | UInt8 | Logical value. It shows whether the grant is a wildcard prefix grant. Possible values: 0 — The row does not describe a wildcard prefix grant, 1 — The row describes a wildcard prefix grant (e.g. db*.* or foo.bar*). |
graphite_retentions
Contains information about parameters graphite_rollup which are used in tables with *GraphiteMergeTree engines.
| Column | Type | Comment |
|---|---|---|
config_name | String | graphite_rollup parameter name. |
rule_type | String | The rule type. Possible values: RuleTypeAll = 0 - default, with regex, compatible with old scheme; RuleTypePlain = 1 - plain metrics, with regex, compatible with old scheme; RuleTypeTagged = 2 - tagged metrics, with regex, compatible with old scheme; RuleTypeTagList = 3 - tagged metrics, with regex (converted to RuleTypeTagged from string like 'retention=10min ; env=(staging|prod)') |
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. |
handlers
Contains a list of all SQL-defined HTTP handlers created via CREATE HANDLER.
| Column | Type | Comment |
|---|---|---|
name | String | Name of the handler. |
protocol | Nullable(String) | Composable protocol the handler is restricted to, or NULL if the handler is active on all HTTP endpoints (the built-in http/https ports and every HTTP-type composable protocol listener). |
url_match_type | String | How the URL is matched: exact, prefix or regexp. |
url | String | The URL pattern that the handler matches. |
methods | Array(String) | Allowed HTTP methods. |
type | String | The handler type (only query is supported). |
query | String | The SQL query executed by the handler. Secrets are hidden unless the user is allowed to see them. |
create_query | String | The CREATE HANDLER statement. Secrets are hidden unless the user is allowed to see them. |
histogram_metrics
Contains histogram metrics which can be calculated instantly and exported in the Prometheus format. For example, the keeper response time. This table is always up to date.
| Column | Type | Comment |
|---|---|---|
metric | String | Metric name. |
value | Float64 | Metric value. |
description | String | Metric description. |
labels | Map(String, String) | Metric labels. |
name | String | — |
hypothetical_indexes
Shows session-scoped hypothetical indexes created with CREATE HYPOTHETICAL INDEX for use with EXPLAIN WHATIF.
| Column | Type | Comment |
|---|---|---|
database | String | Database name |
table | String | Table name |
name | String | Index name |
type | String | Index type (minmax, set, bloom_filter, etc) |
type_full | String | Index type expression with arguments, e.g. bloom_filter(0.01) |
expression | String | Index expression |
granularity | UInt64 | Index granularity |
iceberg_files
Lists data and delete files of currently loaded Iceberg tables.
| Column | Type | Comment |
|---|---|---|
database | String | Database name. |
table | String | Table name. |
snapshot_id | Int64 | Snapshot ID at which the file was added. |
content | Enum8('DATA' = 0, 'POSITION_DELETE' = 1, 'EQUALITY_DELETE' = 2) | File content kind. |
file_path | String | Resolved storage path of the file. |
file_format | String | File format, e.g. 'PARQUET'. |
record_count | Int64 | Number of records in the file. |
file_size_in_bytes | Int64 | Size of the file in bytes. |
partition | String | Textual representation of the partition tuple. |
schema_id | Int32 | Schema ID resolved for this manifest entry. |
sequence_number | Int64 | Resolved sequence number of the manifest entry (always 0 for format v1). |
sort_order_id | Nullable(Int32) | Sort order ID of the file, if specified. |
null_value_counts | Map(Int32, Int64) | Per-column null value count (column id -> count). |
column_sizes | Map(Int32, Int64) | Per-column on-disk size in bytes (column id -> bytes). |
value_counts | Map(Int32, Int64) | Per-column total value count (column id -> count). |
equality_ids | Array(Int32) | Equality field IDs for equality delete files (empty for non-equality-delete files). |
iceberg_history
Displays the history of an iceberg table similar to the Spark history table
| Column | Type | Comment |
|---|---|---|
database | String | Database name. |
table | String | Table name. |
made_current_at | Nullable(DateTime64(3)) | Date & time when this snapshot was made current snapshot |
snapshot_id | UInt64 | Snapshot id which is used to identify a snapshot. |
parent_id | UInt64 | Parent id of this snapshot. |
is_current_ancestor | UInt8 | Flag that indicates if this snapshot is an ancestor of the current snapshot. |
operation | Enum8('UNKNOWN' = -1, 'APPEND' = 0, 'OVERWRITE' = 1, 'DELETE' = 2, 'REPLACE' = 3) | Snapshot operation (APPEND, OVERWRITE, DELETE, REPLACE and UNKNOWN). The UNKNOWN status means either that we were unable to read the summary or that it is empty (it's optional for v1). The correct 'operation' field is required |
summary | Map(String, String) | Snapshot summary fields |
instrumentation
Contains a list of all functions instrumented with XRay with their IDs and handlers.
| Column | Type | Comment |
|---|---|---|
id | UInt32 | ID of the instrumentation point |
function_id | Int32 | ID assigned to the function in xray_instr_map section of elf-binary. |
function_name | LowCardinality(String) | Name used to instrument the function. |
handler | LowCardinality(String) | Handler that was patched into instrumentation points of the function. |
entry_type | Enum8('Entry' = 0, 'Exit' = 1, 'EntryAndExit' = 2) | Entry type for the patch. |
symbol | LowCardinality(String) | Complete and demangled symbol name. |
arguments | Array(Dynamic) | Arguments for the handler call. |
jemalloc_arena_bins
Same as system.jemalloc_bins but with one row per (arena, bin) instead of aggregating over arenas. Slabs belong to a single arena, so this table locates fragmentation in a specific arena (including the dedicated MergeTree metadata, JIT and cache arenas) and joins to system.jemalloc_sampled_allocations on both arena and size class.
| Column | Type | Comment |
|---|---|---|
arena | UInt32 | Index of the arena. Joins to system.jemalloc_sampled_allocations.arena. |
purpose | String | Purpose of a dedicated long-lived arena: 'mergetree' (part and table metadata), 'jit', 'cache'. Empty for general-purpose arenas. Dedicated arenas hold long-lived allocations by design; fragmentation reports usually exclude them. |
index | UInt16 | Index of the bin ordered by size. |
large | UInt8 | True for large allocations and False for small. |
size | UInt64 | Size of allocations in this bin. |
allocations | Int64 | Number of allocations. |
deallocations | Int64 | Number of deallocations. |
nregs | Int64 | Number of regions per slab. |
curslabs | Int64 | Current number of slabs. |
curregs | Int64 | Current number of regions for this size class. |
slab_size | UInt64 | Size of each slab in bytes. Zero for large size classes, which are not slab-based. |
nonfull_slabs | Int64 | Current number of slabs that contain at least one free region. Zero for large size classes. |
availregs | UInt64 | — |
util | Float64 | — |
waste | UInt64 | — |
jemalloc_bins
Contains information about memory allocations done via jemalloc allocator in different size classes (bins) aggregated from all arenas. These statistics might not be absolutely accurate because of thread local caching in jemalloc. For small size classes the slab columns (slab_size, nonfull_slabs and the waste alias) measure memory lost to slab fragmentation.
| Column | Type | Comment |
|---|---|---|
index | UInt16 | Index of the bin ordered by size. |
large | UInt8 | True for large allocations and False for small. |
size | UInt64 | Size of allocations in this bin. |
allocations | Int64 | Number of allocations. |
deallocations | Int64 | Number of deallocations. |
nregs | Int64 | Number of regions per slab. |
curslabs | Int64 | Current number of slabs. |
curregs | Int64 | Current number of regions for this size class. |
slab_size | UInt64 | Size of each slab in bytes. Zero for large size classes, which are not slab-based. |
nonfull_slabs | Int64 | Current number of slabs that contain at least one free region. Zero for large size classes. |
availregs | UInt64 | — |
util | Float64 | — |
waste | UInt64 | — |
jemalloc_profile_text
Displays the symbolized jemalloc heap profile. Run 'SYSTEM JEMALLOC FLUSH PROFILE' to generate a profile first.
| Column | Type | Comment |
|---|---|---|
line | String | Line from the symbolized jemalloc heap profile. |
jemalloc_sampled_allocations
One row per live sampled allocation from the jemalloc heap profiler; reading the table flushes a fresh heap profile. Only threads with the profiler armed contribute (jemalloc_enable_profiler setting or jemalloc_enable_global_profiler config); each row represents roughly weight similar allocations.
| Column | Type | Comment |
|---|---|---|
trace | Array(UInt64) | Addresses of the allocating backtrace, leaf frame first (same convention as system.trace_log.trace). Symbolize with addressToSymbol and demangle (requires allow_introspection_functions). |
age_ns | UInt64 | Time in nanoseconds the allocation has been alive, relative to the moment the profile was flushed. |
size | UInt64 | Requested allocation size in bytes. |
usize | UInt64 | Usable size in bytes, i.e. the size class the request was rounded up to. |
size_class | UInt16 | Index of the size class. Joins to system.jemalloc_bins.index for small size classes. |
arena | UInt32 | Index of the arena the allocation was served from. |
thr_uid | UInt64 | jemalloc-internal unique id of the allocating thread. |
sample_interval | UInt64 | Average number of allocated bytes between samples, taken from the profile header. The same for all rows. |
alloc_time | DateTime | — |
weight | Float64 | — |
jemalloc_stats
Returns jemalloc statistics in a single row with a single column. Equivalent to SYSTEM JEMALLOC STATS command.
| Column | Type | Comment |
|---|---|---|
stats | String | JEMalloc statistics output from malloc_stats_print. |
kafka_consumers
Contains information about Kafka consumers. Applicable for Kafka table engine (native RawTree integration).
| Column | Type | Comment |
|---|---|---|
database | String | Database of the table with Kafka Engine. |
table | String | Name of the table with Kafka Engine. |
consumer_id | String | Kafka consumer identifier. Note, that a table can have many consumers. Specified by kafka_num_consumers parameter. |
assignments.topic | Array(String) | Kafka topic. |
assignments.partition_id | Array(Int32) | Kafka partition id. Note, that only one consumer can be assigned to a partition. |
assignments.current_offset | Array(Int64) | Current offset. |
assignments.intent_size | Array(Nullable(Int64)) | The number of pushed, but not yet committed messages in new StorageKafka. |
exceptions.time | Array(DateTime) | Timestamp when the 10 most recent exceptions were generated. |
exceptions.text | Array(String) | Text of 10 most recent exceptions. |
last_poll_time | DateTime | Timestamp of the most recent poll. |
num_messages_read | UInt64 | Number of messages read by the consumer. |
last_commit_time | DateTime | Timestamp of the most recent poll. |
num_commits | UInt64 | Total number of commits for the consumer. |
last_rebalance_time | DateTime | Timestamp of the most recent Kafka rebalance. |
num_rebalance_revocations | UInt64 | Number of times the consumer was revoked its partitions. |
num_rebalance_assignments | UInt64 | Number of times the consumer was assigned to Kafka cluster. |
is_currently_used | UInt8 | The flag which shows whether the consumer is in use. |
last_used | DateTime64(6) | The last time this consumer was in use. |
rdkafka_stat | String | Library internal statistic. Set statistics_interval_ms to 0 disable, default is 3000 (once in three seconds). |
dependencies | Array(Array(String)) | Transitive database dependencies. |
missing_dependencies | Array(Array(String)) | Missing transitive database dependencies. |
keywords
Contains a list of all keywords used in RawTree parser.
| Column | Type | Comment |
|---|---|---|
keyword | String | The keyword used in RawTree parser. |
licenses
Contains licenses of third-party libraries that are located in the contrib directory of RawTree sources.
| Column | Type | Comment |
|---|---|---|
library_name | String | Name of the library. |
license_type | String | License type — e.g. Apache, MIT. |
license_path | String | Path to the file with the license text. |
license_text | String | License text. |
macros
Contains a list of all macros defined in server configuration.
| Column | Type | Comment |
|---|---|---|
macro | String | The macro name. |
substitution | String | The substitution string. |
masking_policies
Contains information about masking policies. Masking policies can only be created and applied in ClickHouse Cloud; in open-source builds this table is always empty.
| Column | Type | Comment |
|---|---|---|
name | String | Name of a masking policy. |
short_name | String | Short name of a masking policy. Names of masking policies are compound, for example: mask_email ON mydb.mytable. Here 'mask_email ON mydb.mytable' is the name of the masking policy, and 'mask_email' is its short name. |
database | String | Database name. |
table | String | Table name. |
id | UUID | Masking policy ID. |
storage | String | Name of the directory where the masking policy is stored. |
update_assignments | Nullable(String) | UPDATE assignments that define how data should be masked, for example: email = 'masked', phone = '--****'. NULL if not set. |
where_condition | Nullable(String) | Optional condition selecting the rows the mask is applied to. NULL if not set. |
priority | Int64 | Priority of the masking policy. Policies with higher priority are applied first. |
apply_to_all | UInt8 | Shows that the masking policy is set for all roles and/or users. |
apply_to_list | Array(String) | List of the roles and/or users to which the masking policy is applied. |
apply_to_except | Array(String) | The masking policy is applied to all roles and/or users except the listed ones. |
merge_tree_settings
Contains a list of all MergeTree engine specific settings, their current and default values along with descriptions. You may change any of them in SETTINGS section in CREATE query.
| Column | Type | Comment |
|---|---|---|
name | String | Setting name. |
value | String | Setting value. |
default | String | Setting default value. |
changed | UInt8 | 1 if the setting was explicitly defined in the config or explicitly changed. |
description | String | Setting description. |
min | Nullable(String) | Minimum value of the setting, if any is set via constraints. If the setting has no minimum value, contains NULL. |
max | Nullable(String) | Maximum value of the setting, if any is set via constraints. If the setting has no maximum value, contains NULL. |
disallowed_values | Array(String) | List of disallowed values |
readonly | UInt8 | Shows whether the current user can change the setting: 0 — Current user can change the setting, 1 — Current user can't change the setting. |
type | String | Setting type (implementation specific string value). |
is_obsolete | UInt8 | Shows whether a setting is obsolete. |
tier | Enum8('Production' = 0, 'Obsolete' = 4, 'Experimental' = 8, 'Beta' = 12, 'PrivatePreview' = 16) | Support level for this feature. RawTree features are organized in tiers, varying depending on the current status of their development and the expectations one might have when using them: * PRODUCTION: The feature is stable, safe to use and does not have issues interacting with other PRODUCTION features. * BETA: The feature is stable and safe. The outcome of using it together with other features is unknown and correctness is not guaranteed. Testing and reports are welcome. * EXPERIMENTAL: The feature is under development. Only intended for developers and RawTree enthusiasts. The feature might or might not work and could be removed at any time. * PRIVATE PREVIEW: The feature is on a clear path to general availability. Its applicability is still limited and it is not recommended for production use. * OBSOLETE: No longer supported. Either it is already removed or it will be removed in future releases. |
merges
Contains a list of merges currently executing merges of MergeTree tables and their progress. Each merge operation is represented by a single row.
| Column | Type | Comment |
|---|---|---|
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 parts to be merged. |
source_part_names | Array(String) | The list of source parts names. |
result_part_name | String | The name of the part that will be formed as the result of merging. |
source_part_paths | Array(String) | The list of paths for each source part. |
result_part_path | String | The path of the part that will be formed as the result of merging. |
partition_id | String | The identifier of the partition where the merge is happening. |
partition | String | The name of the partition |
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_bytes_uncompressed | UInt64 | The total size of 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. |
columns_written | UInt64 | Number of columns written (for Vertical merge algorithm). |
memory_usage | UInt64 | Memory consumption of the merge process. |
thread_id | UInt64 | Thread ID of the merge process. |
merge_type | String | The type of current merge. Empty if it's an mutation. |
merge_algorithm | String | The algorithm used in current merge. Empty if it's an mutation. |
current_projection | String | The name of the projection currently being merged or rebuilt. Empty if not in the projection merge stage. |
current_projection_progress | Float64 | The progress of the current projection merge from 0 to 1. |
current_projection_parts_merging | UInt64 | The number of projection parts currently being merged. |
current_projection_parts_remaining | UInt64 | The number of projection parts remaining to be merged for the current projection. |
projections_completed | Array(String) | The list of projections that have been merged or rebuilt so far. |
projections_remaining | Array(String) | The list of projections that still need to be merged or rebuilt. |
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.
| Column | Type | Comment |
|---|---|---|
metric | String | Metric name. |
value | Int64 | Metric value. |
description | String | Metric description. |
name | String | — |
models
Contains a list of CatBoost models loaded into a LibraryBridge's memory along with time when it was loaded.
| Column | Type | Comment |
|---|---|---|
model_path | String | Path to trained model. |
type | String | Model type. Now catboost only. |
loading_start_time | DateTime | The time when the loading of the model started. |
loading_duration | Float32 | How much time did it take to load the model. |
moves
Contains information about in-progress data part moves of MergeTree tables. Each data part movement is represented by a single row.
| Column | Type | Comment |
|---|---|---|
database | String | Name of the database. |
table | String | Name of the table containing moving data part. |
elapsed | Float64 | Time elapsed (in seconds) since data part movement started. |
target_disk_name | String | Name of disk to which the data part is moving. |
target_disk_path | String | Path to the mount point of the disk in the file system. |
part_name | String | Name of the data part being moved. |
part_size | UInt64 | Data part size. |
thread_id | UInt64 | Identifier of a thread performing the movement. |
mutations
Contains a list of mutations and their progress. Each mutation command is represented by a single row.
| Column | Type | Comment |
|---|---|---|
database | String | The name of the database to which the mutation was applied. |
table | String | The name of the table to which the mutation was applied. |
mutation_id | String | The ID of the mutation. For replicated tables these IDs correspond to znode names in the <table_path_in_clickhouse_keeper>/mutations/ directory in RawTree Keeper. For non-replicated tables the IDs correspond to file names in the data directory of the table. |
command | String | The mutation command string (the part of the query after ALTER TABLE [db.]table). |
create_time | DateTime | Date and time when the mutation command was submitted for execution. |
finish_time | DateTime | Date and time when the mutation was completed. Zero if the mutation is not completed yet or if its completion time is unknown. For non-replicated tables the value is tracked in memory and is reset when the table is reloaded (e.g. on server restart). For replicated tables the value is per-replica; after a restart, the completion time of the most recently completed mutation is restored from Keeper, while older completed mutations report zero. |
block_numbers.partition_id | Array(String) | For mutations of replicated tables, the array contains the partitions' IDs (one record for each partition). For mutations of non-replicated tables the array is empty. |
block_numbers.number | Array(Int64) | For mutations of replicated tables, the array contains one record for each partition, with the block number that was acquired by the mutation. Only parts that contain blocks with numbers less than this number will be mutated in the partition.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_in_progress_names | Array(String) | An array of names of data parts that are currently being mutated. |
parts_to_do_names | Array(String) | An array of names of data parts that need to be mutated for the mutation to complete. |
parts_to_do | Int64 | The number of data parts that need to be mutated for the mutation to complete. Note: even if parts_to_do = 0, a mutation of a replicated table may not be completed yet due to a long-running INSERT that is creating a new data part that will need to be mutated. |
parts_postpone_reasons | Map(String, String) | A map of part names to reasons why they are postponed. |
is_done | UInt8 | The flag whether the mutation is done or not. Possible values: 1 if the mutation is completed, 0 if the mutation is still in process. |
is_killed | UInt8 | Indicates whether a mutation has been killed. Only available in RawTree Cloud.Note: is_killed=1 does not necessarily mean the mutation is completely finalized.It is possible for a mutation to remain in a state where is_killed=1 and is_done=0 for an extended period.This can occur if another long-running mutation is blocking the killed mutation. This is a normal situation. |
latest_failed_part | String | The name of the most recent part that could not be mutated. |
latest_fail_time | DateTime | The date and time of the most recent part mutation failure. |
latest_fail_reason | String | The exception message that caused the most recent part mutation failure. |
latest_fail_error_code_name | String | The error code of the exception that caused the most recent part mutation failure. |
named_collections
Contains a list of all named collections which were created via SQL query or parsed from configuration file.
| Column | Type | Comment |
|---|---|---|
name | String | Name of the collection. |
collection | Map(String, String) | Collection internals. |
source | String | Named collection source. |
create_query | String | Named collection create query. |
numbers
Generates all natural numbers, starting from 0 (to 2^64 - 1, and then again) in sorted order.
| Column | Type | Comment |
|---|---|---|
number | UInt64 | — |
numbers_mt
Multithreaded version of system.numbers. Numbers order is not guaranteed.
| Column | Type | Comment |
|---|---|---|
number | UInt64 | — |
one
This table contains a single row with a single dummy UInt8 column containing the value 0. Used when the table is not specified explicitly, for example in queries like SELECT 1.
| Column | Type | Comment |
|---|---|---|
dummy | UInt8 | — |
packed_bundle_units
Contains a list of units of packed JSON bundles of all currently existing parts of all MergeTree tables. Each unit of each packed column of each part is represented by a single row.
| Column | Type | Comment |
|---|---|---|
partition | String | The partition name. |
name | String | Name of the data part. |
uuid | UUID | The parts UUID. |
part_type | String | The data part storing format. |
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. |
partition_id | String | ID of the partition. |
rows | UInt64 | The number of rows in the data part. |
database | String | Name of the database. |
table | String | Name of the table. |
engine | String | Name of the table engine without parameters. |
disk_name | String | Name of a disk that stores the data part. |
path | String | Absolute path to the folder with data part files. |
column | String | Name of the packed JSON column. |
data_file | String | Name of the bundle data file inside the part. |
data_file_bytes | UInt64 | Size of the bundle data file in bytes. |
marks_file | String | Name of the bundle marks file inside the part. |
marks_count | UInt64 | The number of mark rows per unit. It is the same for every unit of the bundle: one per granule plus the final mark. |
units_count | UInt64 | The number of units in the bundle. |
total_substreams | UInt64 | The number of substreams in the whole bundle, which is the sum of substreams_count over its units. |
unit_index | UInt64 | Position of the unit in the bundle footer, starting with 0. It is the order of the marks regions in the marks file. |
unit_name | String | Name of the unit. A JSON path unit is named <column>.<path>; the two synthetic units are shown as <reserved>shared_data and <reserved>object_structure. |
unit_kind | String | Kind of the unit: path for a JSON path, shared_data for the shared data of the column, structure for the object structure. |
unit_path | String | The JSON path of a path unit. Empty for synthetic units. |
substreams_count | UInt64 | The number of substreams of the unit, which is the number of marks in one of its mark rows. |
substream_names | Array(String) | Names of the substreams of the unit, in the order they appear in a mark row. |
data_start | UInt64 | Offset of the unit's compressed data in the bundle data file. |
data_compressed_bytes | UInt64 | Size of the unit's compressed data in bytes. |
data_uncompressed_bytes | UInt64 | Size of the unit's decompressed data in bytes. |
data_uncompressed_hash | String | Hash of the unit's decompressed data. |
marks_offset_in_compressed_file | UInt64 | Offset of the compressed block holding the start of the unit's marks region in the bundle marks file. |
marks_offset_in_decompressed_block | UInt64 | Offset of the start of the unit's marks region inside that decompressed block. |
marks_bytes | UInt64 | Size of the unit's marks region in bytes before compression: marks_count rows, each holding one mark per substream and the number of rows in the granule. |
marks_size | UInt64 | — |
part_name | String | — |
part_moves_between_shards
Contains information about parts which are currently in a process of moving between shards and their progress.
| Column | Type | Comment |
|---|---|---|
database | String | The name of the database where move is performed. |
table | String | The name of the table where move is performed. |
task_name | String | The name of the moving task. |
task_uuid | UUID | The identifier of the moving task. |
create_time | DateTime | The time when the task was created. |
part_name | String | The name of the part which is in a process of moving. |
part_uuid | UUID | The UUID of the part which is in a process of moving. |
to_shard | String | The name of the destination shard. |
dst_part_name | String | The result part name. |
update_time | DateTime | The last time update was performed. |
state | String | The current state of the move. |
rollback | UInt8 | The flag which indicated whether the operation was rolled back. |
num_tries | UInt32 | The number of tries to complete the operation. |
last_exception | String | The last exception name if any. |
parts
Contains a list of currently existing (both active and inactive) parts of all *-MergeTree tables. Each part is represented by a single row.
| Column | Type | Comment |
|---|---|---|
partition | String | Partition identifier (string representation derived from the table partition key expression). |
name | String | Name of the data part. The part naming structure can be used to determine many aspects of the data, ingest, and merge patterns. The part naming format is the following: text <partition_id>_<minimum_block_number>_<maximum_block_number>_<level>_<data_version> * Definitions: - partition_id - identifies the partition key - minimum_block_number - identifies the minimum block number in the part. RawTree always merges continuous blocks - maximum_block_number - identifies the maximum block number in the part - level - incremented by one with each additional merge on the part. A level of 0 indicates this is a new part that has not been merged. It is important to remember that all parts in RawTree are always immutable - data_version - optional value, incremented when a part is mutated (again, mutated data is always only written to a new part, since parts are immutable) |
uuid | UUID | The UUID of data part. |
part_type | String | The data part storing format. Possible values: Wide — each column is stored in a separate file, Compact — all columns are stored in one file. Data storing format is controlled by the min_bytes_for_wide_part and min_rows_for_wide_part settings of the MergeTree table. |
part_storage_type | String | The type of DataPartStorage. Possible values: Packed - most part files are stored in a single archive (projections and a few service files such as txn_version.txt are written separately), Full - each file is stored separately. |
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 about to be deleted. Inactive data parts appear after merging and mutating operations. |
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 does not work for adaptive granularity). |
rows | UInt64 | The number of rows. |
files | UInt64 | The number of files in the data part. |
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. |
primary_key_size | UInt64 | The amount of memory (in bytes) used by primary key values in the primary.idx/cidx file on disk. |
marks_bytes | UInt64 | The size of the file with marks. |
secondary_indices_compressed_bytes | UInt64 | Total size of compressed data for secondary indices in the data part. All the auxiliary files (for example, files with marks) are not included. |
secondary_indices_uncompressed_bytes | UInt64 | Total size of uncompressed data for secondary indices in the data part. All the auxiliary files (for example, files with marks) are not included. |
secondary_indices_marks_bytes | UInt64 | The size of the file with marks for secondary indices. |
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 | Int64 | The minimum number of data parts that make up the current part after merging. |
max_block_number | Int64 | 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. Will be 0 when primary_key_lazy_load is enabled and the key is not loaded. When non-zero the bytes live in the part itself and are accounted within jemalloc.mergetree_arena.active_bytes. They are NEVER counted in PrimaryIndexCacheBytes — those are mutually exclusive per part: an index lives either in the part (this metric) or in the shared PrimaryIndexCache (the other), depending on primary_key_lazy_load and use_primary_key_cache. |
primary_key_bytes_in_memory_allocated | UInt64 | The amount of memory (in bytes) reserved for primary key values. Will be 0 when primary_key_lazy_load is enabled and the key is not loaded. When non-zero, included in jemalloc.mergetree_arena.active_bytes. See the note on primary_key_bytes_in_memory for the relationship with PrimaryIndexCacheBytes. |
index_granularity_bytes_in_memory | UInt64 | The amount of memory (in bytes) used by index granularity values (will be 0 in case of primary_key_lazy_load=1 and use_primary_key_cache=1). When non-zero the bytes are part-owned and accounted within jemalloc.mergetree_arena.active_bytes. |
index_granularity_bytes_in_memory_allocated | UInt64 | The amount of memory (in bytes) reserved for index granularity values (will be 0 in case of primary_key_lazy_load=1 and use_primary_key_cache=1). When non-zero, included in jemalloc.mergetree_arena.active_bytes. |
is_frozen | UInt8 | Flag that shows that a partition data backup exists. 1, the backup exists. 0, the backup does not 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. |
disk_name | String | Name of a disk that stores the data part. |
path | String | Absolute path to the folder with data part files. |
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. |
delete_ttl_info_min | DateTime | The minimum value of the date and time key for TTL DELETE rule. |
delete_ttl_info_max | DateTime | The maximum value of the date and time key for TTL DELETE rule. |
move_ttl_info.expression | Array(String) | Array of expressions. Each expression defines a TTL MOVE rule. |
move_ttl_info.min | Array(DateTime) | Array of date and time values. Each element describes the minimum key value for a TTL MOVE rule. |
move_ttl_info.max | Array(DateTime) | Array of date and time values. Each element describes the maximum key value for a TTL MOVE rule. |
default_compression_codec | String | The name of the codec used to compress this data part when a column has no explicit codec or uses CODEC(Default). With enable_adaptive_codec_selection, individual blocks of such columns may use other codecs; see mergeTreeCodecBlockCounts. |
recompression_ttl_info.expression | Array(String) | The TTL expression. |
recompression_ttl_info.min | Array(DateTime) | The minimum value of the calculated TTL expression within this part. Used to understand whether we have at least one row with expired TTL. |
recompression_ttl_info.max | Array(DateTime) | The maximum value of the calculated TTL expression within this part. Used to understand whether we have all rows with expired TTL. |
group_by_ttl_info.expression | Array(String) | The TTL expression. |
group_by_ttl_info.min | Array(DateTime) | The minimum value of the calculated TTL expression within this part. Used to understand whether we have at least one row with expired TTL. |
group_by_ttl_info.max | Array(DateTime) | The maximum value of the calculated TTL expression within this part. Used to understand whether we have all rows with expired TTL. |
rows_where_ttl_info.expression | Array(String) | The TTL expression. |
rows_where_ttl_info.min | Array(DateTime) | The minimum value of the calculated TTL expression within this part. Used to understand whether we have at least one row with expired TTL. |
rows_where_ttl_info.max | Array(DateTime) | The maximum value of the calculated TTL expression within this part. Used to understand whether we have all rows with expired TTL. |
projections | Array(String) | The list of projection names calculated for this part. |
secondary_indices.name | Array(String) | The names of secondary (data skipping) indices materialized in this part. An index declared in the table but missing here was not built for this part yet (see ALTER TABLE ... MATERIALIZE INDEX). |
secondary_indices.data_compressed_bytes | Array(UInt64) | The size of compressed data of each secondary index in the data part, in the same order as secondary_indices.name. |
secondary_indices.data_uncompressed_bytes | Array(UInt64) | The size of uncompressed data of each secondary index in the data part, in the same order as secondary_indices.name. |
secondary_indices.marks_bytes | Array(UInt64) | The size of the file with marks of each secondary index in the data part, in the same order as secondary_indices.name. |
visible | UInt8 | Flag which indicated whether this part is visible for SELECT queries. |
creation_tid | Tuple(UInt64, UInt64, UUID) | ID of transaction that has created/is trying to create this object. |
removal_tid_lock | UInt64 | Hash of removal_tid, used to lock an object for removal. |
removal_tid | Tuple(UInt64, UInt64, UUID) | ID of transaction that has removed/is trying to remove this object |
creation_csn | UInt64 | CSN of transaction that has created this object |
removal_csn | UInt64 | CSN of transaction that has removed this object |
has_lightweight_delete | UInt8 | The flag which indicated whether the part has lightweight delete mask. |
last_removal_attempt_time | DateTime | The last time the server tried to delete this part. |
removal_state | String | The current state of part removal process. |
sorting_key | String | The per-part sorting key expression for raw tables. Empty for regular tables or parts without a per-part key. |
is_unique_by_sorting_key | UInt8 | For raw tables, whether no two rows of the part have the same per-part sorting key (sorting_key), as after an insert with optimize_on_insert or a merge with replacing_enable. 0 for regular tables. |
filter_columns_stats | Map(String, UInt64) | Per-part column access statistics for raw tables. Maps column names that appeared in WHERE/PREWHERE predicates to the number of times they were accessed. |
bytes | UInt64 | — |
marks_size | UInt64 | — |
part_name | String | — |
parts_columns
Contains a list of columns of all currently existing parts of all MergeTree tables. Each column is represented by a single row.
| Column | Type | Comment |
|---|---|---|
partition | String | The partition name. |
name | String | Name of the data part. |
uuid | UUID | The parts UUID. |
part_type | String | The data part storing format. Possible values: Wide — Each column is stored in a separate file in a filesystem, Compact — All columns are stored in one file in a filesystem. |
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 does not 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 for the Date column if that is included in the partition key. |
max_date | Date | The maximum value for the Date column if that is included in the partition key. |
min_time | DateTime | The minimum value for the DateTime column if that is included in the partition key. |
max_time | DateTime | The maximum value for the DateTime column if that is included in the partition key. |
partition_id | String | ID of the partition. |
min_block_number | Int64 | The minimum number of data parts that make up the current part after merging. |
max_block_number | Int64 | 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. |
database | String | Name of the database. |
table | String | Name of the table. |
engine | String | Name of the table engine without parameters. |
disk_name | String | Name of a disk that stores the data part. |
path | String | Absolute path to the folder with data part files. |
column | String | Name of the column. |
type | String | Column type. |
column_position | UInt64 | Ordinal position of a column in a table starting with 1. |
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. |
column_bytes_on_disk | UInt64 | Total size of the column in bytes. |
column_data_compressed_bytes | UInt64 | Total size of the compressed data in the column, in bytes. |
column_data_uncompressed_bytes | UInt64 | Total size of the decompressed data in the column, in bytes. |
column_marks_bytes | UInt64 | The size of the marks for column, in bytes. |
column_modification_time | Nullable(DateTime) | The last time the column was modified. |
column_ttl_min | Nullable(DateTime) | The minimum value of the calculated TTL expression of the column. |
column_ttl_max | Nullable(DateTime) | The maximum value of the calculated TTL expression of the column. |
statistics | Array(String) | The statistics of the column. |
estimates.min | Nullable(String) | Estimated minimum value of the column. |
estimates.max | Nullable(String) | Estimated maximum value of the column. |
estimates.cardinality | Nullable(UInt64) | Estimated cardinality of the column. |
estimates.null_count | Nullable(UInt64) | Estimated number of NULL values in the column. |
estimates.default_count | Nullable(UInt64) | Estimated number of rows equal to the column's storage default value (NULL for Nullable columns, 0 / '' / [] / ... for non-Nullable). NULL when no basic statistic is available. |
serialization_kind | String | Kind of serialization of a column |
substreams | Array(String) | Names of substreams to which column is serialized |
filenames | Array(String) | Names of files for each substream of a column respectively |
subcolumns.names | Array(String) | Names of subcolumns of a column |
subcolumns.types | Array(String) | Types of subcolumns of a column |
subcolumns.serializations | Array(String) | Kinds of serialization of subcolumns of a column |
subcolumns.bytes_on_disk | Array(UInt64) | Sizes in bytes for each subcolumn |
subcolumns.data_compressed_bytes | Array(UInt64) | Sizes of the compressed data for each subcolumn, in bytes |
subcolumns.data_uncompressed_bytes | Array(UInt64) | Sizes of the decompressed data for each subcolumn, in bytes |
subcolumns.marks_bytes | Array(UInt64) | Sizes of the marks for each subcolumn of a column, in bytes |
bytes | UInt64 | — |
marks_size | UInt64 | — |
part_name | String | — |
primes
Generates all prime numbers, starting from 2, in sorted order.
| Column | Type | Comment |
|---|---|---|
prime | UInt64 | — |
privileges
Contains a list of all available privileges that could be granted to a user or role.
| Column | Type | Comment |
|---|---|---|
privilege | Enum16('SHOW DATABASES' = 0, 'SHOW TABLES' = 1, 'CHECK' = 2, 'SHOW COLUMNS' = 3, 'SHOW DICTIONARIES' = 4, 'SHOW' = 5, 'SHOW FILESYSTEM CACHES' = 6, 'SELECT' = 7, 'INSERT' = 8, 'ALTER UPDATE' = 9, 'ALTER DELETE' = 10, 'ALTER ADD COLUMN' = 11, 'ALTER MODIFY COLUMN' = 12, 'ALTER DROP COLUMN' = 13, 'ALTER COMMENT COLUMN' = 14, 'ALTER CLEAR COLUMN' = 15, 'ALTER RENAME COLUMN' = 16, 'ALTER MATERIALIZE COLUMN' = 17, 'ALTER COLUMN' = 18, 'ALTER MODIFY COMMENT' = 19, 'ALTER MODIFY DATABASE COMMENT' = 20, 'ALTER ORDER BY' = 21, 'ALTER SAMPLE BY' = 22, 'ALTER ADD INDEX' = 23, 'ALTER DROP INDEX' = 24, 'ALTER MATERIALIZE INDEX' = 25, 'ALTER CLEAR INDEX' = 26, 'ALTER INDEX' = 27, 'ALTER ADD STATISTICS' = 28, 'ALTER DROP STATISTICS' = 29, 'ALTER MODIFY STATISTICS' = 30, 'ALTER MATERIALIZE STATISTICS' = 31, 'ALTER STATISTICS' = 32, 'ALTER ADD PROJECTION' = 33, 'ALTER DROP PROJECTION' = 34, 'ALTER MODIFY PROJECTION' = 35, 'ALTER MATERIALIZE PROJECTION' = 36, 'ALTER CLEAR PROJECTION' = 37, 'ALTER PROJECTION' = 38, 'ALTER ADD CONSTRAINT' = 39, 'ALTER DROP CONSTRAINT' = 40, 'ALTER MODIFY CONSTRAINT' = 41, 'ALTER CONSTRAINT' = 42, 'ALTER TTL' = 43, 'ALTER MATERIALIZE TTL' = 44, 'ALTER REWRITE PARTS' = 45, 'ALTER MATERIALIZE PRIMARY KEY' = 46, 'ALTER SETTINGS' = 47, 'ALTER MOVE PARTITION' = 48, 'ALTER FETCH PARTITION' = 49, 'ALTER FREEZE PARTITION' = 50, 'ALTER UNLOCK SNAPSHOT' = 51, 'ALTER EXECUTE' = 52, 'ALTER DATABASE SETTINGS' = 53, 'ALTER NAMED COLLECTION' = 54, 'ALTER HANDLER' = 55, 'ALTER TABLE' = 56, 'ALTER DATABASE' = 57, 'ALTER VIEW MODIFY QUERY' = 58, 'ALTER VIEW MODIFY REFRESH' = 59, 'ALTER VIEW MODIFY SQL SECURITY' = 60, 'ALTER VIEW' = 61, 'ALTER' = 62, 'CREATE DATABASE' = 63, 'CREATE TABLE' = 64, 'CREATE VIEW' = 65, 'CREATE DICTIONARY' = 66, 'CREATE TEMPORARY TABLE' = 67, 'CREATE ARBITRARY TEMPORARY TABLE' = 68, 'CREATE TEMPORARY VIEW' = 69, 'CREATE FUNCTION' = 70, 'CREATE WORKLOAD' = 71, 'CREATE RESOURCE' = 72, 'CREATE NAMED COLLECTION' = 73, 'CREATE HANDLER' = 74, 'CREATE' = 75, 'DROP DATABASE' = 76, 'DROP TABLE' = 77, 'DROP VIEW' = 78, 'DROP DICTIONARY' = 79, 'DROP FUNCTION' = 80, 'DROP WORKLOAD' = 81, 'DROP RESOURCE' = 82, 'DROP NAMED COLLECTION' = 83, 'DROP HANDLER' = 84, 'DROP' = 85, 'UNDROP TABLE' = 86, 'TRUNCATE' = 87, 'OPTIMIZE' = 88, 'BACKUP' = 89, 'KILL QUERY' = 90, 'KILL TRANSACTION' = 91, 'MOVE PARTITION BETWEEN SHARDS' = 92, 'CREATE USER' = 93, 'ALTER USER' = 94, 'DROP USER' = 95, 'CREATE ROLE' = 96, 'ALTER ROLE' = 97, 'DROP ROLE' = 98, 'ROLE ADMIN' = 99, 'CREATE ROW POLICY' = 100, 'ALTER ROW POLICY' = 101, 'DROP ROW POLICY' = 102, 'CREATE MASKING POLICY' = 103, 'ALTER MASKING POLICY' = 104, 'DROP MASKING POLICY' = 105, 'CREATE QUOTA' = 106, 'ALTER QUOTA' = 107, 'DROP QUOTA' = 108, 'CREATE SETTINGS PROFILE' = 109, 'ALTER SETTINGS PROFILE' = 110, 'DROP SETTINGS PROFILE' = 111, 'ALLOW SQL SECURITY NONE' = 112, 'SHOW USERS' = 113, 'SHOW ROLES' = 114, 'SHOW ROW POLICIES' = 115, 'SHOW QUOTAS' = 116, 'SHOW SETTINGS PROFILES' = 117, 'SHOW MASKING POLICIES' = 118, 'SHOW ACCESS' = 119, 'IMPERSONATE' = 120, 'ACCESS MANAGEMENT' = 121, 'SHOW NAMED COLLECTIONS' = 122, 'SHOW NAMED COLLECTIONS SECRETS' = 123, 'NAMED COLLECTION' = 124, 'NAMED COLLECTION ADMIN' = 125, 'SHOW HANDLERS' = 126, 'SET DEFINER' = 127, 'TABLE ENGINE' = 128, 'SYSTEM SHUTDOWN' = 129, 'SYSTEM DROP DNS CACHE' = 130, 'SYSTEM DROP CONNECTIONS CACHE' = 131, 'SYSTEM PREWARM MARK CACHE' = 132, 'SYSTEM DROP MARK CACHE' = 133, 'SYSTEM DROP ICEBERG METADATA CACHE' = 134, 'SYSTEM DROP PAIMON METADATA CACHE' = 135, 'SYSTEM DROP AVRO SCHEMA CACHE' = 136, 'SYSTEM DROP PARQUET METADATA CACHE' = 137, 'SYSTEM DROP POINT IN POLYGON CACHE' = 138, 'SYSTEM PREWARM PRIMARY INDEX CACHE' = 139, 'SYSTEM DROP PRIMARY INDEX CACHE' = 140, 'SYSTEM DROP UNCOMPRESSED CACHE' = 141, 'SYSTEM DROP VECTOR SIMILARITY INDEX CACHE' = 142, 'SYSTEM DROP TEXT INDEX TOKENS CACHE' = 143, 'SYSTEM DROP TEXT INDEX HEADER CACHE' = 144, 'SYSTEM DROP TEXT INDEX POSTINGS CACHE' = 145, 'SYSTEM DROP TEXT INDEX CACHES' = 146, 'SYSTEM DROP MMAP CACHE' = 147, 'SYSTEM DROP QUERY CONDITION CACHE' = 148, 'SYSTEM DROP ENCRYPTION HEADERS CACHE' = 149, 'SYSTEM DROP QUERY CACHE' = 150, 'SYSTEM DROP RUNTIME PROJECTIONS CACHE' = 151, 'SYSTEM DROP COMPILED EXPRESSION CACHE' = 152, 'SYSTEM DROP FILESYSTEM CACHE' = 153, 'SYSTEM DROP DISTRIBUTED CACHE' = 154, 'SYSTEM SYNC FILESYSTEM CACHE' = 155, 'SYSTEM DROP PAGE CACHE' = 156, 'SYSTEM DROP SCHEMA CACHE' = 157, 'SYSTEM DROP FORMAT SCHEMA CACHE' = 158, 'SYSTEM DROP S3 CLIENT CACHE' = 159, 'SYSTEM DROP CACHE' = 160, 'SYSTEM RELOAD CONFIG' = 161, 'SYSTEM RELOAD USERS' = 162, 'SYSTEM RELOAD DICTIONARY' = 163, 'SYSTEM RELOAD MODEL' = 164, 'SYSTEM RELOAD FUNCTION' = 165, 'SYSTEM RELOAD EMBEDDED DICTIONARIES' = 166, 'SYSTEM RELOAD ASYNCHRONOUS METRICS' = 167, 'SYSTEM RECONNECT ZOOKEEPER' = 168, 'SYSTEM RELOAD' = 169, 'SYSTEM RESTART DISK' = 170, 'SYSTEM WAIT BLOBS CLEANUP' = 171, 'SYSTEM MERGES' = 172, 'SYSTEM TTL MERGES' = 173, 'SYSTEM FETCHES' = 174, 'SYSTEM MOVES' = 175, 'SYSTEM PULLING REPLICATION LOG' = 176, 'SYSTEM CLEANUP' = 177, 'SYSTEM VIEWS' = 178, 'SYSTEM STREAMING ENGINES' = 179, 'SYSTEM BACKGROUND' = 180, 'SYSTEM DISTRIBUTED SENDS' = 181, 'SYSTEM REPLICATED SENDS' = 182, 'SYSTEM SENDS' = 183, 'SYSTEM REPLICATION QUEUES' = 184, 'SYSTEM VIRTUAL PARTS UPDATE' = 185, 'SYSTEM REDUCE BLOCKING PARTS' = 186, 'SYSTEM DROP REPLICA' = 187, 'SYSTEM SYNC REPLICA' = 188, 'SYSTEM REPLICA READINESS' = 189, 'SYSTEM RESTART REPLICA' = 190, 'SYSTEM RESTORE REPLICA' = 191, 'SYSTEM RESTORE DATABASE REPLICA' = 192, 'SYSTEM WAIT LOADING PARTS' = 193, 'SYSTEM WAIT QUERY RUNNER' = 194, 'SYSTEM SYNC DATABASE REPLICA' = 195, 'SYSTEM SYNC TRANSACTION LOG' = 196, 'SYSTEM SYNC FILE CACHE' = 197, 'SYSTEM FLUSH DISTRIBUTED' = 198, 'SYSTEM FLUSH LOGS' = 199, 'SYSTEM FLUSH ASYNC INSERT QUEUE' = 200, 'SYSTEM FLUSH OBJECT STORAGE QUEUE' = 201, 'SYSTEM FLUSH' = 202, 'SYSTEM THREAD FUZZER' = 203, 'SYSTEM UNFREEZE' = 204, 'SYSTEM UNLOCK SNAPSHOT' = 205, 'SYSTEM FAILPOINT' = 206, 'SYSTEM MEMORY' = 207, 'SYSTEM LISTEN' = 208, 'SYSTEM JEMALLOC' = 209, 'SYSTEM LOAD PRIMARY KEY' = 210, 'SYSTEM UNLOAD PRIMARY KEY' = 211, 'SYSTEM INSTRUMENT ADD' = 212, 'SYSTEM INSTRUMENT REMOVE' = 213, 'SYSTEM RESET DDL WORKER' = 214, 'SYSTEM' = 215, 'dictGet' = 216, 'displaySecretsInShowAndSelect' = 217, 'addressToLine' = 218, 'addressToLineWithInlines' = 219, 'addressToSymbol' = 220, 'demangle' = 221, 'INTROSPECTION' = 222, 'READ' = 223, 'WRITE' = 224, 'CLUSTER' = 225, 'FILE' = 226, 'URL' = 227, 'REMOTE' = 228, 'MONGO' = 229, 'REDIS' = 230, 'MYSQL' = 231, 'POSTGRES' = 232, 'SQLITE' = 233, 'ODBC' = 234, 'JDBC' = 235, 'HDFS' = 236, 'S3' = 237, 'HIVE' = 238, 'AZURE' = 239, 'KAFKA' = 240, 'NATS' = 241, 'RABBITMQ' = 242, 'YTSAURUS' = 243, 'ARROW FLIGHT' = 244, 'BIGQUERY' = 245, 'DISK' = 246, 'SOURCES' = 247, 'aiClassify' = 248, 'aiEmbed' = 249, 'aiExtract' = 250, 'aiFilter' = 251, 'aiGenerate' = 252, 'aiRedact' = 253, 'aiSimilarity' = 254, 'aiTranslate' = 255, 'AI FUNCTIONS' = 256, 'ALL' = 257, 'NONE' = 258) | Name of a privilege which can be used in the GRANT command. |
aliases | Array(String) | List of aliases which can be used instead of the name of the privilege. |
level | Nullable(Enum8('GLOBAL' = 0, 'DATABASE' = 1, 'TABLE' = 2, 'DICTIONARY' = 3, 'VIEW' = 4, 'COLUMN' = 5, 'NAMED_COLLECTION' = 6, 'USER_NAME' = 7, 'TABLE_ENGINE' = 8, 'DEFINER' = 9, 'SOURCE' = 10)) | Level of the privilege. GLOBAL privileges can be granted only globally (ON *.*), DATABASE privileges can be granted on a specific database (ON <database>.*) or globally (ON *.*), TABLE privileges can be granted either on a specific table or on a specific database or globally, and COLUMN privileges can be granted like TABLE privileges but also allow to specify columns. |
parent_group | Nullable(Enum16('SHOW DATABASES' = 0, 'SHOW TABLES' = 1, 'CHECK' = 2, 'SHOW COLUMNS' = 3, 'SHOW DICTIONARIES' = 4, 'SHOW' = 5, 'SHOW FILESYSTEM CACHES' = 6, 'SELECT' = 7, 'INSERT' = 8, 'ALTER UPDATE' = 9, 'ALTER DELETE' = 10, 'ALTER ADD COLUMN' = 11, 'ALTER MODIFY COLUMN' = 12, 'ALTER DROP COLUMN' = 13, 'ALTER COMMENT COLUMN' = 14, 'ALTER CLEAR COLUMN' = 15, 'ALTER RENAME COLUMN' = 16, 'ALTER MATERIALIZE COLUMN' = 17, 'ALTER COLUMN' = 18, 'ALTER MODIFY COMMENT' = 19, 'ALTER MODIFY DATABASE COMMENT' = 20, 'ALTER ORDER BY' = 21, 'ALTER SAMPLE BY' = 22, 'ALTER ADD INDEX' = 23, 'ALTER DROP INDEX' = 24, 'ALTER MATERIALIZE INDEX' = 25, 'ALTER CLEAR INDEX' = 26, 'ALTER INDEX' = 27, 'ALTER ADD STATISTICS' = 28, 'ALTER DROP STATISTICS' = 29, 'ALTER MODIFY STATISTICS' = 30, 'ALTER MATERIALIZE STATISTICS' = 31, 'ALTER STATISTICS' = 32, 'ALTER ADD PROJECTION' = 33, 'ALTER DROP PROJECTION' = 34, 'ALTER MODIFY PROJECTION' = 35, 'ALTER MATERIALIZE PROJECTION' = 36, 'ALTER CLEAR PROJECTION' = 37, 'ALTER PROJECTION' = 38, 'ALTER ADD CONSTRAINT' = 39, 'ALTER DROP CONSTRAINT' = 40, 'ALTER MODIFY CONSTRAINT' = 41, 'ALTER CONSTRAINT' = 42, 'ALTER TTL' = 43, 'ALTER MATERIALIZE TTL' = 44, 'ALTER REWRITE PARTS' = 45, 'ALTER MATERIALIZE PRIMARY KEY' = 46, 'ALTER SETTINGS' = 47, 'ALTER MOVE PARTITION' = 48, 'ALTER FETCH PARTITION' = 49, 'ALTER FREEZE PARTITION' = 50, 'ALTER UNLOCK SNAPSHOT' = 51, 'ALTER EXECUTE' = 52, 'ALTER DATABASE SETTINGS' = 53, 'ALTER NAMED COLLECTION' = 54, 'ALTER HANDLER' = 55, 'ALTER TABLE' = 56, 'ALTER DATABASE' = 57, 'ALTER VIEW MODIFY QUERY' = 58, 'ALTER VIEW MODIFY REFRESH' = 59, 'ALTER VIEW MODIFY SQL SECURITY' = 60, 'ALTER VIEW' = 61, 'ALTER' = 62, 'CREATE DATABASE' = 63, 'CREATE TABLE' = 64, 'CREATE VIEW' = 65, 'CREATE DICTIONARY' = 66, 'CREATE TEMPORARY TABLE' = 67, 'CREATE ARBITRARY TEMPORARY TABLE' = 68, 'CREATE TEMPORARY VIEW' = 69, 'CREATE FUNCTION' = 70, 'CREATE WORKLOAD' = 71, 'CREATE RESOURCE' = 72, 'CREATE NAMED COLLECTION' = 73, 'CREATE HANDLER' = 74, 'CREATE' = 75, 'DROP DATABASE' = 76, 'DROP TABLE' = 77, 'DROP VIEW' = 78, 'DROP DICTIONARY' = 79, 'DROP FUNCTION' = 80, 'DROP WORKLOAD' = 81, 'DROP RESOURCE' = 82, 'DROP NAMED COLLECTION' = 83, 'DROP HANDLER' = 84, 'DROP' = 85, 'UNDROP TABLE' = 86, 'TRUNCATE' = 87, 'OPTIMIZE' = 88, 'BACKUP' = 89, 'KILL QUERY' = 90, 'KILL TRANSACTION' = 91, 'MOVE PARTITION BETWEEN SHARDS' = 92, 'CREATE USER' = 93, 'ALTER USER' = 94, 'DROP USER' = 95, 'CREATE ROLE' = 96, 'ALTER ROLE' = 97, 'DROP ROLE' = 98, 'ROLE ADMIN' = 99, 'CREATE ROW POLICY' = 100, 'ALTER ROW POLICY' = 101, 'DROP ROW POLICY' = 102, 'CREATE MASKING POLICY' = 103, 'ALTER MASKING POLICY' = 104, 'DROP MASKING POLICY' = 105, 'CREATE QUOTA' = 106, 'ALTER QUOTA' = 107, 'DROP QUOTA' = 108, 'CREATE SETTINGS PROFILE' = 109, 'ALTER SETTINGS PROFILE' = 110, 'DROP SETTINGS PROFILE' = 111, 'ALLOW SQL SECURITY NONE' = 112, 'SHOW USERS' = 113, 'SHOW ROLES' = 114, 'SHOW ROW POLICIES' = 115, 'SHOW QUOTAS' = 116, 'SHOW SETTINGS PROFILES' = 117, 'SHOW MASKING POLICIES' = 118, 'SHOW ACCESS' = 119, 'IMPERSONATE' = 120, 'ACCESS MANAGEMENT' = 121, 'SHOW NAMED COLLECTIONS' = 122, 'SHOW NAMED COLLECTIONS SECRETS' = 123, 'NAMED COLLECTION' = 124, 'NAMED COLLECTION ADMIN' = 125, 'SHOW HANDLERS' = 126, 'SET DEFINER' = 127, 'TABLE ENGINE' = 128, 'SYSTEM SHUTDOWN' = 129, 'SYSTEM DROP DNS CACHE' = 130, 'SYSTEM DROP CONNECTIONS CACHE' = 131, 'SYSTEM PREWARM MARK CACHE' = 132, 'SYSTEM DROP MARK CACHE' = 133, 'SYSTEM DROP ICEBERG METADATA CACHE' = 134, 'SYSTEM DROP PAIMON METADATA CACHE' = 135, 'SYSTEM DROP AVRO SCHEMA CACHE' = 136, 'SYSTEM DROP PARQUET METADATA CACHE' = 137, 'SYSTEM DROP POINT IN POLYGON CACHE' = 138, 'SYSTEM PREWARM PRIMARY INDEX CACHE' = 139, 'SYSTEM DROP PRIMARY INDEX CACHE' = 140, 'SYSTEM DROP UNCOMPRESSED CACHE' = 141, 'SYSTEM DROP VECTOR SIMILARITY INDEX CACHE' = 142, 'SYSTEM DROP TEXT INDEX TOKENS CACHE' = 143, 'SYSTEM DROP TEXT INDEX HEADER CACHE' = 144, 'SYSTEM DROP TEXT INDEX POSTINGS CACHE' = 145, 'SYSTEM DROP TEXT INDEX CACHES' = 146, 'SYSTEM DROP MMAP CACHE' = 147, 'SYSTEM DROP QUERY CONDITION CACHE' = 148, 'SYSTEM DROP ENCRYPTION HEADERS CACHE' = 149, 'SYSTEM DROP QUERY CACHE' = 150, 'SYSTEM DROP RUNTIME PROJECTIONS CACHE' = 151, 'SYSTEM DROP COMPILED EXPRESSION CACHE' = 152, 'SYSTEM DROP FILESYSTEM CACHE' = 153, 'SYSTEM DROP DISTRIBUTED CACHE' = 154, 'SYSTEM SYNC FILESYSTEM CACHE' = 155, 'SYSTEM DROP PAGE CACHE' = 156, 'SYSTEM DROP SCHEMA CACHE' = 157, 'SYSTEM DROP FORMAT SCHEMA CACHE' = 158, 'SYSTEM DROP S3 CLIENT CACHE' = 159, 'SYSTEM DROP CACHE' = 160, 'SYSTEM RELOAD CONFIG' = 161, 'SYSTEM RELOAD USERS' = 162, 'SYSTEM RELOAD DICTIONARY' = 163, 'SYSTEM RELOAD MODEL' = 164, 'SYSTEM RELOAD FUNCTION' = 165, 'SYSTEM RELOAD EMBEDDED DICTIONARIES' = 166, 'SYSTEM RELOAD ASYNCHRONOUS METRICS' = 167, 'SYSTEM RECONNECT ZOOKEEPER' = 168, 'SYSTEM RELOAD' = 169, 'SYSTEM RESTART DISK' = 170, 'SYSTEM WAIT BLOBS CLEANUP' = 171, 'SYSTEM MERGES' = 172, 'SYSTEM TTL MERGES' = 173, 'SYSTEM FETCHES' = 174, 'SYSTEM MOVES' = 175, 'SYSTEM PULLING REPLICATION LOG' = 176, 'SYSTEM CLEANUP' = 177, 'SYSTEM VIEWS' = 178, 'SYSTEM STREAMING ENGINES' = 179, 'SYSTEM BACKGROUND' = 180, 'SYSTEM DISTRIBUTED SENDS' = 181, 'SYSTEM REPLICATED SENDS' = 182, 'SYSTEM SENDS' = 183, 'SYSTEM REPLICATION QUEUES' = 184, 'SYSTEM VIRTUAL PARTS UPDATE' = 185, 'SYSTEM REDUCE BLOCKING PARTS' = 186, 'SYSTEM DROP REPLICA' = 187, 'SYSTEM SYNC REPLICA' = 188, 'SYSTEM REPLICA READINESS' = 189, 'SYSTEM RESTART REPLICA' = 190, 'SYSTEM RESTORE REPLICA' = 191, 'SYSTEM RESTORE DATABASE REPLICA' = 192, 'SYSTEM WAIT LOADING PARTS' = 193, 'SYSTEM WAIT QUERY RUNNER' = 194, 'SYSTEM SYNC DATABASE REPLICA' = 195, 'SYSTEM SYNC TRANSACTION LOG' = 196, 'SYSTEM SYNC FILE CACHE' = 197, 'SYSTEM FLUSH DISTRIBUTED' = 198, 'SYSTEM FLUSH LOGS' = 199, 'SYSTEM FLUSH ASYNC INSERT QUEUE' = 200, 'SYSTEM FLUSH OBJECT STORAGE QUEUE' = 201, 'SYSTEM FLUSH' = 202, 'SYSTEM THREAD FUZZER' = 203, 'SYSTEM UNFREEZE' = 204, 'SYSTEM UNLOCK SNAPSHOT' = 205, 'SYSTEM FAILPOINT' = 206, 'SYSTEM MEMORY' = 207, 'SYSTEM LISTEN' = 208, 'SYSTEM JEMALLOC' = 209, 'SYSTEM LOAD PRIMARY KEY' = 210, 'SYSTEM UNLOAD PRIMARY KEY' = 211, 'SYSTEM INSTRUMENT ADD' = 212, 'SYSTEM INSTRUMENT REMOVE' = 213, 'SYSTEM RESET DDL WORKER' = 214, 'SYSTEM' = 215, 'dictGet' = 216, 'displaySecretsInShowAndSelect' = 217, 'addressToLine' = 218, 'addressToLineWithInlines' = 219, 'addressToSymbol' = 220, 'demangle' = 221, 'INTROSPECTION' = 222, 'READ' = 223, 'WRITE' = 224, 'CLUSTER' = 225, 'FILE' = 226, 'URL' = 227, 'REMOTE' = 228, 'MONGO' = 229, 'REDIS' = 230, 'MYSQL' = 231, 'POSTGRES' = 232, 'SQLITE' = 233, 'ODBC' = 234, 'JDBC' = 235, 'HDFS' = 236, 'S3' = 237, 'HIVE' = 238, 'AZURE' = 239, 'KAFKA' = 240, 'NATS' = 241, 'RABBITMQ' = 242, 'YTSAURUS' = 243, 'ARROW FLIGHT' = 244, 'BIGQUERY' = 245, 'DISK' = 246, 'SOURCES' = 247, 'aiClassify' = 248, 'aiEmbed' = 249, 'aiExtract' = 250, 'aiFilter' = 251, 'aiGenerate' = 252, 'aiRedact' = 253, 'aiSimilarity' = 254, 'aiTranslate' = 255, 'AI FUNCTIONS' = 256, 'ALL' = 257, 'NONE' = 258)) | Parent privilege - if the parent privilege is granted then all its children privileges are considered as granted too. |
processes
Contains a list of currently executing processes (queries) with their progress.
| Column | Type | Comment |
|---|---|---|
is_initial_query | UInt8 | Whether the query is initial. Possible values: 1 — an initial (top-level) query, 0 — a child query initiated by another query, including queries for distributed execution and internal subqueries. |
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. |
query_id | String | Query ID, if defined. |
address | IPv6 | The IP address the query 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. |
port | UInt16 | The client port the query was made from. |
initial_user | String | Name of the user who ran the initial query in the same query chain. |
initial_query_id | String | ID of the initial query in the same query chain. |
initial_address | IPv6 | IP address from which the initial query in the same query chain was launched. |
initial_port | UInt16 | Client port from which the initial query in the same query chain was launched. |
interface | UInt8 | The interface which was used to send the query. TCP = 1, HTTP = 2, GRPC = 3, MYSQL = 4, POSTGRESQL = 5, LOCAL = 6, TCP_INTERSERVER = 7. |
os_user | String | Operating system username who runs rawtree-client. |
client_hostname | String | Hostname of the client machine where the rawtree-client or another TCP client is run. |
client_name | String | The rawtree-client or another TCP client name. |
client_agent | LowCardinality(String) | The AI coding agent that invoked the client (e.g. claude-code, cursor), detected from environment variables. Empty if no agent was detected. |
client_revision | UInt64 | Revision of the rawtree-client or another TCP client. |
client_version_major | UInt64 | Major version of the rawtree-client or another TCP client. |
client_version_minor | UInt64 | Minor version of the rawtree-client or another TCP client. |
client_version_patch | UInt64 | Patch component of the rawtree-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, 4 - PUT method was used, 5 - DELETE method was used, 6 - HEAD method was used. |
http_user_agent | String | HTTP header UserAgent passed in the HTTP query. |
http_referer | String | HTTP header Referer passed in the HTTP query (contains an absolute or partial address of the page making the query). |
forwarded_for | String | HTTP header X-Forwarded-For passed in the HTTP query. |
quota_key | String | The quota key specified in the quotas setting (see keyed). |
distributed_depth | UInt64 | The number of times query was retransmitted between server nodes internally. |
elapsed | Float64 | The time in seconds since request execution started. |
is_cancelled | UInt8 | Was query cancelled. |
is_all_data_sent | UInt8 | Was all data sent to the client (in other words query had been finished on the server). |
read_rows | UInt64 | The number of rows read from the table. For distributed processing, on the requestor server, this is the total for all remote servers. |
read_bytes | 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. |
written_rows | UInt64 | The amount of rows written to the storage. |
written_bytes | UInt64 | The amount of bytes written to the storage. |
memory_usage | Int64 | Amount of RAM the query uses. It might not include some types of dedicated memory |
peak_memory_usage | Int64 | The current peak of memory usage. |
query | String | The query text. For INSERT, it does not include the data to insert. |
normalized_query_hash | UInt64 | A numeric hash value, such as it is identical for queries differ only by values of literals. |
query_kind | String | The type of the query - SELECT, INSERT, etc. |
thread_ids | Array(UInt64) | The list of identifiers of all threads which participated in this query. |
peak_threads_usage | UInt64 | Maximum count of simultaneous threads executing the query. |
ProfileEvents | Map(LowCardinality(String), UInt64) | ProfileEvents calculated for this query. |
Settings | Map(LowCardinality(String), LowCardinality(String)) | The list of modified user-level settings. |
current_database | String | The name of the current database. |
is_internal | UInt8 | Indicates whether it is an auxiliary query executed internally. |
ProfileEvents.Names | Array(String) | — |
ProfileEvents.Values | Array(UInt64) | — |
Settings.Names | Array(String) | — |
Settings.Values | Array(String) | — |
projection_parts
Contains a list of currently existing projection parts (a copy of some part containing aggregated data or just sorted in different order) created for all the projections for all tables within a cluster.
| Column | Type | Comment |
|---|---|---|
partition | String | The partition name. |
name | String | Name of the data part. |
part_type | String | The data part storing format. Possible Values: Wide (a file per column) and Compact (a single file for all columns). |
parent_name | String | The name of the source (parent) data part. |
parent_uuid | UUID | The UUID of the source (parent) data part. |
parent_part_type | String | The source (parent) data part storing format. |
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 about to be deleted. Inactive data parts appear after merging and mutating operations. |
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 does not 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. |
parent_marks | UInt64 | The number of marks in the source (parent) part. |
parent_rows | UInt64 | The number of rows in the source (parent) part. |
parent_bytes_on_disk | UInt64 | Total size of all the source (parent) data part files in bytes. |
parent_data_compressed_bytes | UInt64 | Total size of compressed data in the source (parent) data part. |
parent_data_uncompressed_bytes | UInt64 | Total size of uncompressed data in the source (parent) data part. |
parent_marks_bytes | UInt64 | The size of the file with marks in the source (parent) data part. |
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 | Int64 | The minimum number of data parts that make up the current part after merging. |
max_block_number | Int64 | 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 does not exist. |
database | String | Name of the database. |
table | String | Name of the table. |
engine | String | Name of the table engine without parameters. |
disk_name | String | Name of a disk that stores the data part. |
path | String | Absolute path to the folder with data part files. |
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. |
delete_ttl_info_min | DateTime | The minimum value of the date and time key for TTL DELETE rule. |
delete_ttl_info_max | DateTime | The maximum value of the date and time key for TTL DELETE rule. |
move_ttl_info.expression | Array(String) | Array of expressions. Each expression defines a TTL MOVE rule. |
move_ttl_info.min | Array(DateTime) | Array of date and time values. Each element describes the minimum key value for a TTL MOVE rule. |
move_ttl_info.max | Array(DateTime) | Array of date and time values. Each element describes the maximum key value for a TTL MOVE rule. |
default_compression_codec | String | The name of the codec used to compress this data part (in case when there is no explicit codec for columns). |
recompression_ttl_info.expression | Array(String) | The TTL expression. |
recompression_ttl_info.min | Array(DateTime) | The minimum value of the calculated TTL expression within this part. Used to understand whether we have at least one row with expired TTL. |
recompression_ttl_info.max | Array(DateTime) | The maximum value of the calculated TTL expression within this part. Used to understand whether we have all rows with expired TTL. |
group_by_ttl_info.expression | Array(String) | The TTL expression. |
group_by_ttl_info.min | Array(DateTime) | The minimum value of the calculated TTL expression within this part. Used to understand whether we have at least one row with expired TTL. |
group_by_ttl_info.max | Array(DateTime) | The maximum value of the calculated TTL expression within this part. Used to understand whether we have all rows with expired TTL. |
rows_where_ttl_info.expression | Array(String) | The TTL expression. |
rows_where_ttl_info.min | Array(DateTime) | The minimum value of the calculated TTL expression within this part. Used to understand whether we have at least one row with expired TTL. |
rows_where_ttl_info.max | Array(DateTime) | The maximum value of the calculated TTL expression within this part. Used to understand whether we have all rows with expired TTL. |
is_broken | UInt8 | Whether projection part is broken |
exception_code | Int32 | Exception message explaining broken state of the projection part |
exception | String | Exception code explaining broken state of the projection part |
bytes | UInt64 | — |
marks_size | UInt64 | — |
part_name | String | — |
projection_parts_columns
Contains a list of columns of all currently existing projection parts of all MergeTree tables. Each column is represented by a single row.
| Column | Type | Comment |
|---|---|---|
partition | String | The partition name. |
name | String | Name of the data part. |
part_type | String | The data part storing format. |
parent_name | String | The name of the source (parent) data part. |
parent_uuid | UUID | The UUID of the source (parent) data part. |
parent_part_type | String | The source (parent) data part storing format. |
active | UInt8 | Flag that indicates whether the data part is active |
marks | UInt64 | The number of marks. |
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. |
parent_marks | UInt64 | The number of marks in the source (parent) part. |
parent_rows | UInt64 | The number of rows in the source (parent) part. |
parent_bytes_on_disk | UInt64 | Total size of all the source (parent) data part files in bytes. |
parent_data_compressed_bytes | UInt64 | Total size of compressed data in the source (parent) data part. |
parent_data_uncompressed_bytes | UInt64 | Total size of uncompressed data in the source (parent) data part. |
parent_marks_bytes | UInt64 | The size of the file with marks in the source (parent) data part. |
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 for the Date column if that is included in the partition key. |
max_date | Date | The maximum value for the Date column if that is included in the partition key. |
min_time | DateTime | The minimum value for the DateTime column if that is included in the partition key. |
max_time | DateTime | The maximum value for the DateTime column if that is included in the partition key. |
partition_id | String | ID of the partition. |
min_block_number | Int64 | The minimum number of data parts that make up the current part after merging. |
max_block_number | Int64 | 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. |
database | String | Name of the database. |
table | String | Name of the table. |
engine | String | Name of the table engine without parameters. |
disk_name | String | Name of a disk that stores the data part. |
path | String | Absolute path to the folder with data part files. |
column | String | Name of the column. |
type | String | Column type. |
column_position | UInt64 | Ordinal position of a column in a table starting with 1. |
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. |
column_bytes_on_disk | UInt64 | Total size of the column in bytes. |
column_data_compressed_bytes | UInt64 | Total size of compressed data in the column, in bytes. |
column_data_uncompressed_bytes | UInt64 | Total size of the decompressed data in the column, in bytes. |
column_marks_bytes | UInt64 | The size of the column with marks, in bytes. |
column_modification_time | Nullable(DateTime) | The last time the column was modified. |
bytes | UInt64 | — |
marks_size | UInt64 | — |
part_name | String | — |
projections
Contains all the information about all the projections in tables, similar to system.data_skipping_indices.
| Column | Type | Comment |
|---|---|---|
database | String | Database name. |
table | String | Table name. |
name | String | Projection name. |
type | Enum8('Normal' = 0, 'Aggregate' = 1) | Projection type. |
sorting_key | Array(String) | Projection sorting key. |
query | String | Projection query. |
settings | Map(String, String) | Projection settings. |
query_cache
Contains information about all entries inside query cache in server's memory.
| Column | Type | Comment |
|---|---|---|
query | String | Query string. |
query_id | String | ID of the query. |
is_subquery | UInt8 | Whether the query cache entry is a subquery result. |
result_size | UInt64 | Size of the query cache entry. |
tag | LowCardinality(String) | Tag of the query cache entry. |
stale | UInt8 | If the query cache entry is stale. |
shared | UInt8 | If the query cache entry is shared between multiple users. |
compressed | UInt8 | If the query cache entry is compressed. |
expires_at | DateTime | When the query cache entry becomes stale. |
key_hash | UInt64 | A hash of the query string, used as a key to find query cache entries. |
query_condition_cache
Contains information about all entries inside query condition cache in server's memory.
| Column | Type | Comment |
|---|---|---|
key_hash | UInt128 | Hash of (table_uuid, part_name, condition_hash). |
entry_size | UInt64 | The size of the entry in bytes. |
matching_marks | String | Matching marks. |
quota_limits
Contains information about maximums for all intervals of all quotas. Any number of rows or zero can correspond to specific quota.
| Column | Type | Comment |
|---|---|---|
quota_name | String | Quota name. |
duration | UInt32 | Length of the time interval for calculating resource consumption, in seconds. |
is_randomized_interval | UInt8 | Boolean value. It shows whether the interval is randomized. Interval always starts at the same time if it is not randomized. For example, an interval of 1 minute always starts at an integer number of minutes (i.e. it can start at 11:20:00, but it never starts at 11:20:01), an interval of one day always starts at midnight UTC. If interval is randomized, the very first interval starts at random time, and subsequent intervals starts one by one. Values: 0 — Interval is not randomized, 1 — Interval is randomized. |
max_queries | Nullable(UInt64) | The maximum allowed number of queries of all types allowed to be executed. |
max_query_selects | Nullable(UInt64) | The maximum allowed number of SELECT queries allowed to be executed. |
max_query_inserts | Nullable(UInt64) | The maximum allowed number of INSERT queries allowed to be executed. |
max_errors | Nullable(UInt64) | The maximum number of queries resulted in an error allowed within the specified period of time. |
max_result_rows | Nullable(UInt64) | The maximum total number of rows in the result set of all queries allowed within the specified period of time. |
max_result_bytes | Nullable(UInt64) | The maximum total number of bytes in the result set of all queries allowed within the specified period of time. |
max_read_rows | Nullable(UInt64) | The maximum number of rows to read during execution of all queries allowed within the specified period of time. |
max_read_bytes | Nullable(UInt64) | The maximum number of bytes to read during execution of all queries allowed within the specified period of time. |
max_execution_time | Nullable(Float64) | The maximum amount of time (in nanoseconds) allowed for all queries to execute within the specified period of time |
max_written_bytes | Nullable(UInt64) | The maximum number of bytes to written during execution of all queries allowed within the specified period of time. |
max_failed_sequential_authentications | Nullable(UInt64) | The maximum number of consecutive authentication failures allowed within the specified period of time. |
max_queries_per_normalized_hash | Nullable(UInt64) | The maximum number of executions of any single normalized query allowed within the specified period of time. |
quota_usage
Contains quota usage by the current user: how much is used and how much is left.
| Column | Type | Comment |
|---|---|---|
quota_name | String | Quota name. |
quota_key | String | Key value. |
start_time | Nullable(DateTime) | Start time for calculating resource consumption. |
end_time | Nullable(DateTime) | End time for calculating resource consumption. |
duration | Nullable(UInt32) | Length of the time interval for calculating resource consumption, in seconds. |
queries | Nullable(UInt64) | The current number of executed queries. |
max_queries | Nullable(UInt64) | The maximum allowed number of queries of all types allowed to be executed. |
query_selects | Nullable(UInt64) | The current number of executed SELECT queries. |
max_query_selects | Nullable(UInt64) | The maximum allowed number of SELECT queries allowed to be executed. |
query_inserts | Nullable(UInt64) | The current number of executed INSERT queries. |
max_query_inserts | Nullable(UInt64) | The maximum allowed number of INSERT queries allowed to be executed. |
errors | Nullable(UInt64) | The current number of queries resulted in an error. |
max_errors | Nullable(UInt64) | The maximum number of queries resulted in an error allowed within the specified period of time. |
result_rows | Nullable(UInt64) | The current total number of rows in the result set of all queries within the current period of time. |
max_result_rows | Nullable(UInt64) | The maximum total number of rows in the result set of all queries allowed within the specified period of time. |
result_bytes | Nullable(UInt64) | The current total number of bytes in the result set of all queries within the current period of time. |
max_result_bytes | Nullable(UInt64) | The maximum total number of bytes in the result set of all queries allowed within the specified period of time. |
read_rows | Nullable(UInt64) | The current total number of rows read during execution of all queries within the current period of time. |
max_read_rows | Nullable(UInt64) | The maximum number of rows to read during execution of all queries allowed within the specified period of time. |
read_bytes | Nullable(UInt64) | The current total number of bytes read during execution of all queries within the current period of time. |
max_read_bytes | Nullable(UInt64) | The maximum number of bytes to read during execution of all queries allowed within the specified period of time. |
execution_time | Nullable(Float64) | The current total amount of time (in nanoseconds) spent to execute queries within the current period of time |
max_execution_time | Nullable(Float64) | The maximum amount of time (in nanoseconds) allowed for all queries to execute within the specified period of time |
written_bytes | Nullable(UInt64) | The current total number of bytes written during execution of all queries within the current period of time. |
max_written_bytes | Nullable(UInt64) | The maximum number of bytes to written during execution of all queries allowed within the specified period of time. |
failed_sequential_authentications | Nullable(UInt64) | The current number of consecutive authentication failures within the current period of time. |
max_failed_sequential_authentications | Nullable(UInt64) | The maximum number of consecutive authentication failures allowed within the specified period of time. |
queries_per_normalized_hash | Nullable(UInt64) | The current maximum number of executions of any single normalized query within the current period of time. |
max_queries_per_normalized_hash | Nullable(UInt64) | The maximum number of executions of any single normalized query allowed within the specified period of time. |
quotas
Contains information about quotas.
| Column | Type | Comment |
|---|---|---|
name | String | Quota name. |
id | UUID | Quota ID. |
storage | String | Storage of quotas. Possible value: 'users.xml' if a quota configured in the users.xml file, 'disk' if a quota configured by an SQL-query. |
keys | Array(Enum8('user_name' = 1, 'ip_address' = 2, 'forwarded_ip_address' = 3, 'client_key' = 4, 'normalized_query_hash' = 7)) | Key specifies how the quota should be shared. If two connections use the same quota and key, they share the same amounts of resources. Values: [] — All users share the same quota, ['user_name'] — Connections with the same user name share the same quota, ['ip_address'] — Connections from the same IP share the same quota. ['client_key'] — Connections with the same key share the same quota. A key must be explicitly provided by a client. When using rawtree-client, pass a key value in the --quota_key parameter, or use the quota_key parameter in the client configuration file. When using HTTP interface, use the X-RawTree-Quota (or the compatibility X-ClickHouse-Quota) header, ['user_name', 'client_key'] — Connections with the same client_key share the same quota. If a key isn't provided by a client, the quota is tracked for user_name, ['client_key', 'ip_address'] — Connections with the same client_key share the same quota. If a key isn't provided by a client, the quota is tracked for ip_address. |
durations | Array(UInt32) | Time interval lengths in seconds. |
apply_to_all | UInt8 | Logical value. It shows which users the quota is applied to. Values: 0 — The quota applies to users specify in the apply_to_list. 1 — The quota applies to all users except those listed in apply_to_except. |
apply_to_list | Array(String) | List of user names/roles that the quota should be applied to. |
apply_to_except | Array(String) | List of user names/roles that the quota should not apply to. |
ipv4_prefix_bits | Nullable(UInt8) | Number of prefix bits for IPv4 address masking. Connections from the same subnet share the same quota. Only used when key is ip_address or forwarded_ip_address. |
ipv6_prefix_bits | Nullable(UInt8) | Number of prefix bits for IPv6 address masking. Connections from the same subnet share the same quota. Only used when key is ip_address or forwarded_ip_address. |
quotas_usage
Contains quota usage by all users.
| Column | Type | Comment |
|---|---|---|
quota_name | String | Quota name. |
quota_key | String | Key value. |
is_current | UInt8 | Quota usage for current user. |
start_time | Nullable(DateTime) | Start time for calculating resource consumption. |
end_time | Nullable(DateTime) | End time for calculating resource consumption. |
duration | Nullable(UInt32) | Length of the time interval for calculating resource consumption, in seconds. |
queries | Nullable(UInt64) | The current number of executed queries. |
max_queries | Nullable(UInt64) | The maximum allowed number of queries of all types allowed to be executed. |
query_selects | Nullable(UInt64) | The current number of executed SELECT queries. |
max_query_selects | Nullable(UInt64) | The maximum allowed number of SELECT queries allowed to be executed. |
query_inserts | Nullable(UInt64) | The current number of executed INSERT queries. |
max_query_inserts | Nullable(UInt64) | The maximum allowed number of INSERT queries allowed to be executed. |
errors | Nullable(UInt64) | The current number of queries resulted in an error. |
max_errors | Nullable(UInt64) | The maximum number of queries resulted in an error allowed within the specified period of time. |
result_rows | Nullable(UInt64) | The current total number of rows in the result set of all queries within the current period of time. |
max_result_rows | Nullable(UInt64) | The maximum total number of rows in the result set of all queries allowed within the specified period of time. |
result_bytes | Nullable(UInt64) | The current total number of bytes in the result set of all queries within the current period of time. |
max_result_bytes | Nullable(UInt64) | The maximum total number of bytes in the result set of all queries allowed within the specified period of time. |
read_rows | Nullable(UInt64) | The current total number of rows read during execution of all queries within the current period of time. |
max_read_rows | Nullable(UInt64) | The maximum number of rows to read during execution of all queries allowed within the specified period of time. |
read_bytes | Nullable(UInt64) | The current total number of bytes read during execution of all queries within the current period of time. |
max_read_bytes | Nullable(UInt64) | The maximum number of bytes to read during execution of all queries allowed within the specified period of time. |
execution_time | Nullable(Float64) | The current total amount of time (in nanoseconds) spent to execute queries within the current period of time |
max_execution_time | Nullable(Float64) | The maximum amount of time (in nanoseconds) allowed for all queries to execute within the specified period of time |
written_bytes | Nullable(UInt64) | The current total number of bytes written during execution of all queries within the current period of time. |
max_written_bytes | Nullable(UInt64) | The maximum number of bytes to written during execution of all queries allowed within the specified period of time. |
failed_sequential_authentications | Nullable(UInt64) | The current number of consecutive authentication failures within the current period of time. |
max_failed_sequential_authentications | Nullable(UInt64) | The maximum number of consecutive authentication failures allowed within the specified period of time. |
queries_per_normalized_hash | Nullable(UInt64) | The current maximum number of executions of any single normalized query within the current period of time. |
max_queries_per_normalized_hash | Nullable(UInt64) | The maximum number of executions of any single normalized query allowed within the specified period of time. |
raw_dynamic_paths
Contains the paths of the __raw_data column of raw tables with the number of active parts holding each path and the type the table metadata declares it with.
| Column | Type | Comment |
|---|---|---|
database | String | Database of the table. |
table | String | Name of the table. |
path | String | Dynamic path of the __raw_data column. |
active_parts | UInt64 | Number of active parts of the table holding the path among their dynamic paths. A typed path of the JSON type is not a dynamic path, so it is not counted. |
declared_type | String | The type the table metadata declares the path with: the type of a typed path of the JSON type, or Dynamic for a path of a key, an index, a projection or a TTL expression. Such a path is known with or without data. Empty when the path is known from the parts only. |
remote_data_paths
Contains a mapping from a filename on local filesystem to a blob name inside object storage.
| Column | Type | Comment |
|---|---|---|
disk_name | String | Disk name. |
path | String | Disk path. |
cache_base_path | String | Base directory of cache files. |
local_path | String | Path of RawTree file, also used as metadata path. |
remote_path | String | Blob path in object storage, with which RawTree file is associated with. |
size | UInt64 | Size of the file (compressed). |
common_prefix_for_blobs | String | Common prefix for blobs in object storage. |
cache_paths | Array(String) | Cache files for corresponding blob. |
replicas
Contains information and status of all table replicas on current server. Each replica is represented by a single row.
| Column | Type | Comment |
|---|---|---|
database | String | Database name. |
table | String | Table name. |
uuid | UUID | Table UUID. |
engine | String | Table engine name. |
is_leader | UInt8 | Whether the replica is the leader. Multiple replicas can be leaders at the same time. A replica can be prevented from becoming a leader using the merge_tree setting replicated_can_become_leader. The leaders are responsible for scheduling background merges. 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 a leader. |
is_readonly | UInt8 | Whether the replica is in read-only mode. This mode is turned on if the config does not have sections with RawTree Keeper, if an unknown error occurred when reinitializing sessions in RawTree Keeper, and during session reinitialization in RawTree Keeper. |
readonly_start_time | Nullable(DateTime) | The timestamp when the replica transitioned into readonly mode. Null if the replica is not in readonly mode. |
is_session_expired | UInt8 | Whether the session with RawTree Keeper 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_name | String | The name of the [Zoo]Keeper cluster (possibly auxiliary one) where the table's metadata is stored |
zookeeper_path | String | Path to table data in RawTree Keeper. |
replica_name | String | Replica name in RawTree Keeper. Different replicas of the same table have different names. |
replica_path | String | Path to replica data in RawTree Keeper. 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. |
oldest_part_to_get | String | The name of the part to fetch from other replicas obtained from the oldest GET_PARTS entry in the replication queue. |
oldest_part_to_merge_to | String | The result part name to merge to obtained from the oldest MERGE_PARTS entry in the replication queue. |
oldest_part_to_mutate_to | String | The result part name to mutate to obtained from the oldest MUTATE_PARTS entry in the replication queue. |
log_max_index | UInt64 | Maximum entry number in the log of general activity. This column and the next three (log_pointer, total_replicas, active_replicas) have a non-zero value only where there is an active session with ClickHouse Keeper. |
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 | UInt32 | The total number of known replicas of this table. |
active_replicas | UInt32 | The number of replicas of this table that have a session in RawTree Keeper (i.e., the number of functioning replicas). |
lost_part_count | UInt64 | The number of data parts lost in the table by all replicas in total since table creation. Value is persisted in RawTree Keeper and can only increase. |
last_queue_update_exception | String | When the queue contains broken entries. Especially important when RawTree breaks backward compatibility between versions and log entries written by newer versions aren't parseable by old versions. |
zookeeper_exception | String | The last exception message, got if the error happened when fetching the info from RawTree Keeper. |
replica_is_active | Map(String, UInt8) | Map between replica name and is replica active. |
readonly_duration | Nullable(UInt64) | — |
replicated_fetches
Contains information about currently running background fetches.
| Column | Type | Comment |
|---|---|---|
database | String | Name of the database. |
table | String | Name of the table. |
elapsed | Float64 | The time elapsed (in seconds) since showing currently running background fetches started. |
progress | Float64 | The percentage of completed work from 0 to 1. |
result_part_name | String | The name of the part that will be formed as the result of showing currently running background fetches. |
result_part_path | String | Absolute path to the part that will be formed as the result of showing currently running background fetches. |
partition_id | String | ID of the partition. |
total_size_bytes_compressed | UInt64 | The total size (in bytes) of the compressed data in the result part. |
bytes_read_compressed | UInt64 | The number of compressed bytes read from the result part. |
source_replica_path | String | Absolute path to the source replica. |
source_replica_hostname | String | Hostname of the source replica. |
source_replica_port | UInt16 | Port number of the source replica. |
interserver_scheme | String | Name of the interserver scheme. |
URI | String | Uniform resource identifier. |
to_detached | UInt8 | The flag indicates whether the currently running background fetch is being performed using the TO DETACHED expression. |
thread_id | UInt64 | Thread identifier. |
replicated_merge_tree_settings
Contains a list of all ReplicatedMergeTree engine specific settings, their current and default values along with descriptions. You may change any of them in SETTINGS section in CREATE query.
| Column | Type | Comment |
|---|---|---|
name | String | Setting name. |
value | String | Setting value. |
default | String | Setting default value. |
changed | UInt8 | 1 if the setting was explicitly defined in the config or explicitly changed. |
description | String | Setting description. |
min | Nullable(String) | Minimum value of the setting, if any is set via constraints. If the setting has no minimum value, contains NULL. |
max | Nullable(String) | Maximum value of the setting, if any is set via constraints. If the setting has no maximum value, contains NULL. |
disallowed_values | Array(String) | List of disallowed values |
readonly | UInt8 | Shows whether the current user can change the setting: 0 — Current user can change the setting, 1 — Current user can't change the setting. |
type | String | Setting type (implementation specific string value). |
is_obsolete | UInt8 | Shows whether a setting is obsolete. |
tier | Enum8('Production' = 0, 'Obsolete' = 4, 'Experimental' = 8, 'Beta' = 12, 'PrivatePreview' = 16) | Support level for this feature. RawTree features are organized in tiers, varying depending on the current status of their development and the expectations one might have when using them: * PRODUCTION: The feature is stable, safe to use and does not have issues interacting with other PRODUCTION features. * BETA: The feature is stable and safe. The outcome of using it together with other features is unknown and correctness is not guaranteed. Testing and reports are welcome. * EXPERIMENTAL: The feature is under development. Only intended for developers and RawTree enthusiasts. The feature might or might not work and could be removed at any time. * PRIVATE PREVIEW: The feature is on a clear path to general availability. Its applicability is still limited and it is not recommended for production use. * OBSOLETE: No longer supported. Either it is already removed or it will be removed in future releases. |
replication_queue
Contains information about tasks from replication queues stored in RawTree Keeper, or ZooKeeper, for each table replica.
| Column | Type | Comment |
|---|---|---|
database | String | Name of the database. |
table | String | Name of the table. |
replica_name | String | Replica name in RawTree Keeper. Different replicas of the same table have different names. |
position | UInt32 | Position of the task in the queue. |
node_name | String | Node name in RawTree Keeper. |
type | String | Type of the task in the queue, one of: • GET_PART — Get the part from another replica, • ATTACH_PART — Attach the part, possibly from our own replica (if found in the detached folder). You may think of it as a GET_PART with some optimizations as they're nearly identical, • MERGE_PARTS — Merge the parts, • DROP_RANGE — Delete the parts in the specified partition in the specified number range. • CLEAR_COLUMN — NOTE: Deprecated. Drop specific column from specified partition. • CLEAR_INDEX — NOTE: Deprecated. Drop specific index from specified partition. • REPLACE_RANGE — Drop a certain range of parts and replace them with new ones. • MUTATE_PART — Apply one or several mutations to the part. • ALTER_METADATA — Apply alter modification according to global /metadata and /columns paths. |
create_time | DateTime | Date and time when the task was submitted for execution. |
required_quorum | UInt32 | The number of replicas waiting for the task to complete with confirmation of completion. This column is only relevant for the GET_PARTS task. |
source_replica | String | Name of the source replica. |
new_part_name | String | Name of the new part. |
parts_to_merge | Array(String) | Names of parts to merge or update. |
is_detach | UInt8 | The flag indicates whether the DETACH_PARTS task is in the queue. |
is_currently_executing | UInt8 | The flag indicates whether a specific task is being performed right now. |
num_tries | UInt32 | The number of failed attempts to complete the task. |
last_exception | String | Text message about the last error that occurred (if any). |
last_exception_time | DateTime | Date and time when the last error occurred. |
last_attempt_time | DateTime | Date and time when the task was last attempted. |
num_postponed | UInt32 | The number of times the action was postponed. |
postpone_reason | String | The reason why the task was postponed. |
last_postpone_time | DateTime | Date and time when the task was last postponed. |
merge_type | String | Type of the current merge. Empty if it's a mutation. |
resources
Contains a list of all currently existing resources.
| Column | Type | Comment |
|---|---|---|
name | String | The name of the resource. |
read_disks | Array(String) | The list of disk names that uses this resource for read operations. |
write_disks | Array(String) | The list of disk names that uses this resource for write operations. |
unit | String | Resource unit used for cost measurements. |
create_query | String | CREATE query of the resource. |
rocksdb
Contains a list of metrics exposed from embedded RocksDB.
| Column | Type | Comment |
|---|---|---|
database | String | Database name. |
table | String | Name of the table with StorageEmbeddedRocksDB engine. |
name | String | Metric name. |
value | UInt64 | Metric value. |
role_grants
Contains the role grants for users and roles. To add entries to this table, use GRANT role TO user. Using this table you may find out which roles are assigned to which users or which roles a user has.
| Column | Type | Comment |
|---|---|---|
user_name | Nullable(String) | User name. |
role_name | Nullable(String) | Role name. |
granted_role_name | String | Name of role granted to the role_name role. To grant one role to another one use GRANT role1 TO role2. |
granted_role_id | UUID | The ID of the role. |
granted_role_is_default | UInt8 | Flag that shows whether granted_role is a default role. Possible values: • 1 — granted_role is a default role, • 0 — granted_role is not a default role. |
with_admin_option | UInt8 | Flag that shows whether granted_role is a role with ADMIN OPTION privilege. Possible values: • 1 — The role has ADMIN OPTION privilege.• 0 — The role without ADMIN OPTION privilege. |
roles
Contains a list of all roles created at the server.
| Column | Type | Comment |
|---|---|---|
name | String | Role name. |
id | UUID | Role ID. |
storage | String | Path to the storage of roles. Configured in the access_control_path parameter. |
row_policies
Contains filters for one particular table, as well as a list of roles and/or users which should use this row policy.
| Column | Type | Comment |
|---|---|---|
name | String | Name of a row policy. |
short_name | String | Short name of a row policy. Names of row policies are compound, for example: myfilter ON mydb.mytable. Here 'myfilter ON mydb.mytable' is the name of the row policy, 'myfilter' is it's short name. |
database | String | Database name. |
table | String | Table name. Empty if policy for database. |
id | UUID | Row policy ID. |
storage | String | Name of the directory where the row policy is stored. |
select_filter | Nullable(String) | Expression which is used for filtering in SELECT queries. |
is_restrictive | UInt8 | Shows whether the row policy restricts access to rows. Value: • 0 — The row policy is defined with AS PERMISSIVE clause, • 1 — The row policy is defined with AS RESTRICTIVE clause. |
apply_to_all | UInt8 | Shows that the row policies set for all roles and/or users. |
apply_to_list | Array(String) | List of the roles and/or users to which the row policies is applied. |
apply_to_except | Array(String) | The row policies is applied to all roles and/or users excepting of the listed ones. |
runtime_projections_cache
Contains the entries of the runtime projections cache in server's memory: the partial aggregation states of data parts.
| Column | Type | Comment |
|---|---|---|
database | String | Database of the table. Empty if the table no longer exists. |
table | String | Name of the table. Empty if the table no longer exists. |
table_uuid | UUID | UUID of the table. |
part_name | String | Name of the data part whose aggregation states or top rows the entry holds. |
filter | String | Filter applied to the rows of the part before the aggregation or the sorting. Empty if there is none. |
aggregate_keys | String | Keys of the aggregation. Empty for a TopK entry. |
aggregates | String | Aggregate functions whose states the entry holds. Empty for a TopK entry. |
sort_description | String | Sort keys of the top rows the entry holds. Empty for an Aggregation entry. |
limit | UInt64 | Number of top rows of the part the entry holds (LIMIT plus OFFSET). 0 for an Aggregation entry. |
key | UInt128 | Key of the entry. Entries of the same query over different parts differ only by the part. |
size_in_bytes | UInt64 | Size of the entry in memory. |
rejected | UInt8 | 1 if the states or the rows of the part exceeded a limit when they were computed. Such an entry holds nothing, and the part is read as usual. |
kind | Enum8('Aggregation' = 0, 'TopK' = 1) | What the entry holds: Aggregation for the partial aggregation states of a GROUP BY, TopK for the top rows of an ORDER BY ... LIMIT. |
s3_queue_metadata
Contains the current number of processed, processing and failed nodes in keeper for each S3Queue metadata object and, on demand, their contents. Unlike system.s3queue_metadata_cache, which shows the in-memory cache, this table reads the state directly from keeper.
| Column | Type | Comment |
|---|---|---|
zookeeper_path | String | Path in zookeeper to metadata. For a queue on an auxiliary zookeeper this is the factory key <zookeeper_name>:<path>, not the raw keeper path. |
processed_nodes_count | Nullable(UInt64) | Number of nodes in the processed directory in keeper. Only set for unordered mode: in ordered mode there are no per-file processed nodes (see processed_path instead), so the value is NULL. |
processing_nodes_count | UInt64 | Number of nodes in the processing directory in keeper |
failed_nodes_count | UInt64 | Number of nodes in the failed directory in keeper |
processed_nodes | Map(String, String) | Contents (node name -> node data) of the processed directory in keeper. Only filled for unordered mode. Fetched only when this column is selected. |
processing_nodes | Map(String, String) | Contents (node name -> node data) of the processing directory in keeper. Fetched only when this column is selected. |
failed_nodes | Map(String, String) | Contents (node name -> node data) of the failed directory in keeper. Fetched only when this column is selected. |
processed_path | Map(String, String) | Last processed path per processed pointer in keeper (relative pointer path -> last processed file path). Only filled for ordered mode, where it covers the single, per-bucket and per-partition pointers. Fetched only when this column is selected. |
s3_queue_settings
Contains a list of settings of S3Queue tables.
| Column | Type | Comment |
|---|---|---|
database | String | Database of the table with S3Queue engine. |
table | String | Name of the table with S3Queue engine. |
name | String | Setting name. |
value | String | Setting value. |
type | String | Setting type (implementation specific string value). |
changed | UInt8 | 1 if the setting was explicitly defined in the config or explicitly changed. |
description | String | Setting description. |
alterable | UInt8 | Shows whether the current user can change the setting via ALTER TABLE MODIFY SETTING: 0 — Current user can't change the setting, 1 — Current user can change the setting. |
s3queue_metadata_cache
Contains in-memory state of S3Queue metadata and currently processed rows per file.
| Column | Type | Comment |
|---|---|---|
zookeeper_path | String | Path in zookeeper to metadata |
file_path | String | File path of a file which is being processed |
file_name | String | File name of a file which is being processed |
rows_processed | UInt64 | Currently processed number of rows |
status | String | Status of processing: Processed, Processing, Failed |
processing_start_time | Nullable(DateTime) | Time at which processing of the file started |
processing_end_time | Nullable(DateTime) | Time at which processing of the file ended |
exception | String | Exception which happened during processing |
scheduler
Contains information and status for scheduling nodes residing on the local server.
| Column | Type | Comment |
|---|---|---|
resource | String | Resource name |
path | String | Path to a scheduling node within this resource scheduling hierarchy |
type | String | Type of a scheduling node. |
weight | Float64 | Weight of a node, used by a parent node of fair type. |
priority | Int64 | Priority of a node, used by a parent node of 'priority' type (Lower value means higher priority). |
precedence | Int64 | Precedence of a node, used by space-shared (memory) parent nodes to order admission and eviction (Lower value means higher precedence). |
is_active | Nullable(UInt8) | Whether this node is currently active - has resource requests to be dequeued and constraints satisfied. |
active_children | Nullable(UInt64) | The number of children in active state. |
dequeued_requests | Nullable(UInt64) | The total number of resource requests dequeued from this node. |
canceled_requests | Nullable(UInt64) | The total number of resource requests canceled from this node. |
rejected_requests | Nullable(UInt64) | The total number of resource requests rejected from this node. |
dequeued_cost | Nullable(Int64) | The sum of costs (e.g. size in bytes) of all requests dequeued from this node. |
canceled_cost | Nullable(Int64) | The sum of costs (e.g. size in bytes) of all requests canceled from this node. |
rejected_cost | Nullable(Int64) | The sum of costs (e.g. size in bytes) of all requests rejected from this node. |
busy_periods | Nullable(UInt64) | The total number of deactivations of this node. |
throughput | Nullable(Float64) | Current average throughput (dequeued cost per second). |
vruntime | Nullable(Float64) | For children of fair nodes only. Virtual runtime of a node used by SFQ algorithm to select the next child to process in a max-min fair manner. |
system_vruntime | Nullable(Float64) | For fair nodes only. Virtual runtime showing vruntime of the last processed resource request. Used during child activation as the new value of vruntime. |
queue_length | Nullable(UInt64) | For fifo nodes only. Current number of resource requests residing in the queue. |
queue_cost | Nullable(Int64) | For fifo nodes only. Sum of costs (e.g. size in bytes) of all requests residing in the queue. |
budget | Nullable(Int64) | For fifo nodes only. The number of available 'cost units' for new resource requests. Can appear in case of discrepancy of estimated and real costs of resource requests (e.g. after read/write failure) |
is_satisfied | Nullable(UInt8) | For constraint nodes only (e.g. inflight_limit). Equals to 1 if all the constraint of this node are satisfied. |
inflight_requests | Nullable(Int64) | For inflight_limit nodes only. The number of resource requests dequeued from this node, that are currently in consumption state. |
inflight_cost | Nullable(Int64) | For inflight_limit nodes only. The sum of costs (e.g. bytes) of all resource requests dequeued from this node, that are currently in consumption state. |
max_requests | Nullable(Int64) | For inflight_limit nodes only. Upper limit for inflight_requests leading to constraint violation. |
max_cost | Nullable(Int64) | For inflight_limit nodes only. Upper limit for inflight_cost leading to constraint violation. |
max_speed | Nullable(Float64) | For bandwidth_limit nodes only. Upper limit for bandwidth in tokens per second. |
max_burst | Nullable(Float64) | For bandwidth_limit nodes only. Upper limit for tokens available in token-bucket throttler. |
throttling_us | Nullable(Int64) | For bandwidth_limit nodes only. Total number of microseconds this node was in throttling state. |
tokens | Nullable(Float64) | For bandwidth_limit nodes only. Number of tokens currently available in token-bucket throttler. |
allocated | Nullable(Int64) | For space-shared nodes only. The currently allocated amount of resource under this node. |
allocations | Nullable(UInt64) | For space-shared nodes only. The current number of running resource allocations under this node. |
updates | Nullable(UInt64) | For space-shared nodes only. The total number of updates propagated through this node. |
increases | Nullable(UInt64) | For space-shared nodes only. The total number of increase requests approved by this node. |
decreases | Nullable(UInt64) | For space-shared nodes only. The total number of decrease requests approved by this node. |
admits | Nullable(UInt64) | For space-shared nodes only. The total number of allocations admitted by this node. |
removes | Nullable(UInt64) | For space-shared nodes only. The total number of allocations removed from this node. |
killers | Nullable(UInt64) | For space-shared nodes only. The total number of evictions initiated due to increase requests by this node. |
victims | Nullable(UInt64) | For space-shared nodes only. The total number of allocations that were evicted from this node. |
rejects | Nullable(UInt64) | For allocation_queue nodes only. The total number of resource allocations rejected from this node. |
pending | Nullable(UInt64) | For allocation_queue nodes only. The current number of pending resource allocations in this node. |
schema_inference_cache
Contains information about all cached file schemas.
| Column | Type | Comment |
|---|---|---|
storage | String | Storage name: File, URL, S3 or HDFS. |
source | String | File source. |
format | String | Format name. |
additional_format_info | String | Additional information required to identify the schema. For example, format specific settings. |
registration_time | DateTime | Timestamp when schema was added in cache. |
schema | Nullable(String) | Cached schema. |
number_of_rows | Nullable(UInt64) | Number of rows in the file in given format. It's used for caching trivial count() from data files and for caching number of rows from the metadata during schema inference. |
schema_inference_mode | Nullable(String) | Scheme inference mode. |
server_settings
Contains a list of all server-wide settings (which are effective only on server startup and usually cannot be modified at runtime), their current and default values along with descriptions.
| Column | Type | Comment |
|---|---|---|
name | String | Server setting name. |
value | String | Server setting value. |
default | String | Server setting default value. |
changed | UInt8 | Shows whether a setting was specified in config.xml |
description | String | Short server setting description. |
type | String | Server setting value type. |
changeable_without_restart | Enum8('No' = 0, 'IncreaseOnly' = 1, 'DecreaseOnly' = 2, 'Yes' = 3) | Shows whether a setting can be changed at runtime. |
is_obsolete | UInt8 | Shows whether a setting is obsolete. |
settings
Contains a list of all user-level settings (which can be modified in a scope of query or session), their current and default values along with descriptions.
| Column | Type | Comment |
|---|---|---|
name | String | Setting name. |
value | String | Setting value. |
changed | UInt8 | Shows whether the setting was explicitly defined in the config or explicitly changed. |
description | String | Short setting description. |
min | Nullable(String) | Minimum value of the setting, if any is set via constraints. If the setting has no minimum value, contains NULL. |
max | Nullable(String) | Maximum value of the setting, if any is set via constraints. If the setting has no maximum value, contains NULL. |
disallowed_values | Array(String) | List of disallowed values |
readonly | UInt8 | Shows whether the current user can change the setting: 0 — Current user can change the setting, 1 — Current user can't change the setting. |
type | String | The type of the value that can be assigned to this setting. |
default | String | Setting default value. |
alias_for | String | The name of the original setting if the setting is an alias for another setting. |
is_obsolete | UInt8 | Shows whether a setting is obsolete. |
tier | Enum8('Production' = 0, 'Obsolete' = 4, 'Experimental' = 8, 'Beta' = 12, 'PrivatePreview' = 16) | Support level for this feature. RawTree features are organized in tiers, varying depending on the current status of their development and the expectations one might have when using them: * PRODUCTION: The feature is stable, safe to use and does not have issues interacting with other PRODUCTION features. * BETA: The feature is stable and safe. The outcome of using it together with other features is unknown and correctness is not guaranteed. Testing and reports are welcome. * EXPERIMENTAL: The feature is under development. Only intended for developers and RawTree enthusiasts. The feature might or might not work and could be removed at any time. * PRIVATE PREVIEW: The feature is on a clear path to general availability. Its applicability is still limited and it is not recommended for production use. * OBSOLETE: No longer supported. Either it is already removed or it will be removed in future releases. |
settings_changes
Contains the information about the settings changes through different RawTree versions. You may make RawTree behave like a particular previous version by changing the compatibility user-level settings.
| Column | Type | Comment |
|---|---|---|
type | Enum8('Session' = 0, 'MergeTree' = 1) | The group of settings (Session, MergeTree...) |
version | String | The RawTree server version. |
changes | Array(Tuple(name String, previous_value String, new_value String, reason String)) | The list of changes in settings which changed the behaviour of RawTree. |
settings_profile_elements
Describes the content of each settings profile configured on the server. Including settings constraints, roles and users for which the settings are applied, and parent settings profiles.
| Column | Type | Comment |
|---|---|---|
profile_name | Nullable(String) | Setting profile name. |
user_name | Nullable(String) | User name. |
role_name | Nullable(String) | Role name. |
index | UInt64 | Sequential number of the settings profile element. |
setting_name | Nullable(String) | Setting name. |
value | Nullable(String) | Setting value. |
min | Nullable(String) | The minimum value of the setting. NULL if not set. |
max | Nullable(String) | The maximum value of the setting. NULL if not set. |
writability | Nullable(Enum8('WRITABLE' = 0, 'CONST' = 1, 'CHANGEABLE_IN_READONLY' = 2)) | The property which shows whether a setting can be changed or not. |
inherit_profile | Nullable(String) | A parent profile for this setting profile. NULL if not set. Setting profile will inherit all the settings' values and constraints (min, max, readonly) from its parent profiles. |
settings_profiles
Contains properties of configured setting profiles.
| Column | Type | Comment |
|---|---|---|
name | String | Setting profile name. |
id | UUID | Setting profile ID. |
storage | String | Path to the storage of setting profiles. Configured in the access_control_path parameter. |
num_elements | UInt64 | Number of elements for this profile in the system.settings_profile_elements table. |
apply_to_all | UInt8 | Shows that the settings profile set for all roles and/or users. |
apply_to_list | Array(String) | List of the roles and/or users to which the setting profile is applied. |
apply_to_except | Array(String) | The setting profile is applied to all roles and/or users excepting of the listed ones. |
stack_trace
Allows to obtain an unsymbolized stacktrace from all the threads of the server process.
| Column | Type | Comment |
|---|---|---|
thread_name | String | The name of the thread. |
thread_id | UInt64 | The thread identifier |
query_id | String | The ID of the query this thread belongs to. |
trace | Array(UInt64) | The stacktrace of this thread. Basically just an array of addresses. |
untracked_memory | Int64 | Per-thread counter of memory allocations not yet propagated to the parent MemoryTracker. May be negative if more was freed than allocated since the last flush. |
stemmers
Contains a list of the available stemmers.
| Column | Type | Comment |
|---|---|---|
name | String | Identifier of the Snowball stemmer (language/algorithm) |
storage_policies
Contains information about storage policies and volumes defined in the server configuration.
| Column | Type | Comment |
|---|---|---|
policy_name | String | The name of the storage policy. |
volume_name | String | The name of the volume. |
volume_priority | UInt64 | The priority of the volume. |
disks | Array(String) | The list of all disks names which are a part of this storage policy. |
volume_type | Enum8('JBOD' = 0, 'SINGLE_DISK' = 1, 'UNKNOWN' = 2) | The type of the volume - JBOD or a single disk. |
max_data_part_size | UInt64 | the maximum size of a part that can be stored on any of the volumes disks. |
move_factor | Float32 | When the amount of available space gets lower than this factor, data automatically starts to move on the next volume if any (by default, 0.1). |
prefer_not_to_merge | UInt8 | You should not use this setting. Disables merging of data parts on this volume (this is harmful and leads to performance degradation). |
perform_ttl_move_on_insert | UInt8 | Disables TTL move on data part INSERT. By default (if enabled) if we insert a data part that already expired by the TTL move rule it immediately goes to a volume/disk declared in move rule. |
load_balancing | Enum8('ROUND_ROBIN' = 0, 'LEAST_USED' = 1) | Policy for disk balancing, round_robin or least_used. |
symbols
Contains information for introspection of RawTree binary. This table is only useful for C++ experts and RawTree engineers.
| Column | Type | Comment |
|---|---|---|
symbol | String | Symbol name in the binary. It is mangled. You can apply demangle(symbol) to obtain a readable name. |
symbol_demangled | Nullable(String) | Demangled symbol used for XRay instrumentation. |
function_id | Nullable(Int32) | Function ID in the XRay instrumentation map. |
address_begin | UInt64 | Start address of the symbol in the binary. |
address_end | UInt64 | End address of the symbol in the binary. |
table_engines
Contains a list of all available table engines along with information whether a particular table engine supports some specific features (e.g. settings, skipping indices, projections, replication, TTL, deduplication, parallel insert, etc.)
| Column | Type | Comment |
|---|---|---|
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_projections | UInt8 | Flag that indicated if table engine supports projections. |
supports_sort_order | UInt8 | Flag that indicates if table engine supports clauses PARTITION_BY, PRIMARY_KEY, ORDER_BY and SAMPLE_BY. |
supports_ttl | UInt8 | Flag that indicates if table engine supports TTL. |
supports_replication | UInt8 | Flag that indicates if table engine supports data replication. |
supports_deduplication | UInt8 | Flag that indicates if table engine supports data deduplication. |
supports_parallel_insert | UInt8 | Flag that indicates if table engine supports parallel insert (see max_insert_threads setting). |
description | String | A description of what the table engine does. For engines that have a dedicated documentation page, this contains the full Markdown body of that page; for the remaining engines it is a concise summary. |
syntax | String | How the table engine is used when creating a table. For most engines this is the ENGINE clause of a CREATE TABLE query, but some engines (such as the various kinds of views or the Loop engine) are used through other forms, such as CREATE VIEW or a SELECT from a table function. |
examples | String | Usage examples. |
introduced_in | String | The ClickHouse version in which the table engine was first introduced, in the form major.minor. |
related | Array(String) | The names of related table engines. |
table_functions
Contains a list of all available table functions with their descriptions.
| Column | Type | Comment |
|---|---|---|
name | String | Name of a table function. |
description | String | Brief description of a table function. |
allow_readonly | UInt8 | Flag that indicated whether a readonly user may use this function. |
tables
Lists all tables of the current server.
| Column | Type | Comment |
|---|---|---|
database | String | The name of the database the table is in. |
name | String | Table name. |
uuid | UUID | Table uuid (Atomic database). |
engine | String | Table engine name (without parameters). |
is_temporary | UInt8 | Flag that indicates whether the table is temporary. |
data_paths | Array(String) | Paths to the table data in the file systems. |
metadata_path | String | Path to the table metadata in the file system. |
metadata_modification_time | DateTime | Time of latest modification of the table metadata. |
metadata_version | Int32 | Metadata version for ReplicatedMergeTree table, 0 for non ReplicatedMergeTree table. |
dependencies_database | Array(String) | Database dependencies. |
dependencies_table | Array(String) | Table dependencies (materialized views the current table). |
create_table_query | String | The query that was used to create the table. |
engine_full | String | Parameters of the table engine. |
as_select | String | SELECT query for view. |
parameterized_view_parameters | Array(Tuple(name String, type String)) | Parameters of parameterized view. |
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. |
unique_key | String | The unique key expression specified in the table (UNIQUE KEY clause). |
skipping_indices_types | Array(String) | An array of the distinct types of data skipping indices defined on the table (for example minmax, set, bloom_filter, ngrambf_v1, tokenbf_v1, text, vector_similarity). Empty for tables without skip indices. |
storage_policy | String | The storage policy. Relevant for tables using MergeTree and Distributed engines. |
total_rows | Nullable(UInt64) | Total number of rows, if it is possible to quickly determine exact number of rows in the table, otherwise NULL (including underlying Buffer table). |
total_bytes | Nullable(UInt64) | Total number of bytes, if it is possible to quickly determine exact number of bytes for the table on storage, otherwise NULL (does not includes any underlying storage). If the table stores data on disk, returns used space on disk (i.e. compressed). If the table stores data in memory, returns approximated number of used bytes in memory. |
total_bytes_uncompressed | Nullable(UInt64) | Total number of uncompressed bytes, if it's possible to quickly determine the exact number of bytes from the part checksums for the table on storage, otherwise NULL (does not take underlying storage (if any) into account). |
parts | Nullable(UInt64) | The total number of parts in this table. |
active_parts | Nullable(UInt64) | The number of active parts in this table. |
total_marks | Nullable(UInt64) | The total number of marks in all parts in this table. |
active_on_fly_data_mutations | UInt64 | Total number of active data mutations (UPDATEs and DELETEs) suitable for applying on the fly. |
active_on_fly_alter_mutations | UInt64 | Total number of active alter mutations (MODIFY COLUMN) suitable for applying on the fly. |
active_on_fly_metadata_mutations | UInt64 | Total number of active metadata mutations (RENAMEs) suitable for applying on the fly. |
columns_descriptions_cache_size | UInt64 | Size of columns description cache for *MergeTree tables |
lifetime_rows | Nullable(UInt64) | Total number of rows INSERTed since server start (only for Buffer tables). |
lifetime_bytes | Nullable(UInt64) | Total number of bytes INSERTed since server start (only for Buffer tables). |
comment | String | The comment for the table. |
has_own_data | UInt8 | Flag that indicates whether the table itself stores some data on disk or only accesses some other source. |
loading_dependencies_database | Array(String) | Database loading dependencies (list of objects which should be loaded before the current object). |
loading_dependencies_table | Array(String) | Table loading dependencies (list of objects which should be loaded before the current object). |
loading_dependent_database | Array(String) | Dependent loading database. |
loading_dependent_table | Array(String) | Dependent loading table. |
target_database | String | For a materialized view, the database of the destination table the view writes to (the TO target, or the implicit .inner.* table). Empty for other engines. |
target_table | String | For a materialized view, the name of the destination table the view writes to (the TO target, or the implicit .inner.* table). Empty for other engines. |
definer | String | SQL security definer's name used for the table. |
table | String | — |
time_zones
Contains a list of time zones that are supported by the RawTree server. This list of timezones might vary depending on the version of RawTree.
| Column | Type | Comment |
|---|---|---|
time_zone | String | List of supported time zones. |
tokenizers
Contains a list of the available tokenizers.
| Column | Type | Comment |
|---|---|---|
name | String | Name of the tokenizer |
unicode
Contains all unicode codepoints.
| Column | Type | Comment |
|---|---|---|
code_point | String | The Unicode code point represented as U+XXXX. |
code_point_value | Int32 | The integer value of the Unicode code point. |
notation | String | The character notation (visual representation of the code point). |
alphabetic | Bool | — |
ascii_hex_digit | Bool | — |
bidi_control | Bool | — |
bidi_mirrored | Bool | — |
dash | Bool | — |
default_ignorable_code_point | Bool | — |
deprecated | Bool | — |
diacritic | Bool | — |
extender | Bool | — |
full_composition_exclusion | Bool | — |
grapheme_base | Bool | — |
grapheme_extend | Bool | — |
grapheme_link | Bool | — |
hex_digit | Bool | — |
hyphen | Bool | — |
id_continue | Bool | — |
id_start | Bool | — |
ideographic | Bool | — |
ids_binary_operator | Bool | — |
ids_trinary_operator | Bool | — |
join_control | Bool | — |
logical_order_exception | Bool | — |
lowercase | Bool | — |
math | Bool | — |
noncharacter_code_point | Bool | — |
quotation_mark | Bool | — |
radical | Bool | — |
soft_dotted | Bool | — |
terminal_punctuation | Bool | — |
unified_ideograph | Bool | — |
uppercase | Bool | — |
white_space | Bool | — |
xid_continue | Bool | — |
xid_start | Bool | — |
case_sensitive | Bool | — |
sentence_terminal | Bool | — |
variation_selector | Bool | — |
nfd_inert | Bool | — |
nfkd_inert | Bool | — |
nfc_inert | Bool | — |
nfkc_inert | Bool | — |
segment_starter | Bool | — |
pattern_syntax | Bool | — |
pattern_white_space | Bool | — |
alnum | Bool | — |
blank | Bool | — |
graph | Bool | — |
print | Bool | — |
xdigit | Bool | — |
cased | Bool | — |
case_ignorable | Bool | — |
changes_when_lowercased | Bool | — |
changes_when_uppercased | Bool | — |
changes_when_titlecased | Bool | — |
changes_when_casefolded | Bool | — |
changes_when_casemapped | Bool | — |
changes_when_nfkc_casefolded | Bool | — |
emoji | Bool | — |
emoji_presentation | Bool | — |
emoji_modifier | Bool | — |
emoji_modifier_base | Bool | — |
emoji_component | Bool | — |
regional_indicator | Bool | — |
prepended_concatenation_mark | Bool | — |
extended_pictographic | Bool | — |
basic_emoji | Bool | — |
emoji_keycap_sequence | Bool | — |
rgi_emoji_modifier_sequence | Bool | — |
rgi_emoji_flag_sequence | Bool | — |
rgi_emoji_tag_sequence | Bool | — |
rgi_emoji_zwj_sequence | Bool | — |
rgi_emoji | Bool | — |
ids_unary_operator | Bool | — |
id_compat_math_start | Bool | — |
id_compat_math_continue | Bool | — |
bidi_class | Enum8('Left_To_Right' = 0, 'Right_To_Left' = 1, 'European_Number' = 2, 'European_Separator' = 3, 'European_Terminator' = 4, 'Arabic_Number' = 5, 'Common_Separator' = 6, 'Paragraph_Separator' = 7, 'Segment_Separator' = 8, 'White_Space' = 9, 'Other_Neutral' = 10, 'Left_To_Right_Embedding' = 11, 'Left_To_Right_Override' = 12, 'Arabic_Letter' = 13, 'Right_To_Left_Embedding' = 14, 'Right_To_Left_Override' = 15, 'Pop_Directional_Format' = 16, 'Nonspacing_Mark' = 17, 'Boundary_Neutral' = 18, 'First_Strong_Isolate' = 19, 'Left_To_Right_Isolate' = 20, 'Right_To_Left_Isolate' = 21, 'Pop_Directional_Isolate' = 22) | — |
block | Enum16('No_Block' = 0, 'Basic_Latin' = 1, 'Latin_1_Supplement' = 2, 'Latin_Extended_A' = 3, 'Latin_Extended_B' = 4, 'IPA_Extensions' = 5, 'Spacing_Modifier_Letters' = 6, 'Combining_Diacritical_Marks' = 7, 'Greek_And_Coptic' = 8, 'Cyrillic' = 9, 'Armenian' = 10, 'Hebrew' = 11, 'Arabic' = 12, 'Syriac' = 13, 'Thaana' = 14, 'Devanagari' = 15, 'Bengali' = 16, 'Gurmukhi' = 17, 'Gujarati' = 18, 'Oriya' = 19, 'Tamil' = 20, 'Telugu' = 21, 'Kannada' = 22, 'Malayalam' = 23, 'Sinhala' = 24, 'Thai' = 25, 'Lao' = 26, 'Tibetan' = 27, 'Myanmar' = 28, 'Georgian' = 29, 'Hangul_Jamo' = 30, 'Ethiopic' = 31, 'Cherokee' = 32, 'Unified_Canadian_Aboriginal_Syllabics' = 33, 'Ogham' = 34, 'Runic' = 35, 'Khmer' = 36, 'Mongolian' = 37, 'Latin_Extended_Additional' = 38, 'Greek_Extended' = 39, 'General_Punctuation' = 40, 'Superscripts_And_Subscripts' = 41, 'Currency_Symbols' = 42, 'Combining_Diacritical_Marks_For_Symbols' = 43, 'Letterlike_Symbols' = 44, 'Number_Forms' = 45, 'Arrows' = 46, 'Mathematical_Operators' = 47, 'Miscellaneous_Technical' = 48, 'Control_Pictures' = 49, 'Optical_Character_Recognition' = 50, 'Enclosed_Alphanumerics' = 51, 'Box_Drawing' = 52, 'Block_Elements' = 53, 'Geometric_Shapes' = 54, 'Miscellaneous_Symbols' = 55, 'Dingbats' = 56, 'Braille_Patterns' = 57, 'CJK_Radicals_Supplement' = 58, 'Kangxi_Radicals' = 59, 'Ideographic_Description_Characters' = 60, 'CJK_Symbols_And_Punctuation' = 61, 'Hiragana' = 62, 'Katakana' = 63, 'Bopomofo' = 64, 'Hangul_Compatibility_Jamo' = 65, 'Kanbun' = 66, 'Bopomofo_Extended' = 67, 'Enclosed_CJK_Letters_And_Months' = 68, 'CJK_Compatibility' = 69, 'CJK_Unified_Ideographs_Extension_A' = 70, 'CJK_Unified_Ideographs' = 71, 'Yi_Syllables' = 72, 'Yi_Radicals' = 73, 'Hangul_Syllables' = 74, 'High_Surrogates' = 75, 'High_Private_Use_Surrogates' = 76, 'Low_Surrogates' = 77, 'Private_Use_Area' = 78, 'CJK_Compatibility_Ideographs' = 79, 'Alphabetic_Presentation_Forms' = 80, 'Arabic_Presentation_Forms_A' = 81, 'Combining_Half_Marks' = 82, 'CJK_Compatibility_Forms' = 83, 'Small_Form_Variants' = 84, 'Arabic_Presentation_Forms_B' = 85, 'Specials' = 86, 'Halfwidth_And_Fullwidth_Forms' = 87, 'Old_Italic' = 88, 'Gothic' = 89, 'Deseret' = 90, 'Byzantine_Musical_Symbols' = 91, 'Musical_Symbols' = 92, 'Mathematical_Alphanumeric_Symbols' = 93, 'CJK_Unified_Ideographs_Extension_B' = 94, 'CJK_Compatibility_Ideographs_Supplement' = 95, 'Tags' = 96, 'Cyrillic_Supplement' = 97, 'Tagalog' = 98, 'Hanunoo' = 99, 'Buhid' = 100, 'Tagbanwa' = 101, 'Miscellaneous_Mathematical_Symbols_A' = 102, 'Supplemental_Arrows_A' = 103, 'Supplemental_Arrows_B' = 104, 'Miscellaneous_Mathematical_Symbols_B' = 105, 'Supplemental_Mathematical_Operators' = 106, 'Katakana_Phonetic_Extensions' = 107, 'Variation_Selectors' = 108, 'Supplementary_Private_Use_Area_A' = 109, 'Supplementary_Private_Use_Area_B' = 110, 'Limbu' = 111, 'Tai_Le' = 112, 'Khmer_Symbols' = 113, 'Phonetic_Extensions' = 114, 'Miscellaneous_Symbols_And_Arrows' = 115, 'Yijing_Hexagram_Symbols' = 116, 'Linear_B_Syllabary' = 117, 'Linear_B_Ideograms' = 118, 'Aegean_Numbers' = 119, 'Ugaritic' = 120, 'Shavian' = 121, 'Osmanya' = 122, 'Cypriot_Syllabary' = 123, 'Tai_Xuan_Jing_Symbols' = 124, 'Variation_Selectors_Supplement' = 125, 'Ancient_Greek_Musical_Notation' = 126, 'Ancient_Greek_Numbers' = 127, 'Arabic_Supplement' = 128, 'Buginese' = 129, 'CJK_Strokes' = 130, 'Combining_Diacritical_Marks_Supplement' = 131, 'Coptic' = 132, 'Ethiopic_Extended' = 133, 'Ethiopic_Supplement' = 134, 'Georgian_Supplement' = 135, 'Glagolitic' = 136, 'Kharoshthi' = 137, 'Modifier_Tone_Letters' = 138, 'New_Tai_Lue' = 139, 'Old_Persian' = 140, 'Phonetic_Extensions_Supplement' = 141, 'Supplemental_Punctuation' = 142, 'Syloti_Nagri' = 143, 'Tifinagh' = 144, 'Vertical_Forms' = 145, 'NKo' = 146, 'Balinese' = 147, 'Latin_Extended_C' = 148, 'Latin_Extended_D' = 149, 'Phags_Pa' = 150, 'Phoenician' = 151, 'Cuneiform' = 152, 'Cuneiform_Numbers_And_Punctuation' = 153, 'Counting_Rod_Numerals' = 154, 'Sundanese' = 155, 'Lepcha' = 156, 'Ol_Chiki' = 157, 'Cyrillic_Extended_A' = 158, 'Vai' = 159, 'Cyrillic_Extended_B' = 160, 'Saurashtra' = 161, 'Kayah_Li' = 162, 'Rejang' = 163, 'Cham' = 164, 'Ancient_Symbols' = 165, 'Phaistos_Disc' = 166, 'Lycian' = 167, 'Carian' = 168, 'Lydian' = 169, 'Mahjong_Tiles' = 170, 'Domino_Tiles' = 171, 'Samaritan' = 172, 'Unified_Canadian_Aboriginal_Syllabics_Extended' = 173, 'Tai_Tham' = 174, 'Vedic_Extensions' = 175, 'Lisu' = 176, 'Bamum' = 177, 'Common_Indic_Number_Forms' = 178, 'Devanagari_Extended' = 179, 'Hangul_Jamo_Extended_A' = 180, 'Javanese' = 181, 'Myanmar_Extended_A' = 182, 'Tai_Viet' = 183, 'Meetei_Mayek' = 184, 'Hangul_Jamo_Extended_B' = 185, 'Imperial_Aramaic' = 186, 'Old_South_Arabian' = 187, 'Avestan' = 188, 'Inscriptional_Parthian' = 189, 'Inscriptional_Pahlavi' = 190, 'Old_Turkic' = 191, 'Rumi_Numeral_Symbols' = 192, 'Kaithi' = 193, 'Egyptian_Hieroglyphs' = 194, 'Enclosed_Alphanumeric_Supplement' = 195, 'Enclosed_Ideographic_Supplement' = 196, 'CJK_Unified_Ideographs_Extension_C' = 197, 'Mandaic' = 198, 'Batak' = 199, 'Ethiopic_Extended_A' = 200, 'Brahmi' = 201, 'Bamum_Supplement' = 202, 'Kana_Supplement' = 203, 'Playing_Cards' = 204, 'Miscellaneous_Symbols_And_Pictographs' = 205, 'Emoticons' = 206, 'Transport_And_Map_Symbols' = 207, 'Alchemical_Symbols' = 208, 'CJK_Unified_Ideographs_Extension_D' = 209, 'Arabic_Extended_A' = 210, 'Arabic_Mathematical_Alphabetic_Symbols' = 211, 'Chakma' = 212, 'Meetei_Mayek_Extensions' = 213, 'Meroitic_Cursive' = 214, 'Meroitic_Hieroglyphs' = 215, 'Miao' = 216, 'Sharada' = 217, 'Sora_Sompeng' = 218, 'Sundanese_Supplement' = 219, 'Takri' = 220, 'Bassa_Vah' = 221, 'Caucasian_Albanian' = 222, 'Coptic_Epact_Numbers' = 223, 'Combining_Diacritical_Marks_Extended' = 224, 'Duployan' = 225, 'Elbasan' = 226, 'Geometric_Shapes_Extended' = 227, 'Grantha' = 228, 'Khojki' = 229, 'Khudawadi' = 230, 'Latin_Extended_E' = 231, 'Linear_A' = 232, 'Mahajani' = 233, 'Manichaean' = 234, 'Mende_Kikakui' = 235, 'Modi' = 236, 'Mro' = 237, 'Myanmar_Extended_B' = 238, 'Nabataean' = 239, 'Old_North_Arabian' = 240, 'Old_Permic' = 241, 'Ornamental_Dingbats' = 242, 'Pahawh_Hmong' = 243, 'Palmyrene' = 244, 'Pau_Cin_Hau' = 245, 'Psalter_Pahlavi' = 246, 'Shorthand_Format_Controls' = 247, 'Siddham' = 248, 'Sinhala_Archaic_Numbers' = 249, 'Supplemental_Arrows_C' = 250, 'Tirhuta' = 251, 'Warang_Citi' = 252, 'Ahom' = 253, 'Anatolian_Hieroglyphs' = 254, 'Cherokee_Supplement' = 255, 'CJK_Unified_Ideographs_Extension_E' = 256, 'Early_Dynastic_Cuneiform' = 257, 'Hatran' = 258, 'Multani' = 259, 'Old_Hungarian' = 260, 'Supplemental_Symbols_And_Pictographs' = 261, 'Sutton_SignWriting' = 262, 'Adlam' = 263, 'Bhaiksuki' = 264, 'Cyrillic_Extended_C' = 265, 'Glagolitic_Supplement' = 266, 'Ideographic_Symbols_And_Punctuation' = 267, 'Marchen' = 268, 'Mongolian_Supplement' = 269, 'Newa' = 270, 'Osage' = 271, 'Tangut' = 272, 'Tangut_Components' = 273, 'CJK_Unified_Ideographs_Extension_F' = 274, 'Kana_Extended_A' = 275, 'Masaram_Gondi' = 276, 'Nushu' = 277, 'Soyombo' = 278, 'Syriac_Supplement' = 279, 'Zanabazar_Square' = 280, 'Chess_Symbols' = 281, 'Dogra' = 282, 'Georgian_Extended' = 283, 'Gunjala_Gondi' = 284, 'Hanifi_Rohingya' = 285, 'Indic_Siyaq_Numbers' = 286, 'Makasar' = 287, 'Mayan_Numerals' = 288, 'Medefaidrin' = 289, 'Old_Sogdian' = 290, 'Sogdian' = 291, 'Egyptian_Hieroglyph_Format_Controls' = 292, 'Elymaic' = 293, 'Nandinagari' = 294, 'Nyiakeng_Puachue_Hmong' = 295, 'Ottoman_Siyaq_Numbers' = 296, 'Small_Kana_Extension' = 297, 'Symbols_And_Pictographs_Extended_A' = 298, 'Tamil_Supplement' = 299, 'Wancho' = 300, 'Chorasmian' = 301, 'CJK_Unified_Ideographs_Extension_G' = 302, 'Dives_Akuru' = 303, 'Khitan_Small_Script' = 304, 'Lisu_Supplement' = 305, 'Symbols_For_Legacy_Computing' = 306, 'Tangut_Supplement' = 307, 'Yezidi' = 308, 'Arabic_Extended_B' = 309, 'Cypro_Minoan' = 310, 'Ethiopic_Extended_B' = 311, 'Kana_Extended_B' = 312, 'Latin_Extended_F' = 313, 'Latin_Extended_G' = 314, 'Old_Uyghur' = 315, 'Tangsa' = 316, 'Toto' = 317, 'Unified_Canadian_Aboriginal_Syllabics_Extended_A' = 318, 'Vithkuqi' = 319, 'Znamenny_Musical_Notation' = 320, 'Arabic_Extended_C' = 321, 'CJK_Unified_Ideographs_Extension_H' = 322, 'Cyrillic_Extended_D' = 323, 'Devanagari_Extended_A' = 324, 'Kaktovik_Numerals' = 325, 'Kawi' = 326, 'Nag_Mundari' = 327, 'CJK_Unified_Ideographs_Extension_I' = 328, 'Egyptian_Hieroglyphs_Extended_A' = 329, 'Garay' = 330, 'Gurung_Khema' = 331, 'Kirat_Rai' = 332, 'Myanmar_Extended_C' = 333, 'Ol_Onal' = 334, 'Sunuwar' = 335, 'Symbols_For_Legacy_Computing_Supplement' = 336, 'Todhri' = 337, 'Tulu_Tigalari' = 338, 'Beria_Erfe' = 339, 'CJK_Unified_Ideographs_Extension_J' = 340, 'Miscellaneous_Symbols_Supplement' = 341, 'Sharada_Supplement' = 342, 'Sidetic' = 343, 'Tai_Yo' = 344, 'Tangut_Components_Supplement' = 345, 'Tolong_Siki' = 346) | — |
canonical_combining_class | Enum16('Not_Reordered' = 0, 'Overlay' = 1, 'Han_Reading' = 6, 'Nukta' = 7, 'Kana_Voicing' = 8, 'Virama' = 9, 'CCC10' = 10, 'CCC11' = 11, 'CCC12' = 12, 'CCC13' = 13, 'CCC14' = 14, 'CCC15' = 15, 'CCC16' = 16, 'CCC17' = 17, 'CCC18' = 18, 'CCC19' = 19, 'CCC20' = 20, 'CCC21' = 21, 'CCC22' = 22, 'CCC23' = 23, 'CCC24' = 24, 'CCC25' = 25, 'CCC26' = 26, 'CCC27' = 27, 'CCC28' = 28, 'CCC29' = 29, 'CCC30' = 30, 'CCC31' = 31, 'CCC32' = 32, 'CCC33' = 33, 'CCC34' = 34, 'CCC35' = 35, 'CCC36' = 36, 'CCC84' = 84, 'CCC91' = 91, 'CCC103' = 103, 'CCC107' = 107, 'CCC118' = 118, 'CCC122' = 122, 'CCC129' = 129, 'CCC130' = 130, 'CCC132' = 132, 'CCC133' = 133, 'Attached_Below_Left' = 200, 'Attached_Below' = 202, 'Attached_Above' = 214, 'Attached_Above_Right' = 216, 'Below_Left' = 218, 'Below' = 220, 'Below_Right' = 222, 'Left' = 224, 'Right' = 226, 'Above_Left' = 228, 'Above' = 230, 'Above_Right' = 232, 'Double_Below' = 233, 'Double_Above' = 234, 'Iota_Subscript' = 240) | — |
decomposition_type | Enum8('None' = 0, 'Canonical' = 1, 'Compat' = 2, 'Circle' = 3, 'Final' = 4, 'Font' = 5, 'Fraction' = 6, 'Initial' = 7, 'Isolated' = 8, 'Medial' = 9, 'Narrow' = 10, 'Nobreak' = 11, 'Small' = 12, 'Square' = 13, 'Sub' = 14, 'Super' = 15, 'Vertical' = 16, 'Wide' = 17) | — |
east_asian_width | Enum8('Neutral' = 0, 'Ambiguous' = 1, 'Halfwidth' = 2, 'Fullwidth' = 3, 'Narrow' = 4, 'Wide' = 5) | — |
general_category | Enum8('Unassigned' = 0, 'Uppercase_Letter' = 1, 'Lowercase_Letter' = 2, 'Titlecase_Letter' = 3, 'Modifier_Letter' = 4, 'Other_Letter' = 5, 'Nonspacing_Mark' = 6, 'Enclosing_Mark' = 7, 'Spacing_Mark' = 8, 'Decimal_Number' = 9, 'Letter_Number' = 10, 'Other_Number' = 11, 'Space_Separator' = 12, 'Line_Separator' = 13, 'Paragraph_Separator' = 14, 'Control' = 15, 'Format' = 16, 'Private_Use' = 17, 'Surrogate' = 18, 'Dash_Punctuation' = 19, 'Open_Punctuation' = 20, 'Close_Punctuation' = 21, 'Connector_Punctuation' = 22, 'Other_Punctuation' = 23, 'Math_Symbol' = 24, 'Currency_Symbol' = 25, 'Modifier_Symbol' = 26, 'Other_Symbol' = 27, 'Initial_Punctuation' = 28, 'Final_Punctuation' = 29) | — |
joining_group | Enum8('No_Joining_Group' = 0, 'Ain' = 1, 'Alaph' = 2, 'Alef' = 3, 'Beh' = 4, 'Beth' = 5, 'Dal' = 6, 'Dalath_Rish' = 7, 'E' = 8, 'Feh' = 9, 'Final_Semkath' = 10, 'Gaf' = 11, 'Gamal' = 12, 'Hah' = 13, 'Teh_Marbuta_Goal' = 14, 'He' = 15, 'Heh' = 16, 'Heh_Goal' = 17, 'Heth' = 18, 'Kaf' = 19, 'Kaph' = 20, 'Knotted_Heh' = 21, 'Lam' = 22, 'Lamadh' = 23, 'Meem' = 24, 'Mim' = 25, 'Noon' = 26, 'Nun' = 27, 'Pe' = 28, 'Qaf' = 29, 'Qaph' = 30, 'Reh' = 31, 'Reversed_Pe' = 32, 'Sad' = 33, 'Sadhe' = 34, 'Seen' = 35, 'Semkath' = 36, 'Shin' = 37, 'Swash_Kaf' = 38, 'Syriac_Waw' = 39, 'Tah' = 40, 'Taw' = 41, 'Teh_Marbuta' = 42, 'Teth' = 43, 'Waw' = 44, 'Yeh' = 45, 'Yeh_Barree' = 46, 'Yeh_With_Tail' = 47, 'Yudh' = 48, 'Yudh_He' = 49, 'Zain' = 50, 'Fe' = 51, 'Khaph' = 52, 'Zhain' = 53, 'Burushaski_Yeh_Barree' = 54, 'Farsi_Yeh' = 55, 'Nya' = 56, 'Rohingya_Yeh' = 57, 'Manichaean_Aleph' = 58, 'Manichaean_Ayin' = 59, 'Manichaean_Beth' = 60, 'Manichaean_Daleth' = 61, 'Manichaean_Dhamedh' = 62, 'Manichaean_Five' = 63, 'Manichaean_Gimel' = 64, 'Manichaean_Heth' = 65, 'Manichaean_Hundred' = 66, 'Manichaean_Kaph' = 67, 'Manichaean_Lamedh' = 68, 'Manichaean_Mem' = 69, 'Manichaean_Nun' = 70, 'Manichaean_One' = 71, 'Manichaean_Pe' = 72, 'Manichaean_Qoph' = 73, 'Manichaean_Resh' = 74, 'Manichaean_Sadhe' = 75, 'Manichaean_Samekh' = 76, 'Manichaean_Taw' = 77, 'Manichaean_Ten' = 78, 'Manichaean_Teth' = 79, 'Manichaean_Thamedh' = 80, 'Manichaean_Twenty' = 81, 'Manichaean_Waw' = 82, 'Manichaean_Yodh' = 83, 'Manichaean_Zayin' = 84, 'Straight_Waw' = 85, 'African_Feh' = 86, 'African_Noon' = 87, 'African_Qaf' = 88, 'Malayalam_Bha' = 89, 'Malayalam_Ja' = 90, 'Malayalam_Lla' = 91, 'Malayalam_Llla' = 92, 'Malayalam_Nga' = 93, 'Malayalam_Nna' = 94, 'Malayalam_Nnna' = 95, 'Malayalam_Nya' = 96, 'Malayalam_Ra' = 97, 'Malayalam_Ssa' = 98, 'Malayalam_Tta' = 99, 'Hanifi_Rohingya_Kinna_Ya' = 100, 'Hanifi_Rohingya_Pa' = 101, 'Thin_Yeh' = 102, 'Vertical_Tail' = 103, 'Kashmiri_Yeh' = 104, 'Thin_Noon' = 105) | — |
joining_type | Enum8('Non_Joining' = 0, 'Join_Causing' = 1, 'Dual_Joining' = 2, 'Left_Joining' = 3, 'Right_Joining' = 4, 'Transparent' = 5) | — |
line_break | Enum8('Unknown' = 0, 'Ambiguous' = 1, 'Alphabetic' = 2, 'Break_Both' = 3, 'Break_After' = 4, 'Break_Before' = 5, 'Mandatory_Break' = 6, 'Contingent_Break' = 7, 'Close_Punctuation' = 8, 'Combining_Mark' = 9, 'Carriage_Return' = 10, 'Exclamation' = 11, 'Glue' = 12, 'Hyphen' = 13, 'Ideographic' = 14, 'Inseparable' = 15, 'Infix_Numeric' = 16, 'Line_Feed' = 17, 'Nonstarter' = 18, 'Numeric' = 19, 'Open_Punctuation' = 20, 'Postfix_Numeric' = 21, 'Prefix_Numeric' = 22, 'Quotation' = 23, 'Complex_Context' = 24, 'Surrogate' = 25, 'Space' = 26, 'Break_Symbols' = 27, 'ZWSpace' = 28, 'Next_Line' = 29, 'Word_Joiner' = 30, 'H2' = 31, 'H3' = 32, 'JL' = 33, 'JT' = 34, 'JV' = 35, 'Close_Parenthesis' = 36, 'Conditional_Japanese_Starter' = 37, 'Hebrew_Letter' = 38, 'Regional_Indicator' = 39, 'E_Base' = 40, 'E_Modifier' = 41, 'ZWJ' = 42, 'Aksara' = 43, 'Aksara_Prebase' = 44, 'Aksara_Start' = 45, 'Virama_Final' = 46, 'Virama' = 47, 'Unambiguous_Hyphen' = 48) | — |
numeric_type | Enum8('None' = 0, 'Decimal' = 1, 'Digit' = 2, 'Numeric' = 3) | — |
script | Enum16('Common' = 0, 'Inherited' = 1, 'Arabic' = 2, 'Armenian' = 3, 'Bengali' = 4, 'Bopomofo' = 5, 'Cherokee' = 6, 'Coptic' = 7, 'Cyrillic' = 8, 'Deseret' = 9, 'Devanagari' = 10, 'Ethiopic' = 11, 'Georgian' = 12, 'Gothic' = 13, 'Greek' = 14, 'Gujarati' = 15, 'Gurmukhi' = 16, 'Han' = 17, 'Hangul' = 18, 'Hebrew' = 19, 'Hiragana' = 20, 'Kannada' = 21, 'Katakana' = 22, 'Khmer' = 23, 'Lao' = 24, 'Latin' = 25, 'Malayalam' = 26, 'Mongolian' = 27, 'Myanmar' = 28, 'Ogham' = 29, 'Old_Italic' = 30, 'Oriya' = 31, 'Runic' = 32, 'Sinhala' = 33, 'Syriac' = 34, 'Tamil' = 35, 'Telugu' = 36, 'Thaana' = 37, 'Thai' = 38, 'Tibetan' = 39, 'Canadian_Aboriginal' = 40, 'Yi' = 41, 'Tagalog' = 42, 'Hanunoo' = 43, 'Buhid' = 44, 'Tagbanwa' = 45, 'Braille' = 46, 'Cypriot' = 47, 'Limbu' = 48, 'Linear_B' = 49, 'Osmanya' = 50, 'Shavian' = 51, 'Tai_Le' = 52, 'Ugaritic' = 53, 'Katakana_Or_Hiragana' = 54, 'Buginese' = 55, 'Glagolitic' = 56, 'Kharoshthi' = 57, 'Syloti_Nagri' = 58, 'New_Tai_Lue' = 59, 'Tifinagh' = 60, 'Old_Persian' = 61, 'Balinese' = 62, 'Batak' = 63, 'Blis' = 64, 'Brahmi' = 65, 'Cham' = 66, 'Cirt' = 67, 'Cyrs' = 68, 'Egyd' = 69, 'Egyh' = 70, 'Egyptian_Hieroglyphs' = 71, 'Geok' = 72, 'Hans' = 73, 'Hant' = 74, 'Pahawh_Hmong' = 75, 'Old_Hungarian' = 76, 'Inds' = 77, 'Javanese' = 78, 'Kayah_Li' = 79, 'Latf' = 80, 'Latg' = 81, 'Lepcha' = 82, 'Linear_A' = 83, 'Mandaic' = 84, 'Maya' = 85, 'Meroitic_Hieroglyphs' = 86, 'Nko' = 87, 'Old_Turkic' = 88, 'Old_Permic' = 89, 'Phags_Pa' = 90, 'Phoenician' = 91, 'Miao' = 92, 'Roro' = 93, 'Sara' = 94, 'Syre' = 95, 'Syrj' = 96, 'Syrn' = 97, 'Teng' = 98, 'Vai' = 99, 'Visp' = 100, 'Cuneiform' = 101, 'Zxxx' = 102, 'Unknown' = 103, 'Carian' = 104, 'Jpan' = 105, 'Tai_Tham' = 106, 'Lycian' = 107, 'Lydian' = 108, 'Ol_Chiki' = 109, 'Rejang' = 110, 'Saurashtra' = 111, 'SignWriting' = 112, 'Sundanese' = 113, 'Moon' = 114, 'Meetei_Mayek' = 115, 'Imperial_Aramaic' = 116, 'Avestan' = 117, 'Chakma' = 118, 'Kore' = 119, 'Kaithi' = 120, 'Manichaean' = 121, 'Inscriptional_Pahlavi' = 122, 'Psalter_Pahlavi' = 123, 'Phlv' = 124, 'Inscriptional_Parthian' = 125, 'Samaritan' = 126, 'Tai_Viet' = 127, 'Zmth' = 128, 'Zsym' = 129, 'Bamum' = 130, 'Lisu' = 131, 'Nkgb' = 132, 'Old_South_Arabian' = 133, 'Bassa_Vah' = 134, 'Duployan' = 135, 'Elbasan' = 136, 'Grantha' = 137, 'Kpel' = 138, 'Loma' = 139, 'Mende_Kikakui' = 140, 'Meroitic_Cursive' = 141, 'Old_North_Arabian' = 142, 'Nabataean' = 143, 'Palmyrene' = 144, 'Khudawadi' = 145, 'Warang_Citi' = 146, 'Afak' = 147, 'Jurc' = 148, 'Mro' = 149, 'Nushu' = 150, 'Sharada' = 151, 'Sora_Sompeng' = 152, 'Takri' = 153, 'Tangut' = 154, 'Wole' = 155, 'Anatolian_Hieroglyphs' = 156, 'Khojki' = 157, 'Tirhuta' = 158, 'Caucasian_Albanian' = 159, 'Mahajani' = 160, 'Ahom' = 161, 'Hatran' = 162, 'Modi' = 163, 'Multani' = 164, 'Pau_Cin_Hau' = 165, 'Siddham' = 166, 'Adlam' = 167, 'Bhaiksuki' = 168, 'Marchen' = 169, 'Newa' = 170, 'Osage' = 171, 'Hanb' = 172, 'Jamo' = 173, 'Zsye' = 174, 'Masaram_Gondi' = 175, 'Soyombo' = 176, 'Zanabazar_Square' = 177, 'Dogra' = 178, 'Gunjala_Gondi' = 179, 'Makasar' = 180, 'Medefaidrin' = 181, 'Hanifi_Rohingya' = 182, 'Sogdian' = 183, 'Old_Sogdian' = 184, 'Elymaic' = 185, 'Nyiakeng_Puachue_Hmong' = 186, 'Nandinagari' = 187, 'Wancho' = 188, 'Chorasmian' = 189, 'Dives_Akuru' = 190, 'Khitan_Small_Script' = 191, 'Yezidi' = 192, 'Cypro_Minoan' = 193, 'Old_Uyghur' = 194, 'Tangsa' = 195, 'Toto' = 196, 'Vithkuqi' = 197, 'Kawi' = 198, 'Nag_Mundari' = 199, 'Aran' = 200, 'Garay' = 201, 'Gurung_Khema' = 202, 'Kirat_Rai' = 203, 'Ol_Onal' = 204, 'Sunuwar' = 205, 'Todhri' = 206, 'Tulu_Tigalari' = 207, 'Beria_Erfe' = 208, 'Sidetic' = 209, 'Tai_Yo' = 210, 'Tolong_Siki' = 211, 'Hntl' = 212) | — |
hangul_syllable_type | Enum8('Not_Applicable' = 0, 'Leading_Jamo' = 1, 'Vowel_Jamo' = 2, 'Trailing_Jamo' = 3, 'LV_Syllable' = 4, 'LVT_Syllable' = 5) | — |
nfd_quick_check | Enum8('No' = 0, 'Yes' = 1) | — |
nfkd_quick_check | Enum8('No' = 0, 'Yes' = 1) | — |
nfc_quick_check | Enum8('No' = 0, 'Yes' = 1, 'Maybe' = 2) | — |
nfkc_quick_check | Enum8('No' = 0, 'Yes' = 1, 'Maybe' = 2) | — |
lead_canonical_combining_class | Enum16('Not_Reordered' = 0, 'Overlay' = 1, 'Han_Reading' = 6, 'Nukta' = 7, 'Kana_Voicing' = 8, 'Virama' = 9, 'CCC10' = 10, 'CCC11' = 11, 'CCC12' = 12, 'CCC13' = 13, 'CCC14' = 14, 'CCC15' = 15, 'CCC16' = 16, 'CCC17' = 17, 'CCC18' = 18, 'CCC19' = 19, 'CCC20' = 20, 'CCC21' = 21, 'CCC22' = 22, 'CCC23' = 23, 'CCC24' = 24, 'CCC25' = 25, 'CCC26' = 26, 'CCC27' = 27, 'CCC28' = 28, 'CCC29' = 29, 'CCC30' = 30, 'CCC31' = 31, 'CCC32' = 32, 'CCC33' = 33, 'CCC34' = 34, 'CCC35' = 35, 'CCC36' = 36, 'CCC84' = 84, 'CCC91' = 91, 'CCC103' = 103, 'CCC107' = 107, 'CCC118' = 118, 'CCC122' = 122, 'CCC129' = 129, 'CCC130' = 130, 'CCC132' = 132, 'CCC133' = 133, 'Attached_Below_Left' = 200, 'Attached_Below' = 202, 'Attached_Above' = 214, 'Attached_Above_Right' = 216, 'Below_Left' = 218, 'Below' = 220, 'Below_Right' = 222, 'Left' = 224, 'Right' = 226, 'Above_Left' = 228, 'Above' = 230, 'Above_Right' = 232, 'Double_Below' = 233, 'Double_Above' = 234, 'Iota_Subscript' = 240) | — |
trail_canonical_combining_class | Enum16('Not_Reordered' = 0, 'Overlay' = 1, 'Han_Reading' = 6, 'Nukta' = 7, 'Kana_Voicing' = 8, 'Virama' = 9, 'CCC10' = 10, 'CCC11' = 11, 'CCC12' = 12, 'CCC13' = 13, 'CCC14' = 14, 'CCC15' = 15, 'CCC16' = 16, 'CCC17' = 17, 'CCC18' = 18, 'CCC19' = 19, 'CCC20' = 20, 'CCC21' = 21, 'CCC22' = 22, 'CCC23' = 23, 'CCC24' = 24, 'CCC25' = 25, 'CCC26' = 26, 'CCC27' = 27, 'CCC28' = 28, 'CCC29' = 29, 'CCC30' = 30, 'CCC31' = 31, 'CCC32' = 32, 'CCC33' = 33, 'CCC34' = 34, 'CCC35' = 35, 'CCC36' = 36, 'CCC84' = 84, 'CCC91' = 91, 'CCC103' = 103, 'CCC107' = 107, 'CCC118' = 118, 'CCC122' = 122, 'CCC129' = 129, 'CCC130' = 130, 'CCC132' = 132, 'CCC133' = 133, 'Attached_Below_Left' = 200, 'Attached_Below' = 202, 'Attached_Above' = 214, 'Attached_Above_Right' = 216, 'Below_Left' = 218, 'Below' = 220, 'Below_Right' = 222, 'Left' = 224, 'Right' = 226, 'Above_Left' = 228, 'Above' = 230, 'Above_Right' = 232, 'Double_Below' = 233, 'Double_Above' = 234, 'Iota_Subscript' = 240) | — |
grapheme_cluster_break | Enum8('Other' = 0, 'Control' = 1, 'CR' = 2, 'Extend' = 3, 'L' = 4, 'LF' = 5, 'LV' = 6, 'LVT' = 7, 'T' = 8, 'V' = 9, 'SpacingMark' = 10, 'Prepend' = 11, 'Regional_Indicator' = 12, 'E_Base' = 13, 'E_Base_GAZ' = 14, 'E_Modifier' = 15, 'Glue_After_Zwj' = 16, 'ZWJ' = 17) | — |
sentence_break | Enum8('Other' = 0, 'ATerm' = 1, 'Close' = 2, 'Format' = 3, 'Lower' = 4, 'Numeric' = 5, 'OLetter' = 6, 'Sep' = 7, 'Sp' = 8, 'STerm' = 9, 'Upper' = 10, 'CR' = 11, 'Extend' = 12, 'LF' = 13, 'SContinue' = 14) | — |
word_break | Enum8('Other' = 0, 'ALetter' = 1, 'Format' = 2, 'Katakana' = 3, 'MidLetter' = 4, 'MidNum' = 5, 'Numeric' = 6, 'ExtendNumLet' = 7, 'CR' = 8, 'Extend' = 9, 'LF' = 10, 'MidNumLet' = 11, 'Newline' = 12, 'Regional_Indicator' = 13, 'Hebrew_Letter' = 14, 'Single_Quote' = 15, 'Double_Quote' = 16, 'E_Base' = 17, 'E_Base_GAZ' = 18, 'E_Modifier' = 19, 'Glue_After_Zwj' = 20, 'ZWJ' = 21, 'WSegSpace' = 22) | — |
bidi_paired_bracket_type | Enum8('None' = 0, 'Open' = 1, 'Close' = 2) | — |
indic_positional_category | Enum8('Not_Applicable' = 0, 'Bottom' = 1, 'Bottom_And_Left' = 2, 'Bottom_And_Right' = 3, 'Left' = 4, 'Left_And_Right' = 5, 'Overstruck' = 6, 'Right' = 7, 'Top' = 8, 'Top_And_Bottom' = 9, 'Top_And_Bottom_And_Right' = 10, 'Top_And_Left' = 11, 'Top_And_Left_And_Right' = 12, 'Top_And_Right' = 13, 'Visual_Order_Left' = 14, 'Top_And_Bottom_And_Left' = 15) | — |
indic_syllabic_category | Enum8('Other' = 0, 'Avagraha' = 1, 'Bindu' = 2, 'Brahmi_Joining_Number' = 3, 'Cantillation_Mark' = 4, 'Consonant' = 5, 'Consonant_Dead' = 6, 'Consonant_Final' = 7, 'Consonant_Head_Letter' = 8, 'Consonant_Initial_Postfixed' = 9, 'Consonant_Killer' = 10, 'Consonant_Medial' = 11, 'Consonant_Placeholder' = 12, 'Consonant_Preceding_Repha' = 13, 'Consonant_Prefixed' = 14, 'Consonant_Subjoined' = 15, 'Consonant_Succeeding_Repha' = 16, 'Consonant_With_Stacker' = 17, 'Gemination_Mark' = 18, 'Invisible_Stacker' = 19, 'Joiner' = 20, 'Modifying_Letter' = 21, 'Non_Joiner' = 22, 'Nukta' = 23, 'Number' = 24, 'Number_Joiner' = 25, 'Pure_Killer' = 26, 'Register_Shifter' = 27, 'Syllable_Modifier' = 28, 'Tone_Letter' = 29, 'Tone_Mark' = 30, 'Virama' = 31, 'Visarga' = 32, 'Vowel' = 33, 'Vowel_Dependent' = 34, 'Vowel_Independent' = 35, 'Reordering_Killer' = 36) | — |
vertical_orientation | Enum8('Rotated' = 0, 'Transformed_Rotated' = 1, 'Transformed_Upright' = 2, 'Upright' = 3) | — |
identifier_status | Enum8('Restricted' = 0, 'Allowed' = 1) | — |
general_category_mask | Int32 | — |
numeric_value | Float64 | — |
age | String | — |
bidi_mirroring_glyph | String | — |
case_folding | String | — |
lowercase_mapping | String | — |
name | String | — |
simple_case_folding | String | — |
simple_lowercase_mapping | String | — |
simple_titlecase_mapping | String | — |
simple_uppercase_mapping | String | — |
titlecase_mapping | String | — |
uppercase_mapping | String | — |
bidi_paired_bracket | String | — |
script_extensions | Array(LowCardinality(String)) | — |
identifier_type | Array(LowCardinality(String)) | — |
user_defined_functions
Shows all user-defined executable functions with their metadata, configuration, and loading status.
| Column | Type | Comment |
|---|---|---|
name | String | UDF name. |
load_status | Enum8('Success' = 0, 'Failed' = 1) | Loading status. Possible values: Success — UDF loaded and ready to use, Failed — UDF failed to load (see field 'loading_error_message' for details). |
loading_error_message | String | Detailed error message when loading failed. Empty if loaded successfully. |
last_successful_update_time | Nullable(DateTime) | Timestamp of the last successful update. NULL if never succeeded. |
loading_duration_ms | UInt64 | Time spent loading the UDF, in milliseconds. |
type | Enum8('executable' = 0, 'executable_pool' = 1) | UDF type: 'executable' (single process) or 'executable_pool' (process pool). |
command | String | Script or command to execute for this UDF. |
format | String | Data format for I/O (e.g., 'TabSeparated', 'JSONEachRow'). |
return_type | String | Function return type (e.g., 'String', 'UInt64'). |
return_name | String | Optional return value identifier. Empty if not configured. |
argument_types | Array(String) | Array of argument types (e.g., ['String', 'UInt64']). |
argument_names | Array(String) | Array of argument names. Empty strings for unnamed arguments. |
max_command_execution_time | UInt64 | Maximum seconds to process a data block. Only for 'executable_pool' type. |
command_termination_timeout | UInt64 | Seconds before sending SIGTERM to command process. |
command_read_timeout | UInt64 | Milliseconds for reading from command stdout. |
command_write_timeout | UInt64 | Milliseconds for writing to command stdin. |
pool_size | UInt64 | Number of command process instances. Only for 'executable_pool' type. |
send_chunk_header | UInt8 | Whether to send row count before each data chunk (boolean). |
execute_direct | UInt8 | Whether to execute command directly (1) or via /bin/bash (0). |
lifetime | UInt64 | Reload interval in seconds. 0 means reload is disabled. |
deterministic | UInt8 | Whether function returns the same result for the same arguments (boolean). |
user_directories
Contains the information about configured user directories - directories on the file system from which RawTree server is allowed to read user provided data.
| Column | Type | Comment |
|---|---|---|
name | String | The name of the directory. |
type | String | The type of the access storage e.g. users.xml or replicated or memory etc. |
params | String | JSON with the parameters of the access storage. |
precedence | UInt64 | The order in which this directory is declared in the config. The same order is used when RawTree tries to find a user or role. |
user_processes
This system table can be used to get overview of memory usage and ProfileEvents of users.
| Column | Type | Comment |
|---|---|---|
user | String | User name. |
memory_usage | Int64 | Sum of RAM used by all processes of the user. It might not include some types of dedicated memory. See the max_memory_usage setting. |
peak_memory_usage | Int64 | The peak of memory usage of the user. It can be reset when no queries are run for the user. |
ProfileEvents | Map(LowCardinality(String), UInt64) | Summary of ProfileEvents that measure different metrics for the user. The description of them could be found in the table system.events |
ProfileEvents.Names | Array(String) | — |
ProfileEvents.Values | Array(UInt64) | — |
user_query_log
Contains the query log records of the current user: rows of the query log table (system.query_log by default) whose initiating user is the current user. Unlike the query log table itself, it can be read without any grants. This is only supported when the query log is stored locally: if query_log.engine delegates reads to another server (for example, Distributed), reading throws an exception, because the per-user access check cannot be enforced across a ClickHouse-protocol server boundary; in that case set query_log.enable_user_query_log to 0.
| Column | Type | Comment |
|---|---|---|
hostname | String | Hostname of the server executing the query. |
type | Enum8('QueryStart' = 1, 'QueryFinish' = 2, 'ExceptionBeforeStart' = 3, 'ExceptionWhileProcessing' = 4) | Type of an event that occurred when executing the query. Values: QueryStart — successful start of query execution, QueryFinish — successful end of query execution, ExceptionBeforeStart — exception before the start of query execution, ExceptionWhileProcessing — exception during the query execution. |
event_date | Date | Query starting date. |
event_time | DateTime | Query starting time. |
event_time_microseconds | DateTime64(6) | Query starting time with microseconds precision. |
query_start_time | DateTime | Start time of query execution. |
query_start_time_microseconds | DateTime64(6) | Start time of query execution with microsecond precision. |
query_duration_ms | UInt64 | Duration of query execution in milliseconds. |
read_rows | UInt64 | Total number of rows read from all tables and table functions participated in query. It includes usual subqueries, subqueries for IN and JOIN. For distributed queries read_rows includes the total number of rows read at all replicas. Each replica sends it's read_rows value, and the server-initiator of the query summarizes all received and local values. The cache volumes do not affect this value. |
read_bytes | UInt64 | Total number of bytes read from all tables and table functions participated in query. It includes usual subqueries, subqueries for IN and JOIN. For distributed queries read_bytes includes the total number of rows read at all replicas. Each replica sends it's read_bytes value, and the server-initiator of the query summarizes all received and local values. The cache volumes do not affect this value. |
written_rows | UInt64 | The number of rows written by the query, including any rows written by downstream inserts triggered by the pipeline, such as attached materialized views. For a synchronous insert these downstream rows are recorded on the query_kind = Insert entry; for an asynchronous insert they are recorded on the query_kind = AsyncInsertFlush entry, while the client-facing Insert entry records only the rows accepted from the client. For queries that do not write rows, it is 0. |
written_bytes | UInt64 | The number of bytes written by the query (uncompressed), including any bytes written by downstream inserts triggered by the pipeline, such as attached materialized views. For a synchronous insert these downstream bytes are recorded on the query_kind = Insert entry; for an asynchronous insert they are recorded on the query_kind = AsyncInsertFlush entry, while the client-facing Insert entry records only the bytes accepted from the client. For queries that do not write data, it is 0. |
result_rows | UInt64 | Number of rows in the result of a SELECT query, or the number of rows written by an insert. For a synchronous insert this includes rows written by downstream inserts triggered by the pipeline (such as attached materialized views) on the query_kind = Insert entry; for an asynchronous insert those downstream rows are recorded on the query_kind = AsyncInsertFlush entry, while the client-facing Insert entry records only the rows accepted from the client. |
result_bytes | UInt64 | RAM volume in bytes used to store a query result. |
memory_usage | UInt64 | Memory consumption by the query. |
current_database | String | Name of the current database. |
query | String | Query string. |
formatted_query | String | Formatted query string. |
normalized_query_hash | UInt64 | A numeric hash value, such as it is identical for queries differ only by values of literals. |
query_kind | String | Type of the query. |
databases | Array(String) | Names of the databases present in the query. |
tables | Array(String) | Names of the tables present in the query. |
columns | Array(String) | Names of the columns present in the query. |
partitions | Array(String) | Names of the partitions present in the query. |
projections | Array(String) | Names of the projections used during the query execution. |
views | Array(String) | Names of the (materialized or live) views present in the query. |
hints | Array(String) | Hints about query execution |
exception_code | Int32 | Code of an exception. |
exception | String | Exception message. |
stack_trace | String | Stack trace. An empty string, if the query was completed successfully. |
is_initial_query | UInt8 | Whether the query is initial. Possible values: 1 — an initial (top-level) query, 0 — a child query initiated by another query, including queries for distributed execution and internal subqueries. |
connection_address | IPv6 | The client IP address from which the connection was made. When connected through a proxy, this will be the address of the proxy. |
connection_port | UInt16 | The client port from which the connection was made. When connected through a proxy, this will be the port of the proxy. |
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. When connected through a proxy and auth_use_forwarded_address is set, this will be the address of the client instead of the proxy. |
port | UInt16 | The client port that was used to make the query. When connected through a proxy and auth_use_forwarded_address is set, this will be the port of the client instead of the proxy. |
initial_user | String | Name of the user who ran the initial query in the same query chain. |
initial_query_id | String | ID of the initial query in the same query chain. |
initial_address | IPv6 | IP address from which the initial query in the same query chain was launched. |
initial_port | UInt16 | Client port from which the initial query in the same query chain was launched. |
initial_query_start_time | DateTime | Start time of the initial query in the same query chain. |
initial_query_start_time_microseconds | DateTime64(6) | Start time of the initial query in the same query chain, with microsecond precision. |
authenticated_user | String | Name of the user who was authenticated in the session. |
interface | UInt8 | Interface that the query was initiated from. Possible values: 1 — TCP, 2 — HTTP. |
is_secure | UInt8 | The flag whether a query was executed over a secure interface |
os_user | String | Operating system username who runs rawtree-client. |
client_hostname | String | Hostname of the client machine where the rawtree-client or another TCP client is run. |
client_name | String | The rawtree-client or another TCP client name. |
client_agent | String | The AI coding agent that invoked the client (e.g. claude-code, cursor), detected from environment variables. Empty if no agent was detected. |
client_revision | UInt32 | Revision of the rawtree-client or another TCP client. |
client_version_major | UInt32 | Major version of the rawtree-client or another TCP client. |
client_version_minor | UInt32 | Minor version of the rawtree-client or another TCP client. |
client_version_patch | UInt32 | Patch component of the rawtree-client or another TCP client version. |
script_query_number | UInt32 | The query number in a script with multiple queries for rawtree-client. |
script_line_number | UInt32 | The line number of the query start in a script with multiple queries for rawtree-client. |
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, 4 - PUT method was used, 5 - DELETE method was used, 6 - HEAD method was used. |
http_user_agent | String | HTTP header UserAgent passed in the HTTP query. |
http_referer | String | HTTP header Referer passed in the HTTP query (contains an absolute or partial address of the page making the query). |
forwarded_for | String | HTTP header X-Forwarded-For passed in the HTTP query. |
quota_key | String | The quota key specified in the quotas setting (see keyed). |
distributed_depth | UInt64 | How many times a query was forwarded between servers. |
revision | UInt32 | RawTree revision. |
http_handler_name | String | Name of the SQL-defined HTTP handler (CREATE HANDLER) that invoked the query. Empty if the query was not invoked through such a handler. |
http_request_url | String | The HTTP request path (without the query string) that invoked the query. The query string is omitted so that sensitive request parameters are not persisted. Empty for non-HTTP queries. |
log_comment | String | Log comment. It can be set to arbitrary string no longer than max_query_size. An empty string if it is not defined. |
thread_ids | Array(UInt64) | Thread ids that are participating in query execution. These threads may not have run simultaneously. |
peak_threads_usage | UInt64 | Maximum count of simultaneous threads executing the query. |
ProfileEvents | Map(String, UInt64) | ProfileEvents that measure different metrics. The description of them could be found in the table system.events |
Settings | Map(String, String) | Settings that were changed when the client ran the query. To enable logging changes to settings, set the log_query_settings parameter to 1. |
used_aggregate_functions | Array(String) | Canonical names of aggregate functions, which were used during query execution. |
used_aggregate_function_combinators | Array(String) | Canonical names of aggregate functions combinators, which were used during query execution. |
used_database_engines | Array(String) | Canonical names of database engines, which were used during query execution. |
used_data_type_families | Array(String) | Canonical names of data type families, which were used during query execution. |
used_dictionaries | Array(String) | Canonical names of dictionaries, which were used during query execution. |
used_formats | Array(String) | Canonical names of formats, which were used during query execution. |
used_functions | Array(String) | Canonical names of functions, which were used during query execution. |
used_storages | Array(String) | Canonical names of storages, which were used during query execution. |
used_table_functions | Array(String) | Canonical names of table functions, which were used during query execution. |
used_executable_user_defined_functions | Array(String) | Canonical names of executable user defined functions, which were used during query execution. |
used_sql_user_defined_functions | Array(String) | Canonical names of sql user defined functions, which were used during query execution. |
used_row_policies | Array(String) | The list of row policies names that were used during query execution. |
used_privileges | Array(String) | Privileges which were successfully checked during query execution. |
missing_privileges | Array(String) | Privileges that are missing during query execution. |
transaction_id | Tuple(UInt64, UInt64, UUID) | The identifier of the transaction in scope of which this query was executed. |
query_cache_usage | Enum8('Unknown' = 0, 'None' = 1, 'Write' = 2, 'Read' = 3) | Usage of the query cache during query execution. Values: 'Unknown' = Status unknown, 'None' = The query result was neither written into nor read from the query result cache, 'Write' = The query result was written into the query result cache, 'Read' = The query result was read from the query result cache. |
asynchronous_read_counters | Map(String, UInt64) | Metrics for asynchronous reading. |
is_internal | UInt8 | Indicates whether it is an auxiliary query executed internally. |
ProfileEvents.Names | Array(String) | — |
ProfileEvents.Values | Array(UInt64) | — |
Settings.Names | Array(String) | — |
Settings.Values | Array(String) | — |
users
Contains a list of all users profiles either configured at the server through a configuration file or created via SQL.
| Column | Type | Comment |
|---|---|---|
name | String | User name. |
id | UUID | User ID. |
storage | String | Path to the storage of users. Configured in the access_control_path parameter. |
auth_type | Array(Enum8('no_password' = 0, 'plaintext_password' = 1, 'sha256_password' = 2, 'double_sha1_password' = 3, 'ldap' = 4, 'kerberos' = 5, 'ssl_certificate' = 6, 'bcrypt_password' = 7, 'ssh_key' = 8, 'http' = 9, 'jwt' = 10, 'scram_sha256_password' = 11, 'no_authentication' = 12)) | Shows the authentication types. There are multiple ways of user identification: with no password, with plain text password, with SHA256-encoded password, with double SHA-1-encoded password or with bcrypt-encoded password. |
auth_params | Array(String) | Authentication parameters in the JSON format depending on the auth_type. |
valid_until | Array(DateTime64(0)) | The expiration date and time for user credentials, one per authentication method. The stored value is an absolute instant rendered in the server or session time zone; the stored value 0 (the Unix epoch, rendered as 1970-01-01 00:00:00 on a server in UTC) is the sentinel meaning the credentials never expire. |
host_ip | Array(String) | IP addresses of hosts that are allowed to connect to the RawTree server. |
host_names | Array(String) | Names of hosts that are allowed to connect to the RawTree server. |
host_names_regexp | Array(String) | Regular expression for host names that are allowed to connect to the RawTree server. |
host_names_like | Array(String) | Names of hosts that are allowed to connect to the RawTree server, set using the LIKE predicate. |
default_roles_all | UInt8 | Shows that all granted roles set for user by default. |
default_roles_list | Array(String) | List of granted roles provided by default. |
default_roles_except | Array(String) | All the granted roles set as default excepting of the listed ones. |
grantees_any | UInt8 | The flag that indicates whether a user with any grant option can grant it to anyone. |
grantees_list | Array(String) | The list of users or roles to which this user is allowed to grant options to. |
grantees_except | Array(String) | The list of users or roles to which this user is forbidden from grant options to. |
default_database | String | The name of the default database for this user. |
view_refreshes
Lists all Refreshable Materialized Views of current server.
| Column | Type | Comment |
|---|---|---|
database | String | The name of the database the table is in. |
view | String | Table name. |
uuid | UUID | Table uuid (Atomic database). |
status | String | Current state of the refresh. |
last_success_time | Nullable(DateTime) | Time when the latest successful refresh started. NULL if no successful refreshes happened since server startup or table creation. |
last_success_duration_ms | Nullable(UInt64) | How long the latest refresh took. |
last_refresh_time | Nullable(DateTime) | Time when the latest refresh attempt finished (if known) or started (if unknown or still running). NULL if no refresh attempts happened since server startup or table creation. |
last_refresh_replica | String | If coordination is enabled, name of the replica that made the current (if running) or previous (if not running) refresh attempt. |
next_refresh_time | Nullable(DateTime) | Time at which the next refresh is scheduled to start. NULL if the next refresh time is not currently known, e.g. when waiting for dependencies (status WaitingForDependencies or MissingDependencies). |
exception | String | Error message from previous attempt if it failed. |
retry | UInt64 | How many failed attempts there were so far, for the current refresh. Not available if status is RunningOnAnotherReplica. |
progress | Nullable(Float64) | Progress of the current running or most recently completed refresh at the given replica, between 0 and 1. NULL if status is RunningOnAnotherReplica or the refresh is not running. |
read_rows | Nullable(UInt64) | Number of rows read by the current running or most recently completed refresh at the given replica. NULL if status is RunningOnAnotherReplica. |
read_bytes | Nullable(UInt64) | Number of bytes read by the current running or most recently completed refresh at the given replica. NULL if status is RunningOnAnotherReplica |
total_rows | Nullable(UInt64) | Estimated total number of rows that need to be read by the current running or most recently completed refresh at the given replica. NULL if status is RunningOnAnotherReplica |
written_rows | Nullable(UInt64) | Number of rows written by the current running or most recently completed refresh at the given replica. NULL if status is RunningOnAnotherReplica |
written_bytes | Nullable(UInt64) | Number of bytes written by the current running or most recently completed refresh at the given replica. NULL if status is RunningOnAnotherReplica |
failed_refreshes | UInt64 | Number of the latest consecutive refreshes which failed (all their attempts). Queries with CACHE fail when it reaches query_cache_views_max_failed_refreshes. |
reads | UInt64 | Number of queries which read the view on this replica since server startup. |
last_read_time | Nullable(DateTime) | Time of the latest read of the view: on this replica, and with TTL ... FROM LAST READ in a Replicated database on the other replicas as of the latest check of TTL. NULL if no reads were noted since server startup. |
ttl_seconds | UInt64 | TTL of the REFRESH clause in seconds, the longest length for months and years: the view is dropped instead of a refresh on schedule when this time passed since it was created, or with FROM LAST READ since it was read last. 0 without TTL. |
ttl_from_last_read | UInt8 | Whether TTL of the REFRESH clause is FROM LAST READ. |
warnings
Contains warnings about server configuration to be displayed by rawtree-client right after it connects to the server.
| Column | Type | Comment |
|---|---|---|
message | String | A warning message issued by RawTree server. |
message_format_string | LowCardinality(String) | A format string that was used to format the message. |
workloads
Contains a list of all currently existing workloads.
| Column | Type | Comment |
|---|---|---|
name | String | The name of the workload. |
parent | String | The name of the parent workload. |
create_query | String | CREATE query of the workload. |
zeros
Produces unlimited number of non-materialized zeros.
| Column | Type | Comment |
|---|---|---|
zero | UInt8 | dummy |
zeros_mt
Multithreaded version of system.zeros.
| Column | Type | Comment |
|---|---|---|
zero | UInt8 | dummy |