Learn R Programming

contoso (version 2.0.0)

launch_ui: Launch the DuckDB UI in your browser

Description

The launch_ui() function installs and launches the DuckDB UI extension for an active DuckDB database connection. This allows users to interact with the database via a web-based graphical interface.

Your connection from create_contoso_duckdb() is returned in the list.

Usage

launch_ui(.con)

Value

The function is called for its side effects and does not return a value. It launches the DuckDB UI and opens it in your default web browser.

Arguments

.con

A valid DBIConnection object connected to a DuckDB database. The function will check that the connection is valid before proceeding.

Details

The function performs the following steps:

  • Checks that the provided DuckDB connection is valid. If the connection is invalid, it aborts with a descriptive error message.

  • Installs the ui extension into the connected DuckDB instance.

  • Calls the start_ui() procedure to launch the DuckDB UI in your browser.

This provides a convenient way to explore and manage DuckDB databases interactively without needing to leave the R environment.

See Also

  • create_contoso_duckdb() for creating example Contoso datasets in DuckDB.

  • DBI::dbConnect() and DBI::dbDisconnect() for managing DuckDB connections.

  • duckdb::duckdb() for creating a DuckDB driver instance.

Examples

Run this code
if (FALSE) {
# Connect to DuckDB
db <- create_contoso_duckdb()

# Launch the DuckDB UI
launch_ui(db$con)

# Clean up
DBI::dbDisconnect(db$con, shutdown = TRUE)
}

Run the code above in your browser using DataLab