ConnectionProperties

A class for holding the properties of a database connection. The class is usually created in the pyconfigs/connections.py file. This class can be imported from the squirrels.connections or the squirrels module.

Constructor

Creates a ConnectionProperties object.

def __init__(
    self, *, type: ConnectionTypeEnum = ConnectionTypeEnum.SQLALCHEMY, 
    uri: str, label: str | None = None, 
    sa_create_engine_args: dict[str, Any] = {}
) -> None:

Hide arguments

ConnectionTypeEnum

default:"ConnectionTypeEnum.SQLALCHEMY"

The type of connection as ConnectionTypeEnum.

The ConnectionTypeEnum.ADBC and ConnectionTypeEnum.CONNECTORX connection types do not support placeholders in the SQL query.

str

required

The URI for the connection. The URI format varies by database and connection type.For details on URI formats for each connection type, see URI formats.

str | None

default:"None"

Optional label for the connection. If the label is not provided, the connection name will be used as the label.

dict[str, Any]

default:"{}"

Additional arguments to pass to SQLAlchemy’s create_engine function. Only used if the connection type is ConnectionTypeEnum.SQLALCHEMY.

Examples

Below is an example of a pyconfigs/connections.py file that uses ConnectionProperties to define a SQLite database connection.

from typing import Any
from squirrels import arguments as args, connections as cn


def main(connections: dict[str, cn.ConnectionProperties | Any], sqrl: args.ConnectionsArgs) -> None:
    """
    Define sqlalchemy engines by adding them to the "connections" dictionary
    """
    ## SQLAlchemy URL for a connection engine
    conn_str: str = "sqlite:////absolute/path/to/database.db"

    ## Assigning names to connection engines
    connections["default"] = cn.ConnectionProperties(
        label="SQLite Database", 
        type=cn.ConnectionTypeEnum.SQLALCHEMY, 
        uri=conn_str
    )

The following are additional examples of creating ConnectionProperties objects.

SQLAlchemy connection with engine arguments

# Connection with custom SQLAlchemy engine settings
postgres_conn = ConnectionProperties(
    uri="postgresql://user:password@localhost:5432/mydb",
    label="Production Database",
    sa_create_engine_args={
        "pool_size": 10,
        "pool_pre_ping": True
    }
)

DuckDB connection

# DuckDB native connection
duckdb_conn = ConnectionProperties(
    type=ConnectionTypeEnum.DUCKDB,
    uri="/path/to/database.duckdb",
    label="DuckDB database"
)

# You can also connect to other databases using DuckDB
# such as PostgreSQL, MySQL, and SQLite.
postgres_conn = ConnectionProperties(
    type=ConnectionTypeEnum.DUCKDB,
    uri="postgresql://username@hostname/dbname",
    label="PostgreSQL database"
)

sqlite_conn = ConnectionProperties(
    type=ConnectionTypeEnum.DUCKDB,
    uri="sqlite:/path/to/database.db",
    label="SQLite database"
)

ADBC connection

# Arrow Database Connectivity connection
adbc_conn = ConnectionProperties(
    type=ConnectionTypeEnum.ADBC,
    uri="postgresql://user:password@localhost:5432/mydb",
    label="High Performance ADBC"
)

ConnectorX connection

# Fast data loading with ConnectorX
cx_conn = ConnectionProperties(
    type=ConnectionTypeEnum.CONNECTORX,
    uri="postgresql://user:password@localhost:5432/mydb",
    label="Fast Loading Connection"
)

arguments

auth

connections

parameters

parameter_options

data_sources

dashboards

types

Constructor

Examples

SQLAlchemy connection with engine arguments

DuckDB connection

ADBC connection

ConnectorX connection

​Constructor

​Examples

​SQLAlchemy connection with engine arguments

​DuckDB connection

​ADBC connection

​ConnectorX connection

Constructor

Examples

SQLAlchemy connection with engine arguments

DuckDB connection

ADBC connection

ConnectorX connection