configure_connection: Configure Database Connection

In framework: Structured Data Science Project Scaffolding

Configure Database Connection

Description

Interactively add a database connection to settings.yml (or settings.yml for legacy projects). Connections can be defined inline or in a split file (settings/connections.yml).

Usage

configure_connection(
  name = NULL,
  driver = NULL,
  host = NULL,
  port = NULL,
  database = NULL,
  user = NULL,
  password = NULL,
  interactive = TRUE
)

Arguments

name	Character. Connection name (e.g., "db", "warehouse")
driver	Character. Database driver: "sqlite", "postgresql", "mysql", etc.
host	Character. Database host (for network databases)
port	Integer. Database port (for network databases)
database	Character. Database name
user	Character. Database user (for network databases)
password	Character. Database password (stored in .env)
interactive	Logical. If TRUE, prompts for missing values. Default TRUE.

Value

Invisibly returns updated config

framework documentation built on Feb. 18, 2026, 1:07 a.m.