Skip to main content

prefect.server.models.saved_searches

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

Functions

Upserts a SavedSearch. If a SavedSearch with the same name exists, all properties will be updated. Args:
  • session: a database session
  • saved_search: a SavedSearch model
Returns:
  • orm_models.SavedSearch: the newly-created or updated SavedSearch
Reads a SavedSearch by id. Args:
  • session: A database session
  • saved_search_id: a SavedSearch id
Returns:
  • orm_models.SavedSearch: the SavedSearch

read_saved_search_by_name

Reads a SavedSearch by name. Args:
  • session: A database session
  • name: a SavedSearch name
Returns:
  • orm_models.SavedSearch: the SavedSearch

read_saved_searches

Read SavedSearches. Args:
  • session: A database session
  • offset: Query offset
  • limit: Query limit
Returns:
  • List[orm_models.SavedSearch]: SavedSearches
Delete a SavedSearch by id. Args:
  • session: A database session
  • saved_search_id: a SavedSearch id
Returns:
  • whether or not the SavedSearch was deleted