Skip to content

Commit 4f968f2

Browse files
authored
Update docs for deprecate-integer-display-length=true (#19159)
1 parent 9f72c57 commit 4f968f2

3 files changed

Lines changed: 34 additions & 1 deletion

File tree

data-type-numeric.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,22 @@ TiDB supports all the MySQL integer types, including `INTEGER`/`INT`, `TINYINT`,
1818

1919
The following table summarizes field descriptions:
2020

21+
<CustomContent platform="tidb">
22+
23+
> **Warning:**
24+
>
25+
> Starting from v8.5.0, integer display width is deprecated ([`deprecate-integer-display-length`](/tidb-configuration-file.md#deprecate-integer-display-length) is `true` by default). Specifying display width for integer types is NOT recommended.
26+
27+
</CustomContent>
28+
29+
<CustomContent platform="tidb-cloud">
30+
31+
> **Warning:**
32+
>
33+
> Starting from v8.5.0, integer display width is deprecated. Specifying display width for integer types is NOT recommended.
34+
35+
</CustomContent>
36+
2137
| Syntax Element | Description |
2238
| -------- | ------------------------------- |
2339
| M | the display width of the type. Optional. |

data-type-overview.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,22 @@ The definitions used for datatypes are specified as `T(M[, D])`. Where by:
1212

1313
- `T` indicates the specific data type.
1414
- `M` indicates the maximum display width for integer types. For floating-point and fixed-point types, `M` is the total number of digits that can be stored (the precision). For string types, `M` is the maximum length. The maximum permissible value of M depends on the data type.
15+
16+
<CustomContent platform="tidb">
17+
18+
> **Warning:**
19+
>
20+
> Starting from v8.5.0, integer display width is deprecated ([`deprecate-integer-display-length`](/tidb-configuration-file.md#deprecate-integer-display-length) is `true` by default). Specifying display width for integer types is NOT recommended.
21+
22+
</CustomContent>
23+
24+
<CustomContent platform="tidb-cloud">
25+
26+
> **Warning:**
27+
>
28+
> Starting from v8.5.0, integer display width is deprecated. Specifying display width for integer types is NOT recommended.
29+
30+
</CustomContent>
31+
1532
- `D` applies to floating-point and fixed-point types and indicates the number of digits following the decimal point (the scale).
1633
- `fsp` applies to the `TIME`, `DATETIME`, and `TIMESTAMP` types and represents the fractional seconds precision. The `fsp` value, if given, must be in the range 0 to 6. A value of 0 signifies that there is no fractional part. If omitted, the default precision is 0.

tidb-configuration-file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ The TiDB configuration file supports more options than command-line parameters.
183183
### `deprecate-integer-display-length`
184184

185185
- Deprecates the display width for integer types when this configuration item is set to `true`.
186-
- Default value: `false`
186+
- Default value: `true`. Before v8.5.0, the default value is `false`.
187187

188188
### `enable-tcp4-only` <span class="version-mark">New in v5.0</span>
189189

0 commit comments

Comments
 (0)