Skip to content

docs: document float SST encoding at table creation - #2927

Merged
discord9 merged 4 commits into
GreptimeTeam:mainfrom
discord9:docs/bss-create-option
Sep 29, 2026
Merged

discord9 merged 4 commits into
GreptimeTeam:mainfrom
discord9:docs/bss-create-option

Conversation

@discord9

Copy link
Copy Markdown
Contributor

What changed

Document experimental_sst_float_field_encoding in the CREATE TABLE reference: accepted values, default behavior, FLOAT/DOUBLE field scope, an opt-in creation example, and workload-dependent performance. Clarify that ALTER is not supported. This documents the existing implementation merged in GreptimeTeam/greptimedb#9069, not the unmerged ALTER proposal #9077.

Scope

  • Documentation versions: Nightly
  • Languages: English and Chinese

Verification

  • git diff --check: passed.
  • Checked option parsing and Parquet writer behavior against GreptimeDB source.
  • Local build could not run because Node and dependencies are unavailable; build validation is left to CI.
  • No links, anchors, or navigation changed.

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.

Links, anchors, and navigation checklist items are not applicable: none changed.

Signed-off-by: discord9 <discord9@163.com>

@killme2008 killme2008 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If this new encoding is useful for metrics, do we need to add it to the user guide doc?

https://docs.greptime.com/user-guide/ingest-data/for-observability/prometheus/#performance-tuning

Comment thread docs/reference/sql/create.md Outdated
Signed-off-by: discord9 <discord9@163.com>

@killme2008 killme2008 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM almostly

Comment thread docs/user-guide/ingest-data/for-observability/prometheus.md
Comment thread docs/user-guide/ingest-data/for-observability/prometheus.md
Signed-off-by: discord9 <discord9@163.com>
Signed-off-by: discord9 <discord9@163.com>
@discord9
discord9 merged commit 850f5bd into GreptimeTeam:main Sep 29, 2026
6 checks passed
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