Skip to content

prefect.server.models.saved_searches

Functions for interacting with saved search ORM objects. Intended for internal use by the Prefect REST API.

Upserts a SavedSearch.

If a SavedSearch with the same name exists, all properties will be updated.

Parameters:

Name Type Description Default
session Session

a database session

required
saved_search SavedSearch

a SavedSearch model

required

Returns:

Type Description

db.SavedSearch: the newly-created or updated SavedSearch

Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.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
45
46
47
48
49
50
51
52
53
54
55
56
57
@inject_db
async def create_saved_search(
    session: sa.orm.Session,
    saved_search: schemas.core.SavedSearch,
    db: PrefectDBInterface,
):
    """
    Upserts a SavedSearch.

    If a SavedSearch with the same name exists, all properties will be updated.

    Args:
        session (sa.orm.Session): a database session
        saved_search (schemas.core.SavedSearch): a SavedSearch model

    Returns:
        db.SavedSearch: the newly-created or updated SavedSearch

    """

    insert_stmt = (
        (await db.insert(db.SavedSearch))
        .values(**saved_search.dict(shallow=True, exclude_unset=True))
        .on_conflict_do_update(
            index_elements=db.saved_search_unique_upsert_columns,
            set_=saved_search.dict(shallow=True, include={"filters"}),
        )
    )

    await session.execute(insert_stmt)

    query = (
        sa.select(db.SavedSearch)
        .where(
            db.SavedSearch.name == saved_search.name,
        )
        .execution_options(populate_existing=True)
    )
    result = await session.execute(query)
    model = result.scalar()

    return model

Delete a SavedSearch by id.

Parameters:

Name Type Description Default
session Session

A database session

required
saved_search_id str

a SavedSearch id

required

Returns:

Name Type Description
bool bool

whether or not the SavedSearch was deleted

Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.py
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
@inject_db
async def delete_saved_search(
    session: sa.orm.Session, saved_search_id: UUID, db: PrefectDBInterface
) -> bool:
    """
    Delete a SavedSearch by id.

    Args:
        session (sa.orm.Session): A database session
        saved_search_id (str): a SavedSearch id

    Returns:
        bool: whether or not the SavedSearch was deleted
    """

    result = await session.execute(
        delete(db.SavedSearch).where(db.SavedSearch.id == saved_search_id)
    )
    return result.rowcount > 0

Reads a SavedSearch by id.

Parameters:

Name Type Description Default
session Session

A database session

required
saved_search_id str

a SavedSearch id

required

Returns:

Type Description

db.SavedSearch: the SavedSearch

Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.py
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@inject_db
async def read_saved_search(
    session: sa.orm.Session, saved_search_id: UUID, db: PrefectDBInterface
):
    """
    Reads a SavedSearch by id.

    Args:
        session (sa.orm.Session): A database session
        saved_search_id (str): a SavedSearch id

    Returns:
        db.SavedSearch: the SavedSearch
    """

    return await session.get(db.SavedSearch, saved_search_id)

read_saved_search_by_name async

Reads a SavedSearch by name.

Parameters:

Name Type Description Default
session Session

A database session

required
name str

a SavedSearch name

required

Returns:

Type Description

db.SavedSearch: the SavedSearch

Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.py
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@inject_db
async def read_saved_search_by_name(
    session: sa.orm.Session, name: str, db: PrefectDBInterface
):
    """
    Reads a SavedSearch by name.

    Args:
        session (sa.orm.Session): A database session
        name (str): a SavedSearch name

    Returns:
        db.SavedSearch: the SavedSearch
    """
    result = await session.execute(
        select(db.SavedSearch).where(db.SavedSearch.name == name).limit(1)
    )
    return result.scalar()

read_saved_searches async

Read SavedSearches.

Parameters:

Name Type Description Default
session Session

A database session

required
offset int

Query offset

None
limit(int)

Query limit

required

Returns:

Type Description

List[db.SavedSearch]: SavedSearches

Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/models/saved_searches.py
 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
@inject_db
async def read_saved_searches(
    db: PrefectDBInterface,
    session: sa.orm.Session,
    offset: int = None,
    limit: int = None,
):
    """
    Read SavedSearches.

    Args:
        session (sa.orm.Session): A database session
        offset (int): Query offset
        limit(int): Query limit

    Returns:
        List[db.SavedSearch]: SavedSearches
    """

    query = select(db.SavedSearch).order_by(db.SavedSearch.name)

    if offset is not None:
        query = query.offset(offset)
    if limit is not None:
        query = query.limit(limit)

    result = await session.execute(query)
    return result.scalars().unique().all()