Skip to content

[fix](doc) DESC-TABLE.md en: backport zh-only examples (Comment column, DESC ALL)#3832

Merged
morningman merged 1 commit into
apache:masterfrom
boluor:fix/desc-table-en-backport-zh-examples
May 30, 2026
Merged

[fix](doc) DESC-TABLE.md en: backport zh-only examples (Comment column, DESC ALL)#3832
morningman merged 1 commit into
apache:masterfrom
boluor:fix/desc-table-en-backport-zh-examples

Conversation

@boluor
Copy link
Copy Markdown
Contributor

@boluor boluor commented May 28, 2026

Summary

The ZH page for DESC-TABLE documents two examples that the EN page is missing:

  1. SET show_column_comment_in_describe = true + DESC test_table — surfaces the Comment column. The session variable was introduced in 3.0.7 and is already described in the EN Return-Value section (line 59), but the EN page never exemplifies it.
  2. DESC test_table ALL — returns the schema across all indexes, including IndexName, IndexKeysType, InternalType, Visible, DefineExpr, WhereClause.

Translated both blocks to English and added them under the existing example 1. The expected outputs were captured directly from a fresh Doris 4.1.1 cluster against the page's CREATE TABLE schema, so IndexKeysType = UNIQUE_KEYS to match UNIQUE KEY(user_id) (avoiding a stale DUP_KEYS value).

Verification

mysql> SET show_column_comment_in_describe=true;
mysql> DESC test_table;
+---------+-------------+------+-------+---------+-------+----------+
| Field   | Type        | Null | Key   | Default | Extra | Comment  |
+---------+-------------+------+-------+---------+-------+----------+
| user_id | bigint      | No   | true  | NULL    |       | Key1     |
| name    | varchar(20) | Yes  | false | NULL    | NONE  | username |
| age     | int         | Yes  | false | NULL    | NONE  | user_age |
+---------+-------------+------+-------+---------+-------+----------+

mysql> DESC test_table ALL;
+------------+---------------+---------+-------------+--------------+------+-------+---------+-------+---------+------------+-------------+
| IndexName  | IndexKeysType | Field   | Type        | InternalType | Null | Key   | Default | Extra | Visible | DefineExpr | WhereClause |
+------------+---------------+---------+-------------+--------------+------+-------+---------+-------+---------+------------+-------------+
| test_table | UNIQUE_KEYS   | user_id | bigint      | bigint       | No   | true  | NULL    |       | true    |            |             |
|            |               | name    | varchar(20) | varchar(20)  | Yes  | false | NULL    | NONE  | true    |            |             |
|            |               | age     | int         | int          | Yes  | false | NULL    | NONE  | true    |            |             |
+------------+---------------+---------+-------------+--------------+------+-------+---------+-------+---------+------------+-------------+

Related

Test plan

  • Verified the EN expected output exactly matches Doris 4.1.1 cluster output
  • IndexKeysType matches the schema's UNIQUE KEY (no copy-paste stale value)
  • Page renders correctly (no fence/markdown issues)

🤖 Generated with Claude Code

…n, DESC ALL)

The Chinese page already documents two additional examples that EN was
missing:

  * `SET show_column_comment_in_describe = true` + `DESC test_table`,
    which surfaces the `Comment` column (session variable introduced
    in 3.0.7 -- already described in the EN Return-Value section but
    never exemplified).
  * `DESC test_table ALL`, which returns IndexName / IndexKeysType /
    InternalType / Visible / DefineExpr / WhereClause.

Translated both blocks to English and added them under the existing
example 1. Output captured directly from a fresh Doris 4.1.1 cluster
against the page's CREATE TABLE schema; `IndexKeysType` is
`UNIQUE_KEYS` to match the UNIQUE KEY(user_id) used in setup.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@morningman morningman merged commit 99b16ab into apache:master May 30, 2026
3 checks passed
morningman pushed a commit that referenced this pull request May 30, 2026
…EN DESC-TABLE example expansion (#3847)

## Summary

Mechanical port of the 4.x fixes in #3830, #3831, #3832, #3834, #3835,
#3836 to dev/master. Every change here was verified to still be needed
on today's master build (cluster deployed from selectdb-qa-test tarball,
5.14 GB).

Three 4.x fixes turned out to be already-applied on dev and are **not**
included in this PR (skipping):
- log10 ZH (NULL/NaN examples already in dev)
- strleft ZH (example 9 already removed in dev)
- milliseconds-add EN (BIGINT-range example already in dev)

## Files (15)

### ZH (`i18n/zh-CN/.../current/`)
- **arrays-overlap.md** — remove two stray `'` after closing fences
- **unix-timestamp.md** — add missing semicolon after `select
unix_timestamp('1007-11-30 10:30:19')`
- **DESC-TABLE.md** — drop `demo.` qualifier (`DESC demo.test_table ALL`
→ `DESC test_table ALL`); fix stale `DUP_KEYS` cell → `UNIQUE_KEYS`
(matches the page's own `UNIQUE KEY(user_id)` setup)
- **week.md** — drop the ` ```sql ` wrapper around the Mode definition
markdown table
- **milliseconds-add.md** — remove 5 copy-paste duplicate examples; fix
BIGINT-range example expected output (\"returns NULL\" → actual
`2023-10-03 12:33:32.083000`)
- **9 array / bitmap / aggregate / string files** — fence-flavor parity
(` ``` ` or ` ```text ` → ` ```sql ` where the block contains runnable
SQL). `trim-in.md` additionally adds example 3 (TRIM comparison) that
was missing.

### EN (`docs/`)
- **DESC-TABLE.md** — add a CREATE TABLE setup block, backport the two
ZH-only examples (Comment column via `show_column_comment_in_describe`,
and `DESC ... ALL`). The Comment-column behavior was already mentioned
in the Return-Value section but never exemplified.

## Verification

Verified end-to-end against today's master cluster — every added example
runs cleanly, behaviors documented are the same on master as on 4.1.1
(no master-side regression on
log10/MINUTE/SPLIT_PART/UNHEX/count_by_enum either).

## Related 4.x PRs
#3830 #3831 #3832 #3834 #3835 #3836

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@boluor boluor deleted the fix/desc-table-en-backport-zh-examples branch May 30, 2026 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants