Skip to content

docs: add C integration guide#581

Merged
JingsongLi merged 2 commits into
apache:mainfrom
JingsongLi:codex/docs-c-integration
Jul 21, 2026
Merged

docs: add C integration guide#581
JingsongLi merged 2 commits into
apache:mainfrom
JingsongLi:codex/docs-c-integration

Conversation

@JingsongLi

@JingsongLi JingsongLi commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

What changed

  • add a C Integration guide covering source builds, header generation, linking, catalog access, scan planning, and Arrow streaming reads
  • document projection, predicate, write/commit, error, and resource ownership conventions for the C ABI
  • add the guide to the MkDocs navigation
  • update Cargo.lock to record the existing log dependency required by crates/paimon

Why

The repository contains a complete paimon-c ABI, but the documentation site did not explain how C consumers can build or use it. The lockfile was also missing the already-declared log dependency, causing every Rust CI command using --locked to fail before compilation.

Validation

  • mkdocs build --strict
  • generated paimon.h with cbindgen
  • compiled the complete C example with cc -std=c11 -Wall -Wextra -Werror -fsyntax-only
  • cargo +1.91.0 metadata --locked --format-version 1 --no-deps
  • cargo +1.91.0 check --locked --workspace --all-targets --all-features

@JingsongLi
JingsongLi marked this pull request as ready for review July 21, 2026 13:52
@JingsongLi JingsongLi closed this Jul 21, 2026
@JingsongLi JingsongLi reopened this Jul 21, 2026
@JingsongLi
JingsongLi merged commit 2fb5e49 into apache:main Jul 21, 2026
13 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