Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 23, 2025

Documentation Update for PostgreSQL Auto Schema Creation ✅

This PR updates documentation for the new auto_create_schema feature added in GreptimeDB PR #7459.

Checklist:

  • Update /docs/user-guide/deployments-administration/manage-metadata/configuration.md to document auto_create_schema parameter for PostgreSQL backend
  • Update /versioned_docs/version-1.0/user-guide/deployments-administration/manage-metadata/configuration.md with the same changes
  • Update /docs/user-guide/deployments-administration/configuration.md to add meta_schema_name and auto_create_schema to metasrv options table
  • Update /versioned_docs/version-1.0/user-guide/deployments-administration/configuration.md with the same changes
  • Update Chinese (zh) documentation for nightly and version 1.0
  • Resolve merge conflicts with main branch (rebased on latest main: commit 3b05790)
  • Code review completed - no issues found
  • Security check completed - no issues (documentation-only changes)

Changes Summary:

1. English Documentation (nightly and version-1.0)

  • Metadata Storage Configuration (manage-metadata/configuration.md):

    • Added auto_create_schema parameter (default: true) to PostgreSQL backend configuration
    • Removed outdated note requiring manual schema creation
    • Documented CREATE SCHEMA permission requirement
  • Configuration Reference (configuration.md):

    • Added meta_schema_name entry to metasrv options table
    • Added auto_create_schema entry with description

2. Chinese Documentation (nightly and version-1.0)

  • 元数据存储配置 (manage-metadata/configuration.md):

    • 添加 auto_create_schema 参数(默认值:true
    • 移除了需要手动创建 schema 的过时说明
    • 说明了需要 CREATE SCHEMA 权限
  • 配置参考 (configuration.md):

    • 添加 meta_schema_name 条目到 metasrv 选项表
    • 添加 auto_create_schema 条目及说明

3. Merge Conflict Resolution

  • Rebased on latest main branch (commit 3b05790)
  • Preserved both the new WAL configuration options from main and the PostgreSQL schema options from this PR
  • Resolved all merge conflicts successfully

Feature Background:

This feature addresses the issue where GreptimeDB metasrv would fail to start if the PostgreSQL schema specified in meta_schema_name doesn't exist. The new auto_create_schema option (enabled by default) automatically creates the schema before creating metadata tables.

Files Changed:

English:

  • docs/user-guide/deployments-administration/configuration.md
  • docs/user-guide/deployments-administration/manage-metadata/configuration.md
  • versioned_docs/version-1.0/user-guide/deployments-administration/configuration.md
  • versioned_docs/version-1.0/user-guide/deployments-administration/manage-metadata/configuration.md

Chinese (zh):

  • i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/configuration.md
  • i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/manage-metadata/configuration.md
  • i18n/zh/docusaurus-plugin-content-docs/version-1.0/user-guide/deployments-administration/configuration.md
  • i18n/zh/docusaurus-plugin-content-docs/version-1.0/user-guide/deployments-administration/manage-metadata/configuration.md
Original prompt

This section details on the original issue you should resolve

<issue_title>Update docs for feat: allow auto schema creation for pg</issue_title>
<issue_description>A document change request is generated from GreptimeTeam/greptimedb#7459</issue_description>

<agent_instructions>update version 1.0 and nightly doc</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Dec 23, 2025

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 19cc8e3
Status:⚡️  Build in progress...

View logs

Copilot AI changed the title [WIP] Update docs for auto schema creation in pg docs: document auto_create_schema for PostgreSQL metadata backend Dec 23, 2025
Copilot AI requested a review from WenyXu December 23, 2025 11:37
@WenyXu
Copy link
Member

WenyXu commented Dec 23, 2025

@copilot please update zh doc as well

Copy link
Contributor Author

Copilot AI commented Dec 23, 2025

@copilot please update zh doc as well

Updated Chinese documentation in commit 71fae40. The changes include:

  • Added auto_create_schema parameter to both nightly and version-1.0 Chinese docs
  • Updated metadata configuration examples with the new parameter
  • Added meta_schema_name and auto_create_schema entries to the metasrv options table in configuration reference

Copilot AI changed the title docs: document auto_create_schema for PostgreSQL metadata backend docs: document auto_create_schema for PostgreSQL metadata backend (EN & ZH) Dec 23, 2025
@WenyXu WenyXu marked this pull request as ready for review December 29, 2025 11:57
@WenyXu WenyXu requested a review from killme2008 as a code owner December 29, 2025 11:57
Copy link
Contributor

@killme2008 killme2008 left a comment

Choose a reason for hiding this comment

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

LGTM

@killme2008
Copy link
Contributor

@copilot There is a conflict with main branch

Copy link
Contributor Author

Copilot AI commented Dec 30, 2025

@copilot There is a conflict with main branch

Resolved merge conflict with main branch. The PR has been rebased on the latest main (commit db46439). All documentation changes for the auto_create_schema feature are preserved, along with the new WAL configuration options from main.

Note: The rebased commits have new hashes due to the rebase:

  • Initial plan: c9fde7c
  • English docs: 1b064c1
  • Chinese docs: 496892f

The branch needs to be force-pushed to update the PR. Since I cannot do this directly, you may need to pull the changes locally and force push, or merge via GitHub's UI which should handle the diverged histories.

@WenyXu
Copy link
Member

WenyXu commented Dec 30, 2025

@copilot please resolve conflicts

Copy link
Contributor Author

Copilot AI commented Dec 30, 2025

@copilot please resolve conflicts

Conflicts resolved. Successfully rebased on latest main (commit 3b05790). All documentation changes are preserved:

  • PostgreSQL meta_schema_name and auto_create_schema options added
  • WAL configuration options from main integrated
  • No duplicate content or conflict markers

New commit hashes:

  • Initial plan: 4ea402b
  • English docs: e7af960
  • Chinese docs: c0480e7

The branch requires force push since history was rewritten during rebase.

@WenyXu WenyXu merged commit 815c982 into main Dec 30, 2025
4 of 5 checks passed
@WenyXu WenyXu deleted the copilot/update-docs-auto-schema-pg branch December 30, 2025 07:29
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.

Update docs for feat: allow auto schema creation for pg

4 participants