Skip to content

docs: document append_mode table option in ALTER TABLE#2346

Open
evenyag wants to merge 2 commits intomainfrom
codex/github-mention-update-docs-for-feat-support-changing-table
Open

docs: document append_mode table option in ALTER TABLE#2346
evenyag wants to merge 2 commits intomainfrom
codex/github-mention-update-docs-for-feat-support-changing-table

Conversation

@evenyag
Copy link
Contributor

@evenyag evenyag commented Feb 26, 2026

Motivation

  • Add documentation for a new table option append_mode to inform users how to make a table append-only.
  • Keep translated and versioned docs in sync with the English documentation.
  • Normalize a few list/spacing items in the ALTER docs for readability.

fixes #2334

Description

  • Documented a new table option append_mode under ALTER TABLE examples and option list and showed usage with ALTER TABLE monitor SET 'append_mode'='true';.
  • Updated Chinese translations and the versioned docs to include the same append_mode documentation.
  • Minor formatting/whitespace normalizations in the ALTER reference pages to improve list consistency.

Testing

  • Built the documentation site with yarn build (Docusaurus) and the build completed without errors.
  • Verified translated files and versioned docs render the new option text in their respective locations.
  • No code/unit tests were modified by this change.

Codex Task

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 26, 2026

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 75dc8c4
Status: ✅  Deploy successful!
Preview URL: https://ab49a4e4.greptime-docs.pages.dev
Branch Preview URL: https://codex-github-mention-update.greptime-docs.pages.dev

View logs

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @evenyag, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the documentation for the ALTER TABLE command by adding information about the append_mode option, which allows users to configure tables as append-only. It also ensures that the documentation is consistent across different languages and versions, and improves the overall readability of the ALTER reference pages.

Highlights

  • Documentation Update: This PR adds documentation for the append_mode table option in ALTER TABLE statements, explaining how to make a table append-only.
  • Translation Synchronization: The changes include updates to Chinese translations and versioned documentation to ensure consistency across all versions and languages.
  • Formatting Normalization: Minor formatting and whitespace normalizations were applied to the ALTER reference pages to improve readability and list consistency.
Changelog
  • docs/reference/sql/alter.md
    • Documented the append_mode table option.
    • Normalized list and spacing items for improved readability.
  • i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/alter.md
    • Updated Chinese translations to include documentation for the append_mode table option.
  • i18n/zh/docusaurus-plugin-content-docs/version-1.0/reference/sql/alter.md
    • Updated versioned Chinese translations to include documentation for the append_mode table option.
  • versioned_docs/version-1.0/reference/sql/alter.md
    • Updated versioned documentation to include documentation for the append_mode table option.
Activity
  • Documentation site built successfully with yarn build.
  • Verified translated files and versioned docs render the new option text.
  • No code/unit tests were modified.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request effectively documents the new append_mode table option for ALTER TABLE across English, Chinese, and versioned documentation files. The accompanying formatting normalizations improve the overall readability and consistency of the ALTER reference. My feedback focuses on enhancing the clarity of the append_mode description to be more explicit about its irreversibility, ensuring users fully understand the implications of enabling this option.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Copy link
Contributor

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs for feat: support changing table's append_mode to true

2 participants