Skip to content

Database

Database module.

create_tables()

Create tables.

Example 
from sqlalchemy import create_engine

from devpipe.database import set_engine, create_tables

engine = create_engine("sqlite:///devpipe.db")
set_engine(engine)
create_tables()
Source code in devpipe/database.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def create_tables() -> None:
    """Create tables.

    Example:
        ```python
        from sqlalchemy import create_engine

        from devpipe.database import set_engine, create_tables

        engine = create_engine("sqlite:///devpipe.db")
        set_engine(engine)
        create_tables()
        ```
    """
    from .models.base import BaseSQLModel

    BaseSQLModel.metadata.create_all(_get_engine())

drop_tables()

Drop tables.

Example 
from sqlalchemy import create_engine

from devpipe.database import set_engine, drop_tables

engine = create_engine("sqlite:///devpipe.db")
set_engine(engine)
drop_tables()
Source code in devpipe/database.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def drop_tables() -> None:
    """Drop tables.

    Example:
        ```python
        from sqlalchemy import create_engine

        from devpipe.database import set_engine, drop_tables

        engine = create_engine("sqlite:///devpipe.db")
        set_engine(engine)
        drop_tables()
        ```
    """
    from .models.base import BaseSQLModel

    BaseSQLModel.metadata.drop_all(_get_engine())

set_engine(engine=None)

Set engine.

Parameters:

Name Type Description Default
engine Optional[Engine]

SQLALchemy engine.

 None

Returns:

Type Description
Engine

SQLALchemy engine.
Example 
from sqlalchemy import create_engine

import devpipe as dp
from devpipe.database import set_engine

engine = create_engine("sqlite:///devpipe.db")
set_engine(engine)

@dp.pipeline
def my_pipeline():
    ...
Source code in devpipe/database.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def set_engine(engine: Optional[Engine] = None) -> Engine:
    """Set engine.

    Args:
        engine (Optional[Engine], optional): SQLALchemy engine.

    Returns:
        SQLALchemy engine.

    Example:
        ```python
        from sqlalchemy import create_engine

        import devpipe as dp
        from devpipe.database import set_engine

        engine = create_engine("sqlite:///devpipe.db")
        set_engine(engine)

        @dp.pipeline
        def my_pipeline():
            ...
        ```
    """
    if engine is None:
        engine = create_engine(CONFIG.database_url)
    DEVPIPE["engine"] = engine
    logger.debug(f"Engine set with driver `{engine.driver}`.")
    return DEVPIPE["engine"]