Skip to content

Routing

plateforme.core.database.routing

This module defines the DatabaseRouter abstract class for controlling database operations in a multi-database environment scenario within the Plateforme framework.

It provides methods to determine the appropriate database for read and write operations, and to assess if a migration operation should be executed on a specific database.

DatabaseRouter

Bases: ABC

Database engine router for controlling database operations.

A database engine router abstract class to control database operations on models within a multi-database setup.

Note

This class should be used as an interface for database engine routing operations within the Plateforme framework.

get_engine 

get_engine(
    resource: type[Any] | None = None, **kwargs: Any
) -> str | None

Give a suggestion for the standard engine to use.

Suggest the standard engine that should be used for read and write operations on a given resource clase.

Parameters:

Name Type Description Default
resource type[Any] | None

The resource class.

 None
kwargs Any

Additional information to assist in selecting an engine.

 {}

Returns:

Type Description
str | None

An engine alias if a suggestion is made, else None.
Source code in .venv/lib/python3.12/site-packages/plateforme/core/database/routing.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def get_engine(
    self, resource: type[Any] | None = None, **kwargs: Any
) -> str | None:
    """Give a suggestion for the standard engine to use.

    Suggest the standard engine that should be used for read and write
    operations on a given resource clase.

    Args:
        resource: The resource class.
        kwargs: Additional information to assist in selecting an engine.

    Returns:
        An engine alias if a suggestion is made, else ``None``.
    """
    # Implement custom logic to decide which engine to use for read and
    # write operations...
    return None

get_read_engine 

get_read_engine(
    resource: type[Any] | None = None, **kwargs: Any
) -> str | None

Give a suggestion for the engine to use for read operations.

Suggest the engine that should be used for read operations on a given resource clase.

Parameters:

Name Type Description Default
resource type[Any] | None

The resource class.

 None
kwargs Any

Additional information to assist in selecting an engine.

 {}

Returns:

Type Description
str | None

An engine alias if a suggestion is made, else None.
Source code in .venv/lib/python3.12/site-packages/plateforme/core/database/routing.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def get_read_engine(
    self, resource: type[Any] | None = None, **kwargs: Any
) -> str | None:
    """Give a suggestion for the engine to use for read operations.

    Suggest the engine that should be used for read operations on a
    given resource clase.

    Args:
        resource: The resource class.
        kwargs: Additional information to assist in selecting an engine.

    Returns:
        An engine alias if a suggestion is made, else ``None``.
    """
    # Implement custom logic to decide which engine to use for read
    # operations...
    return None

get_write_engine 

get_write_engine(
    resource: type[Any] | None = None, **kwargs: Any
) -> str | None

Give a suggestion for the engine to use for write operations.

Suggest the engine that should be used for write operations on a given resource clase.

Parameters:

Name Type Description Default
resource type[Any] | None

The resource class.

 None
kwargs Any

Additional information to assist in selecting an engine.

 {}

Returns:

Type Description
str | None

An engine alias if a suggestion is made, else None.
Source code in .venv/lib/python3.12/site-packages/plateforme/core/database/routing.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def get_write_engine(
    self, resource: type[Any] | None = None, **kwargs: Any
) -> str | None:
    """Give a suggestion for the engine to use for write operations.

    Suggest the engine that should be used for write operations on a
    given resource clase.

    Args:
        resource: The resource class.
        kwargs: Additional information to assist in selecting an engine.

    Returns:
        An engine alias if a suggestion is made, else ``None``.
    """
    # Implement custom logic to decide which engine to use for write
    # operations...
    return None

is_migration_allowed 

is_migration_allowed(
    engine: str, package: str, **kwargs: Any
) -> bool | None

Flag whether a migration operation is allowed to run.

Determine if the migration operation is allowed to run on the specified database engine alias.

Parameters:

Name Type Description Default
engine str

The database engine alias.

 required
package str

The name of the package being migrated.

 required
kwargs Any

Additional information to assist in making a decision.

 {}

Returns:

Type Description
bool | None

True if operation should run, False if not, None if no
bool | None

opinion.
Source code in .venv/lib/python3.12/site-packages/plateforme/core/database/routing.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
def is_migration_allowed(
    self,
    engine: str,
    package: str,
    **kwargs: Any,
) -> bool | None:
    """Flag whether a migration operation is allowed to run.

    Determine if the migration operation is allowed to run on the specified
    database engine alias.

    Args:
        engine: The database engine alias.
        package: The name of the package being migrated.
        kwargs: Additional information to assist in making a decision.

    Returns:
        ``True`` if operation should run, ``False`` if not, ``None`` if no
        opinion.
    """
    # Implement custom logic to determine if a migration operation should
    # run on a given database engine...
    return None