Skip to content

Latest commit

 

History

History
60 lines (48 loc) · 2.46 KB

information-schema-cluster-config.md

File metadata and controls

60 lines (48 loc) · 2.46 KB
Raw
title summary aliases
CLUSTER_CONFIG
Learn the `CLUSTER_CONFIG` information_schema table.
/docs/dev/system-tables/system-table-cluster-config/
/docs/dev/reference/system-databases/cluster-config/
/tidb/dev/system-table-cluster-config/

CLUSTER_CONFIG

You can use the CLUSTER_CONFIG cluster configuration table to get the current configuration of all server components in the cluster. This simplifies the usage over earlier releases of TiDB, where obtaining similar information would require accessing the HTTP API endpoints of each instance.

Note:

This table is only applicable to TiDB Self-Managed and not available on TiDB Cloud.

{{< copyable "sql" >}}

USE information_schema;
DESC cluster_config;
+----------+--------------+------+------+---------+-------+
| Field    | Type         | Null | Key  | Default | Extra |
+----------+--------------+------+------+---------+-------+
| TYPE     | varchar(64)  | YES  |      | NULL    |       |
| INSTANCE | varchar(64)  | YES  |      | NULL    |       |
| KEY      | varchar(256) | YES  |      | NULL    |       |
| VALUE    | varchar(128) | YES  |      | NULL    |       |
+----------+--------------+------+------+---------+-------+

Field description:

  • TYPE: The instance type. The optional values are tidb, pd, and tikv.
  • INSTANCE: The service address of the instance.
  • KEY: The configuration item name.
  • VALUE: The configuration item value.

The following example shows how to query the coprocessor configuration on the TiKV instance using the CLUSTER_CONFIG table:

{{< copyable "sql" >}}

SELECT * FROM cluster_config WHERE type='tikv' AND `key` LIKE 'coprocessor%';
+------+-----------------+-----------------------------------+---------+
| TYPE | INSTANCE        | KEY                               | VALUE   |
+------+-----------------+-----------------------------------+---------+
| tikv | 127.0.0.1:20165 | coprocessor.batch-split-limit     | 10      |
| tikv | 127.0.0.1:20165 | coprocessor.region-max-keys       | 3840000 |
| tikv | 127.0.0.1:20165 | coprocessor.region-max-size       | 384MiB  |
| tikv | 127.0.0.1:20165 | coprocessor.region-split-keys     | 2560000  |
| tikv | 127.0.0.1:20165 | coprocessor.region-split-size     | 256MiB   |
| tikv | 127.0.0.1:20165 | coprocessor.split-region-on-table | false   |
+------+-----------------+-----------------------------------+---------+
6 rows in set (0.00 sec)