Skip to content

docs: improve docs around driver init funcs - #4637

Open
amoeba wants to merge 2 commits into
apache:mainfrom
amoeba:docs/adbcdriverfooinitfunc
Open

docs: improve docs around driver init funcs#4637
amoeba wants to merge 2 commits into
apache:mainfrom
amoeba:docs/adbcdriverfooinitfunc

Conversation

@amoeba

@amoeba amoeba commented Jul 30, 2026

Copy link
Copy Markdown
Member

We saw some feedback recently that some of the convention around driver shared library name and driver init func names could be clearer. This PR aims to at least improve our language around init func names.

I think what we basically want to say, informally, is:

All drivers should export two init functions, AdbcDriverInit and AdbcDriverFooInit. Drivers must always export AdbcDriverInit and drivers should also export AdbcDriverFooInit. It is also recommended that drivers support conditionally compiling AdbcDriverInit out in order to support static linking of multiple drivers into a single application. Hence our recommendation of exporting AdbcDriverFooInit.

@amoeba
amoeba requested a review from ianmcook July 30, 2026 16:55
@amoeba
amoeba requested a review from lidavidm as a code owner July 30, 2026 16:55
@amoeba
amoeba requested a review from zeroshade July 30, 2026 16:56
@ianmcook

Copy link
Copy Markdown
Member

Thanks for doing this.

I found this a bit hard to follow. Is there a way to make the language clearer and more imperative?

How about also explaining that, regardless of what file name(s) that you as the developer choose for your shared libraries, popular ADBC driver registries systems such as dbc-cdn.columnar.tech will always rename them in the form libadbc_driver_foo?

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