`prefect.server.models.block_documents`

Functions for interacting with block document ORM objects. Intended for internal use by the Prefect REST API.

Functions

`emit_block_document_created_event`

emit_block_document_created_event(block_document: BlockDocument) -> None

Emit an event when a (non-anonymous) block document is created.

`emit_block_document_updated_event`

emit_block_document_updated_event(block_document: BlockDocument) -> None

Emit an event when a (non-anonymous) block document is updated.

`emit_block_document_deleted_event`

emit_block_document_deleted_event(block_document: BlockDocument) -> None

Emit an event when a (non-anonymous) block document is deleted.

`create_block_document`

create_block_document(db: PrefectDBInterface, session: AsyncSession, block_document: schemas.actions.BlockDocumentCreate) -> BlockDocument

`block_document_with_unique_values_exists`

block_document_with_unique_values_exists(db: PrefectDBInterface, session: AsyncSession, block_type_id: UUID, name: str) -> bool

`read_block_document_by_id`

read_block_document_by_id(session: AsyncSession, block_document_id: UUID, include_secrets: bool = False) -> Union[BlockDocument, None]

`read_block_document_by_name`

read_block_document_by_name(session: AsyncSession, name: str, block_type_slug: str, include_secrets: bool = False) -> Union[BlockDocument, None]

Read a block document with the given name and block type slug.

`read_block_documents`

read_block_documents(db: PrefectDBInterface, session: AsyncSession, block_document_filter: Optional[schemas.filters.BlockDocumentFilter] = None, block_type_filter: Optional[schemas.filters.BlockTypeFilter] = None, block_schema_filter: Optional[schemas.filters.BlockSchemaFilter] = None, include_secrets: bool = False, sort: schemas.sorting.BlockDocumentSort = schemas.sorting.BlockDocumentSort.NAME_ASC, offset: Optional[int] = None, limit: Optional[int] = None) -> List[BlockDocument]

Read block documents with an optional limit and offset

`count_block_documents`

count_block_documents(db: PrefectDBInterface, session: AsyncSession, block_document_filter: Optional[schemas.filters.BlockDocumentFilter] = None, block_type_filter: Optional[schemas.filters.BlockTypeFilter] = None, block_schema_filter: Optional[schemas.filters.BlockSchemaFilter] = None) -> int

Count block documents that match the filters.

`delete_block_document`

delete_block_document(db: PrefectDBInterface, session: AsyncSession, block_document_id: UUID) -> bool

`update_block_document`

update_block_document(db: PrefectDBInterface, session: AsyncSession, block_document_id: UUID, block_document: schemas.actions.BlockDocumentUpdate) -> bool

`create_block_document_reference`

create_block_document_reference(db: PrefectDBInterface, session: AsyncSession, block_document_reference: schemas.actions.BlockDocumentReferenceCreate) -> Union[orm_models.BlockDocumentReference, None]

`delete_block_document_reference`

delete_block_document_reference(db: PrefectDBInterface, session: AsyncSession, block_document_reference_id: UUID) -> bool

​prefect.server.models.block_documents

​Functions

​emit_block_document_created_event

​emit_block_document_updated_event

​emit_block_document_deleted_event

​create_block_document

​block_document_with_unique_values_exists

​read_block_document_by_id

​read_block_document_by_name

​read_block_documents

​count_block_documents

​delete_block_document

​update_block_document

​create_block_document_reference

​delete_block_document_reference