Framework for Python
R Python CLI

Database

db_connect()

Open a database connection defined in the settings.

Usage

db_connect(name: str) -> Connection

Arguments

Name Type Description
name required str

The connection's name under connections in the settings.

Value

A Connection that wraps the driver's connection object. Use it in a with block to close it afterward.

Raises

  • FrameworkError: The connection is not configured, its driver package is not installed, or connecting failed.