Skip to content

prefect.orion.models.saved_searches

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

Upserts a SavedSearch.

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

Parameters:

Name Description Default
session

a database session

sa.orm.Session
required
saved_search

a SavedSearch model

schemas.core.SavedSearch
required

Returns:

Type Description
db.SavedSearch

the newly-created or updated SavedSearch

Source code in prefect/orion/models/saved_searches.py
@inject_db
async def create_saved_search(
    session: sa.orm.Session,
    saved_search: schemas.core.SavedSearch,
    db: OrionDBInterface,
):
    """
    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 Description Default
session

A database session

sa.orm.Session
required
saved_search_id

a SavedSearch id

str
required

Returns:

Type Description
bool

whether or not the SavedSearch was deleted

Source code in prefect/orion/models/saved_searches.py
@inject_db
async def delete_saved_search(
    session: sa.orm.Session, saved_search_id: UUID, db: OrionDBInterface
) -> 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 Description Default
session

A database session

sa.orm.Session
required
saved_search_id

a SavedSearch id

str
required

Returns:

Type Description
db.SavedSearch

the SavedSearch

Source code in prefect/orion/models/saved_searches.py
@inject_db
async def read_saved_search(
    session: sa.orm.Session, saved_search_id: UUID, db: OrionDBInterface
):
    """
    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 Description Default
session

A database session

sa.orm.Session
required
name

a SavedSearch name

str
required

Returns:

Type Description
db.SavedSearch

the SavedSearch

Source code in prefect/orion/models/saved_searches.py
@inject_db
async def read_saved_search_by_name(
    session: sa.orm.Session, name: str, db: OrionDBInterface
):
    """
    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 Description Default
session

A database session

sa.orm.Session
required
offset

Query offset

int
None
limit(int)

Query limit

required

Returns:

Type Description
List[db.SavedSearch]

SavedSearches

Source code in prefect/orion/models/saved_searches.py
@inject_db
async def read_saved_searches(
    db: OrionDBInterface,
    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()