motherduck (version 0.2.0)

cd: Change Active Database and Schema

Description

Switches the active database and (optionally) schema for a valid DuckDB or MotherDuck connection. The function validates the target database and schema before executing the USE command and provides user feedback via CLI messages.

Usage

cd(.con, database_name, schema_name)

Value

Invisibly returns a message summarizing the new connection context. Side effects include printing CLI headers showing the current user and database context.

Arguments

.con

A valid DBI connection (DuckDB / MotherDuck).

database_name

A character string specifying the database to switch to. Must be one of the available databases returned by list_all_databases().

schema_name

(Optional) A character string specifying the schema to switch to within the given database. Must be one of the available schemas returned by list_current_schemas().

Details

The cd() function is analogous to a "change directory" command in a file system, but for database contexts. It updates the currently active database (and optionally schema) for the given connection. If the target database or schema does not exist, the function aborts with a descriptive CLI error message.

See Also

Other db-meta: launch_ui(), pwd()

Examples

if (FALSE) {
# Connect to MotherDuck
con <- DBI::dbConnect(duckdb::duckdb(dbdir = tempfile()))

# List available databases
list_databases(con)

# Change to a specific database and schema
cd(con, database_name = "analytics_db", schema_name = "public")

# Disconnect
DBI::dbDisconnect(con)
}