Installation

Python Installation

DuckDB can be installed for Python using the following command:

pip install duckdb

After installation, DuckDB can be used as follows:

import duckdb
cursor = duckdb.connect(':memory:').cursor()
print(cursor.execute('SELECT 42').fetchall())

For a more detailed description of the Python API, see the /docs/current/python/api.

R Installation

DuckDB can be installed for the R Environment for Statistical Computing using the following command:

remotes::install_github("cwida/duckdb/tools/rpkg", build = FALSE)

DuckDB for R requires remotes to be installed. On Windows, you will also need Rtools installed. After installation, DuckDB can be used as follows:

library("DBI")
con <- dbConnect(duckdb::duckdb(), ":memory:")
dbWriteTable(con, "iris", iris)
dbGetQuery(con, 'SELECT "Species", MIN("Sepal.Width") FROM iris GROUP BY "Species"')

Installation From Source

The source code of DuckDB can be found here. DuckDB requires CMake to be installed and a C++11 compliant compiler. GCC 4.9 and newer, Clang 3.9 and newer and VisualStudio 2017 are tested on each revision.

Compiling

Run make in the root directory to compile the sources. For development, use make debug to build a non-optimized debug version. You may run make unit and make allunit to verify that your version works properly after making changes.

On systems without GNU Make (e.g. Windows), you can directly use CMake to generate project files for your compiler or IDE of choice (e.g. Visual Studio).

Usage

A command line utility based on sqlite3 can be found in either build/release/tools/shell/shell (release, the default) or build/debug/tools/shell/shell (debug).

Embedding

As DuckDB is an embedded database, there is no database server to launch or client to connect to a running server. However, the database server can be embedded directly into an application using the C or C++ bindings. The main build process creates the shared library build/release/src/libduckdb.[so|dylib|dll] that can be linked against. A static library is built as well.

For examples on how to embed DuckDB into your application, see the examples folder in the repository.