Skip to content

Python API

Quick Start

from dbcreds import get_connection, get_engine

# Get a connection
with get_connection("dev") as conn:
    cursor = conn.cursor()
    cursor.execute("SELECT 1")

# Get SQLAlchemy engine
engine = get_engine("dev")

Shortcut Functions

dbcreds.utils.shortcuts

Convenience functions for common dbcreds operations.

This module provides simple shortcuts for the most common use cases, making it easy to get started with dbcreds.

Classes

Functions

get_async_engine(environment: str = 'default', **kwargs) -> AsyncEngine async

Get an async SQLAlchemy engine for an environment.

Args: environment: Environment name (default: "default") **kwargs: Additional engine parameters

Returns: SQLAlchemy AsyncEngine object

Examples: >>> engine = await get_async_engine("dev") >>> async with engine.connect() as conn: ... result = await conn.execute("SELECT 1")

Source code in dbcreds\utils\shortcuts.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
async def get_async_engine(environment: str = "default", **kwargs) -> AsyncEngine:
    """
    Get an async SQLAlchemy engine for an environment.

    Args:
        environment: Environment name (default: "default")
        **kwargs: Additional engine parameters

    Returns:
        SQLAlchemy AsyncEngine object

    Examples:
        >>> engine = await get_async_engine("dev")
        >>> async with engine.connect() as conn:
        ...     result = await conn.execute("SELECT 1")
    """
    manager = _get_manager()
    creds = manager.get_credentials(environment)
    env = manager.environments.get(environment.lower())

    if not env:
        raise CredentialError(f"Environment '{environment}' not found")

    # Build async connection string
    if env.database_type == DatabaseType.POSTGRESQL:
        driver = "postgresql+asyncpg"
    elif env.database_type == DatabaseType.MYSQL:
        driver = "mysql+aiomysql"
    else:
        raise NotImplementedError(f"Async support for {env.database_type} not yet implemented")

    conn_string = f"{driver}://{creds.username}:{creds.password.get_secret_value()}@{creds.host}:{creds.port}/{creds.database}"
    return create_async_engine(conn_string, **kwargs)

get_connection(environment: str = 'default', **kwargs)

Get a database connection for an environment.

Args: environment: Environment name (default: "default") **kwargs: Additional connection parameters

Yields: Database connection object

Examples: >>> with get_connection("dev") as conn: ... cursor = conn.cursor() ... cursor.execute("SELECT 1")

Source code in dbcreds\utils\shortcuts.py 
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
@contextmanager
def get_connection(environment: str = "default", **kwargs):
    """
    Get a database connection for an environment.

    Args:
        environment: Environment name (default: "default")
        **kwargs: Additional connection parameters

    Yields:
        Database connection object

    Examples:
        >>> with get_connection("dev") as conn:
        ...     cursor = conn.cursor()
        ...     cursor.execute("SELECT 1")
    """
    manager = _get_manager()
    creds = manager.get_credentials(environment)
    env = manager.environments.get(environment.lower())

    if not env:
        raise CredentialError(f"Environment '{environment}' not found")

    # Get appropriate connection based on database type
    if env.database_type == DatabaseType.POSTGRESQL:
        import psycopg2

        conn_params = {
            "host": creds.host,
            "port": creds.port,
            "database": creds.database,
            "user": creds.username,
            "password": creds.password.get_secret_value(),
            **kwargs,
        }
        conn = psycopg2.connect(**conn_params)
        try:
            yield conn
        finally:
            conn.close()

    elif env.database_type == DatabaseType.MYSQL:
        import MySQLdb

        conn_params = {
            "host": creds.host,
            "port": creds.port,
            "db": creds.database,
            "user": creds.username,
            "passwd": creds.password.get_secret_value(),
            **kwargs,
        }
        conn = MySQLdb.connect(**conn_params)
        try:
            yield conn
        finally:
            conn.close()

    else:
        raise NotImplementedError(f"Database type {env.database_type} not yet implemented")

get_connection_string(environment: str = 'default', include_password: bool = True) -> str

Get a database connection string for an environment.

Args: environment: Environment name (default: "default") include_password: Whether to include password in the string

Returns: Database connection URI

Examples: >>> uri = get_connection_string("dev") >>> print(uri) 'postgresql://user:pass@localhost:5432/mydb'

Source code in dbcreds\utils\shortcuts.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def get_connection_string(environment: str = "default", include_password: bool = True) -> str:
    """
    Get a database connection string for an environment.

    Args:
        environment: Environment name (default: "default")
        include_password: Whether to include password in the string

    Returns:
        Database connection URI

    Examples:
        >>> uri = get_connection_string("dev")
        >>> print(uri)
        'postgresql://user:pass@localhost:5432/mydb'
    """
    creds = get_credentials(environment)
    return creds.get_connection_string(include_password=include_password)

get_credentials(environment: str = 'default') -> DatabaseCredentials

Get database credentials for an environment.

Args: environment: Environment name (default: "default")

Returns: DatabaseCredentials object

Examples: >>> creds = get_credentials("dev") >>> print(f"Connecting to {creds.host}:{creds.port}")

Source code in dbcreds\utils\shortcuts.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def get_credentials(environment: str = "default") -> DatabaseCredentials:
    """
    Get database credentials for an environment.

    Args:
        environment: Environment name (default: "default")

    Returns:
        DatabaseCredentials object

    Examples:
        >>> creds = get_credentials("dev")
        >>> print(f"Connecting to {creds.host}:{creds.port}")
    """
    manager = _get_manager()
    return manager.get_credentials(environment)

get_engine(environment: str = 'default', **kwargs) -> Engine

Get a SQLAlchemy engine for an environment.

Args: environment: Environment name (default: "default") **kwargs: Additional engine parameters

Returns: SQLAlchemy Engine object

Examples: >>> engine = get_engine("dev") >>> with engine.connect() as conn: ... result = conn.execute("SELECT 1")

Source code in dbcreds\utils\shortcuts.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def get_engine(environment: str = "default", **kwargs) -> Engine:
    """
    Get a SQLAlchemy engine for an environment.

    Args:
        environment: Environment name (default: "default")
        **kwargs: Additional engine parameters

    Returns:
        SQLAlchemy Engine object

    Examples:
        >>> engine = get_engine("dev")
        >>> with engine.connect() as conn:
        ...     result = conn.execute("SELECT 1")
    """
    conn_string = get_connection_string(environment)
    return create_engine(conn_string, **kwargs)

Core Classes

See API Reference for detailed class documentation.