Skip to content

add show config statement (#2863) #2923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 17, 2020
Merged

add show config statement (#2863) #2923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a6cc53
cherry pick #2863 to release-4.0
jackysp Jun 17, 2020
f9a0ded
Merge branch 'release-4.0' into release-4.0-1d8301969913
ran-huang Jun 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions TOC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@
+ [`SHOW CHARACTER SET`](/sql-statements/sql-statement-show-character-set.md)
+ [`SHOW COLLATION`](/sql-statements/sql-statement-show-collation.md)
+ [`SHOW [FULL] COLUMNS FROM`](/sql-statements/sql-statement-show-columns-from.md)
+ [`SHOW CONFIG`](/sql-statements/sql-statement-show-config.md)
+ [`SHOW CREATE SEQUENCE`](/sql-statements/sql-statement-show-create-sequence.md)
+ [`SHOW CREATE TABLE`](/sql-statements/sql-statement-show-create-table.md)
+ [`SHOW CREATE USER`](/sql-statements/sql-statement-show-create-user.md)
Expand Down
90 changes: 90 additions & 0 deletions sql-statements/sql-statement-show-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
title: SHOW CONFIG
summary: Overview of the use of SHOW CONFIG in the TiDB database
category: reference
---

# SHOW CONFIG

> **Warning:**
>
> This feature is currently an experimental feature. It is not recommended to use this feature in the production environment.

The `SHOW CONFIG` statement is used to show the current configuration of various components of TiDB. Note that the configuration and system variables act on different dimensions and should not be mixed up. If you want to obtain the system variable information, use the [SHOW VARIABLES](/sql-statements/sql-statement-show-variables.md) syntax.

## Synopsis

**ShowStmt:**

![ShowStmt](/media/sqlgram/ShowStmt.png)

**ShowTargetFilterable:**

![ShowTargetFilterable](/media/sqlgram/ShowTargetFilterable.png)

## Examples

Show all configurations:

{{< copyable "sql" >}}

```sql
SHOW CONFIG;
```

```
+------+----------------+-------------------------------------------------+---------------------------------------------------------------------+
| Type | Instance | Name | Value |
+------+----------------+-------------------------------------------------+---------------------------------------------------------------------+
| tidb | 127.0.0.1:4000 | advertise-address | 127.0.0.1 |
| tidb | 127.0.0.1:4000 | alter-primary-key | false |
| tidb | 127.0.0.1:4000 | binlog.binlog-socket | |
| tidb | 127.0.0.1:4000 | binlog.enable | false |
...
120 rows in set (0.01 sec)
```

Show the configuration where the `type` is `tidb`:

{{< copyable "sql" >}}

```sql
SHOW CONFIG WHERE type = 'tidb' AND name = 'advertise-address';
```

```
+------+----------------+-------------------+-----------+
| Type | Instance | Name | Value |
+------+----------------+-------------------+-----------+
| tidb | 127.0.0.1:4000 | advertise-address | 127.0.0.1 |
+------+----------------+-------------------+-----------+
1 row in set (0.05 sec)
```

You can also use the `LIKE` clause to show the configuration where the `type` is `tidb`:

{{< copyable "sql" >}}

```sql
SHOW CONFIG LIKE 'tidb';
```

```
+------+----------------+-------------------------------------------------+---------------------------------------------------------------------+
| Type | Instance | Name | Value |
+------+----------------+-------------------------------------------------+---------------------------------------------------------------------+
| tidb | 127.0.0.1:4000 | advertise-address | 127.0.0.1 |
| tidb | 127.0.0.1:4000 | alter-primary-key | false |
| tidb | 127.0.0.1:4000 | binlog.binlog-socket | |
| tidb | 127.0.0.1:4000 | binlog.enable | false |
...
40 rows in set (0.01 sec)
```

## MySQL compatibility

`SHOW CONFIG` is the extended syntax of TiDB, with no counterpart in MySQL.

## See also

* [SHOW VARIABLES](/sql-statements/sql-statement-show-variables.md)