Skip to content

docs: clarify JSON2 type hints, query inference, and ALTER settings - #2916

Merged
fengys1996 merged 3 commits into
GreptimeTeam:mainfrom
fengys1996:docs/json2-type-hints-alter
Oct 12, 2026
Merged

fengys1996 merged 3 commits into
GreptimeTeam:mainfrom
fengys1996:docs/json2-type-hints-alter

Conversation

@fengys1996

@fengys1996 fengys1996 commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

What changed

  • Clarify JSON2 type hints and supported options.
  • Explain return type inference for json_get and dot syntax.
  • Document changing JSON2 column settings with ALTER TABLE.
  • Update SQL examples and align English and Chinese documentation.

Scope

  • Documentation versions: Nightly
  • Languages: English, Chinese

Verification

Checklist

  • I verified the content against the applicable GreptimeDB version.
  • I updated the relevant documentation versions and languages, or explained why not.
  • I checked changed links and anchors.
  • I updated navigation when the document structure changed.

@fengys1996
fengys1996 force-pushed the docs/json2-type-hints-alter branch from f29833a to 8834348 Compare September 23, 2026 11:13
@fengys1996 fengys1996 changed the title docs: update JSON2 docs docs: update JSON2 Sep 24, 2026
@MichaelScofield
MichaelScofield requested a lite review from Copilot September 24, 2026 03:47
@MichaelScofield

Copy link
Copy Markdown
Contributor

@codex review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Preserve the published legacy anchors in the JSON2 documentation.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 4 Low severity

Open (4)
What changed in this PR

Updates Nightly JSON2 documentation in English and Chinese, including syntax, type hints, querying, pipeline options, and ALTER TABLE behavior.

Changes:

  • Revised JSON2 usage and configuration guidance.
  • Updated pipeline type-hint documentation.
  • Added JSON2 configuration alteration references.
File Summary
i18n/​zh/​docusaurus-plugin-content-docs/​current/​user-guide/​logs/​json2.md Updated Chinese JSON2 guide.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​reference/​sql/​alter.md Added Chinese JSON2 ALTER documentation.
i18n/​zh/​docusaurus-plugin-content-docs/​current/​reference/​pipeline/​pipeline-config.md Updated Chinese pipeline options.
docs/​user-guide/​logs/​json2.md Updated English JSON2 guide.
docs/​reference/​sql/​alter.md Added English JSON2 ALTER documentation.
docs/​reference/​pipeline/​pipeline-config.md Updated English pipeline options.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/user-guide/logs/json2.md Outdated

@MichaelScofield MichaelScofield left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed all 6 changed Nightly documentation files (276 additions / 104 deletions), including English/Chinese alignment, links and heading compatibility, and the JSON2 claims against current upstream source and SQLness expectations.

Found one additional P2 technical issue below: explicit json_get calls do not inherit column type hints in the same way as dot syntax.

The existing anchor findings also apply: retain json-field-type-hints in English and 语法, json-字段-type-hint, json_get-udf, and 未来规划 in Chinese. I have not duplicated those inline threads.

Verification: the PR's build and both strict locale link checks are green. This was a source/test-expectation review; I did not rerun the site builds or execute the SQL examples locally. No repository files were changed.

Comment thread docs/user-guide/logs/json2.md
remote unused AnchorAlias
@fengys1996
fengys1996 force-pushed the docs/json2-type-hints-alter branch from c80c78b to 985c072 Compare October 10, 2026 07:58
@fengys1996
fengys1996 marked this pull request as ready for review October 10, 2026 08:06
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 10, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-10T08:13:02.718411Z 985c072 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@fengys1996 fengys1996 changed the title docs: update JSON2 docs: clarify JSON2 type hints, query inference, and ALTER settings Oct 10, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 985c072caf

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/user-guide/logs/json2.md Outdated
Comment thread docs/reference/sql/alter.md Outdated
Comment thread docs/user-guide/logs/json2.md Outdated
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.

4 participants