Repository files navigation

This repository wraps DuckDB's C API calls in Go native types and functions.

Minimum Go version: 1.24.

This module'sfirst release contains DuckDB's v1.2.0 release.

The main module (github.com/duckdb/duckdb-go-bindings) does not link any pre-built static library.

1. Create a new branch and update theDUCKDB_VERSION in theMakefile.
2. Invoke theFetch and Push Libs workflow on the new branch.
3. Update theReleases table in theREADME.md.
4. If the header (duckdb.h) has changes (non-bugfix release), add all changes (new types, functions, etc.) to the bindings.
5. Open a PR.
6. Wait for all tests to pass.
7. Merge the PR intomain.
8. Publish the tags by incrementing the latest tagged release for the main module, and for each OS+architecture combination.

git tag <tagname>git push origin <tagname>

Example PR:#19.

A few pre-built static libraries exist for different OS + architecture combinations.You can import these into your projects without providing additional build flags.CGO must be enabled, and your system needs a compiler available.

Here's a list:

• github.com/duckdb/duckdb-go-bindings/...
  • darwin-amd64
  • darwin-arm64
  • linux-amd64
  • linux-arm64
  • windows-amd64

Note that the lib(s) name must match the name provided in theCGO_LDFLAGS.

On Darwin.

CGO_ENABLED=1 CPPFLAGS="-DDUCKDB_STATIC_BUILD" CGO_LDFLAGS="-lduckdb -lc++ -L/path/to/lib" go build -tags=duckdb_use_static_lib

On Linux.

CGO_ENABLED=1 CPPFLAGS="-DDUCKDB_STATIC_BUILD" CGO_LDFLAGS="-lduckdb -lstdc++ -lm -ldl -L/path/to/lib" go build -tags=duckdb_use_static_lib

On Windows.

CGO_ENABLED=1 CPPFLAGS="-DDUCKDB_STATIC_BUILD" CGO_LDFLAGS="-lduckdb -lws2_32 -lwsock32 -lrstrtmgr -lstdc++ -lm --static -L/path/to/lib" go build -tags=duckdb_use_static_lib

On Darwin.

CGO_ENABLED=1 CGO_LDFLAGS="-lduckdb -L/path/to/dir" DYLD_LIBRARY_PATH=/path/to/dir go build -tags=duckdb_use_lib

On Linux.

CGO_ENABLED=1 CGO_LDFLAGS="-lduckdb -L/path/to/dir" LD_LIBRARY_PATH=/path/to/dir go build -tags=duckdb_use_lib

Provide the duckdb_arrow build tag if you want to use arrow functions