Skip to content

docs: document scanbench query suites and results - #2835

Merged
killme2008 merged 1 commit into
mainfrom
docs/2828-scanbench-suites
Sep 9, 2026
Merged

docs: document scanbench query suites and results#2835
killme2008 merged 1 commit into
mainfrom
docs/2828-scanbench-suites

Conversation

@evenyag

@evenyag evenyag commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

What changed

Document scanbench query suites and structured results introduced in GreptimeTeam/greptimedb#9050. Add a named suite example and explain ordered execution, configuration validation, iteration restrictions, generated names, and warmup statistics.

Describe --result-file, result format version 1, normalized projections, timing/size units, partition statistics, and write-on-success behavior. Update the option reference and verbose-output description while preserving existing single-request examples and headings.

Closes #2828

Scope

  • Documentation versions: Nightly
  • Languages: English, Chinese

The upstream feature is not included in the existing 1.2 or older documentation releases.

Verification

  • DOC_LANG=en pnpm check:links (includes the English production build)
  • DOC_LANG=zh pnpm check:links (includes the Chinese production build)
  • git diff --check
  • Verified suite validation, run ordering, warmup behavior, result serialization, and failure handling against upstream source and its serialization test fixture.
  • Parsed JSON examples and checked supported config fields, mutually exclusive projections, and suite names.
  • Checked matching English/Chinese code examples and preservation of existing headings.
  • No benchmark was run against a deployment.

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.
  • Navigation does not require an update because this extends an existing page.

Signed-off-by: evenyag <realevenyag@gmail.com>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4b1cb47
Status: ✅  Deploy successful!
Preview URL: https://a3d125ab.greptime-docs.pages.dev
Branch Preview URL: https://docs-2828-scanbench-suites.greptime-docs.pages.dev

View logs

@killme2008
killme2008 merged commit 2e7ba13 into main Sep 9, 2026
7 checks passed
@killme2008
killme2008 deleted the docs/2828-scanbench-suites branch September 9, 2026 09:19
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: add scanbench query suites and structured results

2 participants