docs: add first-principles ADBC driver overview - #18
Open
fornwall wants to merge 1 commit into
Open
Conversation
Add docs/adbc.md, a big-picture walkthrough of what an ADBC driver is and how one is wired together, aimed at readers new to Arrow and ADBC. Covers the problem ADBC solves, a short Arrow/C Data Interface refresher, the three core handle objects (Database/Connection/Statement) and their lifecycle, error handling, the shared-library AdbcDriverInit entrypoint and the AdbcDriver vtable, version-based forward compatibility, the two ways to consume a driver (direct link vs. driver manager), and how the C/C++ drivers here are implemented on the shared CRTP framework. Stops short of per-driver internals by design. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Cx7W5w2mFGh6U774xNBDWD
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
docs/adbc.md, a big-picture walkthrough of what an ADBC driver is and how one is wired together, written for readers new to Arrow and ADBC.What it covers
ArrowSchema/ArrowArray/ArrowArrayStream) to follow along.AdbcDatabase→AdbcConnection→AdbcStatement), theirNew/SetOption/Init/Releaselifecycle, and theAdbcStatusCode+AdbcErrorerror model, with a minimal end-to-end example.AdbcDriverInit, theAdbcDrivervtable it fills, and how theversionargument keeps old and new binaries compatible.dlopens a driver by name and forwards the public API into its vtable.c/driver/framework/, the concrete C/C++ drivers, and pointers to the Go/Java/Rust implementations.It deliberately stays at the big-picture level and stops short of per-driver internals, with a "where to look next" table for going deeper.
All in-repo links were verified to resolve.
🤖 Generated with Claude Code
https://claude.ai/code/session_01Cx7W5w2mFGh6U774xNBDWD