Skip to content

Database

database

Classes

Database

Bases: AsyncContextMixin, ABC

Abstract base class for database containers.

All database implementations should inherit from this class and implement the required abstract methods. This ensures a consistent interface across different database backends.

The class provides: 1. Lifecycle management through AsyncContextMixin (init/close) 2. Health check interface (ping) 3. Raw query execution interface (exec)

Example 
class MyDatabase(Database):
    async def init(self) -> None:
        # Initialize connection
        pass

    async def close(self) -> None:
        # Close connection
        pass

    async def ping(self) -> bool:
        # Check connectivity
        pass

    async def exec(
        self, readonly: bool, **kwargs: t.Any
    ) -> t.Any:
        # Execute raw query
        pass
Functions
ping abstractmethod async 
ping() -> bool

Check database connectivity.

Returns:

Type Description
bool

True if database is reachable and healthy, False otherwise.
Note

Implementations should not raise exceptions. Instead, catch any errors and return False.

Source code in audex/lib/database/__init__.py 
44
45
46
47
48
49
50
51
52
53
54
55
@abc.abstractmethod
async def ping(self) -> bool:
    """Check database connectivity.

    Returns:
        True if database is reachable and healthy, False otherwise.

    Note:
        Implementations should not raise exceptions. Instead, catch
        any errors and return False.
    """
    pass
exec abstractmethod async 
exec(*args: Any, **kwargs: Any) -> Any

Execute a raw database command.

This method provides a way to execute native database commands when ORM abstractions are insufficient or when optimization requires direct database access.

Parameters:

Name Type Description Default
*args Any

Positional arguments for the database command.

 ()
**kwargs Any

Database-specific command parameters.

 {}

Returns:

Type Description
Any

Database-specific result object.

Raises:

Type Description
RuntimeError

If the execution fails.
Note

The exact signature and return type will vary by database implementation. Refer to specific database class documentation for details.

Source code in audex/lib/database/__init__.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
@abc.abstractmethod
async def exec(self, *args: t.Any, **kwargs: t.Any) -> t.Any:
    """Execute a raw database command.

    This method provides a way to execute native database commands
    when ORM abstractions are insufficient or when optimization
    requires direct database access.

    Args:
        *args: Positional arguments for the database command.
        **kwargs: Database-specific command parameters.

    Returns:
        Database-specific result object.

    Raises:
        RuntimeError: If the execution fails.

    Note:
        The exact signature and return type will vary by database
        implementation. Refer to specific database class documentation
        for details.
    """
    pass

options: show_root_heading: true show_source: true heading_level: 2 members_order: source show_signature_annotations: true separate_signature: true