Skip to content

docs: document v1.2 breaking changes in the upgrade guide - #2727

Merged
fengjiachun merged 3 commits into
mainfrom
copilot/document-v1-2-breaking-changes-again
Aug 12, 2026
Merged

docs: document v1.2 breaking changes in the upgrade guide#2727
fengjiachun merged 3 commits into
mainfrom
copilot/document-v1-2-breaking-changes-again

Conversation

Copilot AI commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

What changed

The v1.2 upgrade guide was missing several compatibility-impacting changes from v1.2.0-beta.1. This update adds the missing migration guidance and concrete upgrade checks to both Nightly and v1.2 docs in English and Chinese.

  • Upgrade path coverage

    • Added a dedicated v1.2 upgrade path section for users moving from v1.0/v1.1 to v1.2.
    • Clarified that earlier upgrade paths still need the existing v1.0 guidance plus the new v1.2 notes.
  • Breaking-change migration guidance

    • Documented removal of PromQL holt_winters().
    • Documented rejection of direct or nested fill, fill_left, and fill_right usages until outer-join semantics are supported.
    • Documented pipeline integer narrowing changes: out-of-range integral values now follow on_failure instead of wrapping; float-to-integer behavior remains unchanged.
    • Added local SQL file sandbox migration guidance and linked to the dedicated migration doc.
    • Documented removal of sparse_primary_key_encoding / experimental_sparse_primary_key_encoding as upgrade cleanup.
  • Practical checks

    • Expanded the upgrade checklist with version-specific checks for:
      • PromQL query inventory and rewrites
      • pipeline dry-run verification for integer boundaries
      • local-file COPY / external-table migration
      • removal of obsolete sparse primary key encoding overrides

Scope

  • Documentation versions: Nightly, 1.2
  • Languages: English, Chinese

Verification

  • pnpm build
  • DOC_LANG=zh pnpm build
  • DOC_LANG=en pnpm check:links
  • DOC_LANG=zh pnpm check:links
  • git diff --check

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.

Copilot AI linked an issue Aug 10, 2026 that may be closed by this pull request
4 tasks
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 10, 2026

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 1f052aa
Status: ✅  Deploy successful!
Preview URL: https://eb2e7b48.greptime-docs.pages.dev
Branch Preview URL: https://copilot-document-v1-2-breaki-j02l.greptime-docs.pages.dev

View logs

Copilot AI changed the title [WIP] Document v1.2 breaking changes in the upgrade guide Document v1.2 upgrade breaking changes Aug 10, 2026
Copilot AI requested a review from fengjiachun August 10, 2026 10:06
@fengjiachun fengjiachun changed the title Document v1.2 upgrade breaking changes docs: document v1.2 breaking changes in the upgrade guide Aug 10, 2026
@fengjiachun

Copy link
Copy Markdown
Contributor

@codex review

@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: fb4d3ee850

ℹ️ 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/deployments-administration/upgrade.md Outdated
Copilot AI and others added 3 commits August 11, 2026 12:00
Co-authored-by: fengjiachun <3860496+fengjiachun@users.noreply.github.com>
Verified each item against the upstream PRs and fixed the inaccurate ones:

- holt_winters was a backward-compatibility alias, not a removed function.
  It maps to double_exponential_smoothing, which predates v1.2, so the
  migration is a rename rather than a rewrite (GreptimeTeam/greptimedb#8457).
- fill/fill_left/fill_right are binary-operator modifiers that only became
  parseable with the promql-parser 0.10.0 bump in the same release, so no
  query that worked before v1.2 is affected. Also noted that this is
  unrelated to the SQL RANGE ... FILL clause.
- Integer narrowing covers int8/int16/int32/uint8/uint16/uint32 plus
  cross-sign conversions into the 64-bit types (GreptimeTeam/greptimedb#8589).
- A config that still sets sparse_primary_key_encoding loads without error;
  the key is ignored rather than rejected (GreptimeTeam/greptimedb#8470).
- The option lives under [region_engine.metric] within a [[region_engine]]
  entry, not in a [metric_engine] block. Corrected both the new cleanup
  instruction and the pre-existing example in the v0.17-to-v1.0 section.

Also dropped the redundant heading level so the items sit at the same depth
as the other per-version sections, replaced the beta.1 label with v1.2,
added the cross-links the Chinese page was missing, and narrowed the
checklist grep hints to fill( so they do not match every SQL RANGE ... FILL.

The configuration reference cleanup is left to #2728, which landed on main
with the same conclusion.
@fengjiachun
fengjiachun force-pushed the copilot/document-v1-2-breaking-changes-again branch from fb4d3ee to 1f052aa Compare August 11, 2026 04:05
@fengjiachun

Copy link
Copy Markdown
Contributor

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🎉

Reviewed commit: 1f052aa5a8

ℹ️ 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
fengjiachun marked this pull request as ready for review August 11, 2026 07:31
@fengjiachun
fengjiachun merged commit 3afe3d5 into main Aug 12, 2026
7 checks passed
@fengjiachun
fengjiachun deleted the copilot/document-v1-2-breaking-changes-again branch August 12, 2026 03:37
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.

Document v1.2 breaking changes in the upgrade guide

3 participants