ddbs_install: Checks and installs the Spatial extension

In duckspatial: R Interface to 'DuckDB' Database with Spatial Extension

Checks and installs the Spatial extension

Description

Checks if a spatial extension is available, and installs it in a DuckDB database

Usage

ddbs_install(conn, upgrade = FALSE, quiet = FALSE, extension = "spatial")

Arguments

conn	A DBIConnection object to a DuckDB database
upgrade	if TRUE, it upgrades the DuckDB extension to the latest version
quiet	A logical value. If TRUE, suppresses any informational messages. Defaults to FALSE.
extension	name of the extension to install, default is "spatial"

Value

TRUE (invisibly) for successful installation

Examples

## load packages
library(duckspatial)
library(duckdb)

# connect to in memory database
conn <- duckdb::dbConnect(duckdb::duckdb())

# install the spatial extension
ddbs_install(conn)

# disconnect from db
duckdb::dbDisconnect(conn)

## Not run: 
# install the h3 community extension (requires network access)
conn <- duckdb::dbConnect(duckdb::duckdb())
ddbs_install(conn, extension = "h3")
duckdb::dbDisconnect(conn)

## End(Not run)

duckspatial documentation built on June 22, 2026, 9:08 a.m.