Skip to content

Repair Arrow guides and docs.rs for chdb-rust 2.2.1 - #74

Merged
ShawnChen-Sirius merged 1 commit into
mainfrom
codex/arrow-docs-2.2.1
Nov 16, 2026
Merged

ShawnChen-Sirius merged 1 commit into
mainfrom
codex/arrow-docs-2.2.1

Conversation

@ShawnChen-Sirius

@ShawnChen-Sirius ShawnChen-Sirius commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Prepare a 2.2.1 patch because the published 2.2.0 crate cannot be replaced and its docs.rs build failed.
  • Update README and example-guide installation to 2.2.x, replace the raw-FFI insert ranking with the high-level Arrow helpers, and make docs/arrow.md a self-contained, runnable guide. Update the agent skill with the tested core baseline and Rust ownership rules.
  • Repair docs.rs by removing the global docsrs rustc flag that breaks lexical-util on current nightly, and generating FFI bindings from the bundled chdb-core v26.11.1 header without native linkage. The header blob matches chdb-core v26.11.1 programs/local/chdb.h exactly (a12d326b5218608851bd56537ae609819f8ea7db). Add a CI docs.rs-style build check.

Verification

  • DOCS_RS=1 with broken intra-doc links denied: cargo doc passed in the source tree and from the packaged crate.
  • The full Rust example in docs/arrow.md was extracted, compiled, and run against libchdb v26.11.1.
  • Default cargo test suite, cargo package, and cargo publish --dry-run passed locally on macOS arm64.
  • cargo fmt --check, actionlint, engine pin check, and skill validation passed.

No crate or GitHub Release is published by this PR. After review and merge, 2.2.1 needs a separately confirmed tag push and docs.rs build verification.

Note

Repair Arrow guides and docs.rs build for chdb-rust 2.2.1

  • Bumps the crate version to 2.2.1 and rewrites the Arrow documentation (docs/arrow.md, docs/examples.md, README, crate docs) as a usage guide covering scoped reader registration, direct/multi-batch/reader-based insert helpers, and typed query results. Native insert paths do not require Arrow IPC serialization.
  • Reworks the docs.rs build: build.rs now, when DOCS_RS is set, uses the bundled v26.11.1 C header (docs/chdb-ffi-v26.11.1.h), checks it matches CHDB_ENGINE_PIN, generates bindings from it, and skips the native library download.
  • Adds an Ubuntu-latest CI step that builds docs with DOCS_RS=1 and the Arrow feature, failing on broken intra-doc links.
  • Removes the rustc-args --cfg docsrs entry from Cargo.toml.
  • Behavioral Change: CI now fails if the docs.rs-style build or its intra-doc link check fails; a DOCS_RS build no longer downloads or links libchdb.

Macroscope summarized 0388a06.

@ShawnChen-Sirius
ShawnChen-Sirius merged commit 994c4d7 into main Nov 16, 2026
11 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.

1 participant