Skip to content

Commit

Permalink
Document missing sysvars (#6485) (#6585)
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored Sep 30, 2021
1 parent 4b8cbd8 commit b317a7c
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 1 deletion.
4 changes: 4 additions & 0 deletions functions-and-operators/aggregate-group-by-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,3 +153,7 @@ group by id, val;
The following aggregate functions are currently unsupported in TiDB. You can track our progress in [TiDB #7623](https://github.com/pingcap/tidb/issues/7623):
- `JSON_ARRAYAGG`
## Related system variables
The `group_concat_max_len` variable sets the maximum number of items for the `GROUP_CONCAT()` function.
4 changes: 4 additions & 0 deletions functions-and-operators/date-and-time-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,7 @@ TiDB supports all of the [date and time functions](https://dev.mysql.com/doc/ref
| [`YEARWEEK()`](https://dev.mysql.com/doc/refman/5.7/en/date-and-time-functions.html#function_yearweek) | Return the year and week |

For details, see [Date and Time Functions](https://dev.mysql.com/doc/refman/5.7/en/date-and-time-functions.html).

## Related system variables

The `default_week_format` variable affects the `WEEK()` function.
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ TiDB supports most of the [encryption and compression functions](https://dev.mys
| [`ASYMMETRIC_SIGN()`](https://dev.mysql.com/doc/refman/5.7/en/enterprise-encryption-functions.html#function_asymmetric-sign) | Generate signature from digest |
| [`ASYMMETRIC_VERIFY()`](https://dev.mysql.com/doc/refman/5.7/en/enterprise-encryption-functions.html#function_asymmetric-verify) | Verify that signature matches digest |

## Related system variables

The `block_encryption_mode` variable sets the encryption mode that is used for `AES_ENCRYPT()` and `AES_DECRYPT()`.

## Unsupported functions

* `DES_DECRYPT()`, `DES_ENCRYPT()`, `OLD_PASSWORD()`, `ENCRYPT()`: these functions were deprecated in MySQL 5.7 and removed in 8.0.
Expand Down
77 changes: 76 additions & 1 deletion system-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ mysql> SELECT * FROM t1;
- Default value: `ON`
- Controls whether statements should automatically commit when not in an explicit transaction. See [Transaction Overview](/transaction-overview.md#autocommit) for more information.

### block_encryption_mode

- Scope: SESSION | GLOBAL
- Default value: `aes-128-ecb`
- Defines the encryption mode for the `AES_ENCRYPT()` and `AES_DECRYPT()` functions.

### character_set_client

- Scope: SESSION | GLOBAL
Expand Down Expand Up @@ -111,7 +117,25 @@ mysql> SELECT * FROM t1;

- Scope: SESSION | GLOBAL
- Default value: `utf8mb4`
- The character set used for new schemas when no character set is specified in the `CREATE SCHEMA` statement.
- The default character set for the server.

### collation_connection

- Scope: SESSION | GLOBAL
- Default value: `utf8mb4_bin`
- This variable indicates the collation for string literals that do not have a specified collation.

### collation_database

- Scope: SESSION | GLOBAL
- Default value: `utf8mb4_bin`
- This variable indicates the collation of the default database in use. **It is NOT recommended to set this variable**. When a new default database is selected, the server changes the variable value.

### collation_server

- Scope: SESSION | GLOBAL
- Default value: `utf8mb4_bin`
- The default collation for the server.

### cte_max_recursion_depth

Expand Down Expand Up @@ -141,12 +165,38 @@ mysql> SELECT * FROM t1;
- This variable sets the authentication method that the server advertises when the server-client connection is being established. Possible values for this variable are documented in [Authentication plugin status](/security-compatibility-with-mysql.md#authentication-plugin-status).
- Value options: `mysql_native_password` and `caching_sha2_password`. For more details, see [Authentication plugin status](/security-compatibility-with-mysql.md#authentication-plugin-status).

### default_week_format

- Scope: SESSION | GLOBAL
- Default value: `0`
- Range: `[0, 7]`
- Sets the week format used by the `WEEK()` function.

### foreign_key_checks

- Scope: SESSION | GLOBAL
- Default value: `OFF`
- For compatibility, TiDB returns foreign key checks as `OFF`.

### group_concat_max_len

- Scope: SESSION | GLOBAL
- Default value: `1024`
- Range: `[4, 18446744073709551615]`
- The maximum buffer size for items in the `GROUP_CONCAT()` function.

### have_openssl

- Scope: NONE
- Default value: `DISABLED`
- A read-only variable for MySQL compatibility. Set to `YES` by the server when the server has TLS enabled.

### have_ssl

- Scope: NONE
- Default value: `DISABLED`
- A read-only variable for MySQL compatibility. Set to `YES` by the server when the server has TLS enabled.

### hostname

- Scope: NONE
Expand Down Expand Up @@ -198,6 +248,13 @@ mysql> SELECT * FROM t1;
- Default value: `OFF`
- This variable indicates whether [TiDB Binlog](/tidb-binlog/tidb-binlog-overview.md) is used.

### max_allowed_packet

- Scope: GLOBAL | SESSION
- Default value: `67108864`
- Range: `[1024, 1073741824]`
- The maximum size of a packet for the MySQL protocol.

### max_execution_time

- Scope: SESSION | GLOBAL
Expand Down Expand Up @@ -275,6 +332,24 @@ mysql> SELECT * FROM t1;
- Range: `[0, 18446744073709551615]`
- The maximum number of rows returned by the `SELECT` statements.
### ssl_ca
- Scope: NONE
- Default value: ""
- The location of the certificate authority file (if there is one).
### ssl_cert
- Scope: NONE
- Default value: ""
- The location of the certificate file (if there is a file) that is used for SSL/TLS connections.
### ssl_key
- Scope: NONE
- Default value: ""
- The location of the private key file (if there is one) that is used for SSL/TLS connections.
### system_time_zone
- Scope: NONE
Expand Down

0 comments on commit b317a7c

Please sign in to comment.