Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions c/include/arrow-adbc/adbc.h
Original file line number Diff line number Diff line change
Expand Up @@ -2380,12 +2380,14 @@ AdbcStatusCode AdbcStatementExecutePartitions(struct AdbcStatement* statement,
/// to load a library and call a function of this type to load the
/// driver.
///
/// Although drivers may choose any name for this function, the
/// recommended name is "AdbcDriverInit", or a name derived from the
/// name of the driver's shared library as follows: remove the 'lib'
/// prefix (on Unix systems) and all file extensions, then PascalCase
/// the driver name, append Init, and prepend Adbc (if not already
/// there). For example:
/// Although drivers may choose any name for this function, it's recommended
/// that drivers use the name "AdbcDriverInit" for maximum compatibility.
/// Further, it's recommended to also export an alias for this function using a
/// name derived from the name of the driver's shared library. This aliasing
/// makes it easier to statically link multiple drivers into the same program.
/// The process for naming this alias is as follows: remove the 'lib' prefix (on
/// Unix systems) and all file extensions, then PascalCase the driver name,
/// append Init, and prepend Adbc (if not already there). For example:
///
/// - libadbc_driver_sqlite.so.2.0.0 -> AdbcDriverSqliteInit
/// - adbc_driver_sqlite.dll -> AdbcDriverSqliteInit
Expand Down
3 changes: 2 additions & 1 deletion docs/source/format/driver_manifests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,8 @@ Below is an example of a driver manifest:
unsupported = [] # list of strings such as 'async'

[Driver]
entrypoint = 'AdbcDriverInit' # entrypoint to use if not using default
entrypoint = 'AdbcDriverInit' # entrypoint to use if not using defaults of
# either AdbcDriverFooInit or AdbcDriverInit
# You can provide just a single path
# shared = '/path/to/libadbc_driver.so'

Expand Down
4 changes: 3 additions & 1 deletion docs/source/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ Glossary
In ADBC, the name of a function exported by a driver that the
:term:`driver manager` calls when a driver is loaded to perform any
initialization required by the driver. The name follows a convention which
is outlined in :c:type:`AdbcDriverInitFunc` but another name may be used.
is outlined in :c:type:`AdbcDriverInitFunc`. Any name may be used but, for
maximum compatibility, following the convention in
:c:type:`AdbcDriverInitFunc` is recommended.

statement
In the ADBC API, the statement object/struct holds state for executing a
Expand Down
14 changes: 8 additions & 6 deletions go/adbc/drivermgr/arrow-adbc/adbc.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading