Repository files navigation

DuckDB is an in-process SQL OLAP database management system.It is designed to support analytical query workloads and is optimized for fast query execution.This repository contains the R bindings for DuckDB.

Installing the package from source may take up to an hour.Consider using binary Windows/macOS packages from CRAN for recent R versions, orPosit Package Manager for various flavors of Linux or older R versions.

install.packages("duckdb")

Installing the package from source may take up to an hour.Binaries are available for recent versions of R.Reviewhttps://docs.r-universe.dev/install/binaries.html for configuring installation of binary packages on Linux.

install.packages("duckdb",repos= c("https://duckdb.r-universe.dev","https://cloud.r-project.org"))

Installing the package from GitHub may take up to an hour.

# install.packages("pak", repos = sprintf("https://r-lib.github.io/p/pak/stable/%s/%s/%s", .Platform$pkgType, R.Version()$os, R.Version()$arch))pak::pak("duckdb/duckdb-r")

See theR API in the DuckDB documentation.

To build the R package, you first need to clone this repository and install the dependencies:

# install.packages("pak", repos = sprintf("https://r-lib.github.io/p/pak/stable/%s/%s/%s", .Platform$pkgType, R.Version()$os, R.Version()$arch))pak::pak()

Then, install:

~duckdb-r: R CMD INSTALL.

Set theMAKEFLAGS environment variable to-j8 or similar for parallel builds.Configureccache for faster repeated builds.

If you wish to test new DuckDB functionality with duckdb-r, make sure your clone ofduckdb-r is one level deeper than your clone ofduckdb (e.g.R/duckdb-r andduckdb).Then run the following commands:

~ (cd duckdb&& git checkout {{desired_branch}})~ (cd R/duckdb-r&& scripts/vendor.sh)~ (cd R/duckdb-r&& R CMD INSTALL .)

It helps if both the duckdb directory and duckdb-r directory are clean.

This package includes a vendored copy of the DuckDB C++ library. The vendoring process is automated and runs hourly to synchronize with the upstream DuckDB repository. For detailed information about how vendoring works, the relationship betweenmain andnext branches, and manual vendoring procedures, seescripts/VENDORING.md.

Thanks to allcontributors to this repository, and to those who contributed when the code was still hosted in the mainduckdb/duckdb repository:

Mark Raasveldt, Pedro Holanda, Tom Ebergen, Reijo Sund, Nicolas Bennett, Patrik Schratz, Tishj, Laurens Kuiper, Sam Ansmink, Andy Teucher, Hadley Wickham, Jonathan Keane, Lindsay Wray, Richard Wesley, Elliana May, Edwin de Jonge, Dewey Dunnington, Carlo Piovesan, Andre Beckedorf, Tania Bogatsch, Pedro Ferreira, Maximilian Girlich, James Lamb, James Atkins, usurai, Ubuntu, Noam Ross, Michael Antonov, Jeroen Ooms, Jamie Lentin, Jacob, and Chilarai.