ddbs_options: Get or set global duckspatial options

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

Get or set global duckspatial options

Description

Get or set global duckspatial options

Usage

ddbs_options(output_type = NULL, mode = NULL, duckdb_storage_version = NULL)

Arguments

output_type	Character string. Controls the default return type for ddbs_collect. Must be one of: "sf" (default): Eagerly collected sf object (in-memory). "tibble": Eagerly collected tibble without geometry. "raw": Eagerly collected tibble with geometry as raw WKB bytes. "geoarrow": Eagerly collected tibble with geometry as geoarrow_vctr. If NULL (the default), the existing option is not changed.
mode	Character. Controls the return type. Options: "duckspatial" (default): Lazy spatial data frame backed by dbplyr/DuckDB "sf": Eagerly collected sf object (uses memory) If NULL (the default), the existing option is not changed.
duckdb_storage_version	Character. The default DuckDB storage compatibility version for newly created database files. See https://duckdb.org/docs/internals/storage for details.

Value

Invisibly returns a list containing the currently set options.

Examples

## Not run: 
# Set default mode to geoarrow
ddbs_options(mode = "geoarrow")

# Set default output to tibble
ddbs_options(output_type = "tibble")

# Check current settings
ddbs_options()

## End(Not run)

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