docs: update configuration reference with new options and formatting - #2636
Merged
Conversation
Deploying greptime-docs with
|
| Latest commit: |
434e5ef
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://335165b5.greptime-docs.pages.dev |
| Branch Preview URL: | https://codex-update-outdated-grepti.greptime-docs.pages.dev |
Member
Author
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Use the valid postgres_store backend name
These new Chinese table descriptions spell the backend as postgre_store, but the supported value listed just above is postgres_store. Readers copying the condition/value while configuring PostgreSQL metadata storage would use an unrecognized backend name, so both new mentions should be corrected to postgres_store.
ℹ️ 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".
Member
Author
|
@codex address feedbacks |
daviderli614
approved these changes
Jul 21, 2026
|
Summary
Testing
Note: I left the existing unrelated working-tree files untouched: |
Member
Author
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Don't hide the default PostgreSQL schema
The sample above now sets meta_schema_name = "greptime_schema" together with auto_create_schema = true, and the generated GreptimeDB config reference also reports greptime_schema as the default, so listing the default as -- is misleading. In PostgreSQL-backed metasrv deployments where the service account lacks permission to create/use that schema, operators following this table may not grant or pre-create greptime_schema and can hit startup failures even without setting the option. Please document the actual default.
Don't claim MySQL uses meta_table_name
The generated config reference says meta_table_name is only used for postgres_store; the MySQL metadata backend takes its database information from the DSN and does not honor this option. By adding mysql_store here, MySQL-backed metasrv users may set the value expecting the metadata table name to change, but it will be ignored. Please restrict this note to PostgreSQL unless the MySQL backend actually supports the setting.
ℹ️ 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".
Member
Author
|
@codex address feedbacks |
|
Summary
Testing
Note: I left the existing unrelated working-tree files untouched: |
WenyXu
commented
Jul 23, 2026
WenyXu
commented
Jul 23, 2026
Member
Author
|
@codex address feedbacks both zh & en version |
|
Summary
Testing
|
Member
Author
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e90be0dce8
ℹ️ 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".
fengjiachun
reviewed
Jul 23, 2026
Member
Author
|
@codex address feedbacks both zh & en version |
|
Summary
Testing
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
configuration.mddocumentation (English and Chinese) up to date with newly added server and protocol options and to standardize default value formatting.flownode,jaeger,otlp) and surface new metadata/backend options required for recent runtime and kv-backend improvements.data_home, Prometheus batching, selector semantics) to reduce operator confusion.Description
enable_cors,cors_allowed_origins,prom_validation_mode,grpc.tls,mysql.keep_alive,postgres.keep_alive,prepared_stmt_cache_size, andexperimental_*flags, and OpenTelemetry/Jaeger options (jaeger,otlp,trace_ingest_chunk_size).[backend_tls]),meta_schema_name,auto_create_schema,max_recv_message_size/max_send_message_size, HTTP server defaults,max_metadata_value_size, and adjustedenable_region_failover/selector explanations to match current behavior.data_hometo storage examples, updated various default representations to a normalized format (removed extra quotes and unified code formatting) and changed several table default values and descriptions (includingpending_rows_flush_interval,max_background_*,scan_memory_limit, and WAL/selector defaults) for clarity.Testing
Codex Task