API Reference

Database

Database connections and queries

Common Functions

These are the most commonly used functions in this category:

db_connect()

Gets a database connection based on the connection name in config.yml. For most use cases, prefer `

db_execute()

Executes a SQL statement on a database without returning results. The connection is created, used,

db_query()

Gets data from a database using a query and connection name. The connection is created, used, and a

Other Functions

Function Description
db_drivers_install() Interactive helper to install one or more database drivers. Provides helpful instructions and handl
db_drivers_status() Checks which database drivers are currently available on the system. Returns a data frame showing t
db_list() Lists all database connections defined in the configuration, showing the connection name, driver, h
db_transaction() Wraps code execution in a database transaction with automatic commit on success and rollback on err
db_with() Provides automatic connection lifecycle management. The connection is automatically closed when the

All Functions

Function Description
db_connect() Gets a database connection based on the connection name in config.yml. For most use cases, prefer `
db_drivers_install() Interactive helper to install one or more database drivers. Provides helpful instructions and handl
db_drivers_status() Checks which database drivers are currently available on the system. Returns a data frame showing t
db_execute() Executes a SQL statement on a database without returning results. The connection is created, used,
db_list() Lists all database connections defined in the configuration, showing the connection name, driver, h
db_query() Gets data from a database using a query and connection name. The connection is created, used, and a
db_transaction() Wraps code execution in a database transaction with automatic commit on success and rollback on err
db_with() Provides automatic connection lifecycle management. The connection is automatically closed when the