Skip to content

compilation.md

Latest commit

 

History

History
114 lines (77 loc) · 2.96 KB

compilation.md

File metadata and controls

114 lines (77 loc) · 2.96 KB

Compilation

To build pg_duckdb, you need:

To build and install, run:

make install

If you want to link libduckdb statically, set DUCKDB_STATIC=1 when interacting with make(1).

Add pg_duckdb to the shared_preload_libraries in your postgresql.conf file:

shared_preload_libraries = 'pg_duckdb'

Next, create the pg_duckdb extension:

CREATE EXTENSION pg_duckdb;

Ubuntu 24.04

This example uses Postgres 17. If you wish to use another version, substitute the version number in the commands as necessary.

Set up Postgres

We recommend using PGDG for Postgres, but you are welcome to use any Postgres packages or install from source. To install Postgres 17 from PGDG:

sudo apt install postgresql-common
sudo /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh
sudo apt install postgresql-17 postgresql-server-dev-17

If you do not install from PGDG, please note that you must have the server-dev package installed to compile extensions.

Install Build Dependencies

sudo apt install \
    build-essential libreadline-dev zlib1g-dev flex bison libxml2-dev \
    libxslt-dev libssl-dev libxml2-utils xsltproc pkg-config libc++-dev \
    libc++abi-dev libglib2.0-dev libtinfo6 cmake libstdc++-12-dev \
    liblz4-dev ninja-build

Clone, Build, and Install pg_duckdb

Checkout pg_duckdb:

git clone https://github.com/duckdb/pg_duckdb
cd pg_duckdb

Build and install:

make -j16
sudo make install

Add pg_duckdb to shared_preload_libraries

echo "shared_preload_libraries = 'pg_duckdb'" | sudo tee /etc/postgresql/17/main/conf.d/pg_duckdb.conf

Alternatively, you can directly edit /etc/postgresql/17/main/postgresql.conf if desired.

Restart Postgres

sudo service postgresql restart

Connect and Activate

You may wish to now create databases and users as desired. To use pg_duckdb immediately, you can use the postgres superuser to connect to the default postgres database:

$ sudo -u postgres psql

postgres=# CREATE EXTENSION pg_duckdb;

MacOS

TODO

FAQ

Q: How do I build for multiple versions of Postgres?
A: If you have multiple versions of Postgres installed, set PG_CONFIG to the path of the pg_config binary that you would like to use for building before compilation.

export PG_CONFIG=/usr/bin/pg_config

Q: make clean didn't remove all the build artifacts. How do I clean the entire project?
A: make clean will clean the pg_duckdb build files, but not libduckdb, which only needs to rebuilt on a DuckDB version change. To clean both pg_duckdb and libduckdb, use make clean-all.