> ## Documentation Index > Fetch the complete documentation index at: https://docs.prefect.io/llms.txt > Use this file to discover all available pages before exploring further. # block_documents # `prefect.server.models.block_documents` Functions for interacting with block document ORM objects. Intended for internal use by the Prefect REST API. ## Functions ### `create_block_document` ```python theme={null} create_block_document(db: PrefectDBInterface, session: AsyncSession, block_document: schemas.actions.BlockDocumentCreate) -> BlockDocument ``` ### `block_document_with_unique_values_exists` ```python theme={null} block_document_with_unique_values_exists(db: PrefectDBInterface, session: AsyncSession, block_type_id: UUID, name: str) -> bool ``` ### `read_block_document_by_id` ```python theme={null} read_block_document_by_id(session: AsyncSession, block_document_id: UUID, include_secrets: bool = False) -> Union[BlockDocument, None] ``` ### `read_block_document_by_name` ```python theme={null} 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` ```python theme={null} 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` ```python theme={null} 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` ```python theme={null} delete_block_document(db: PrefectDBInterface, session: AsyncSession, block_document_id: UUID) -> bool ``` ### `update_block_document` ```python theme={null} update_block_document(db: PrefectDBInterface, session: AsyncSession, block_document_id: UUID, block_document: schemas.actions.BlockDocumentUpdate) -> bool ``` ### `create_block_document_reference` ```python theme={null} create_block_document_reference(db: PrefectDBInterface, session: AsyncSession, block_document_reference: schemas.actions.BlockDocumentReferenceCreate) -> Union[orm_models.BlockDocumentReference, None] ``` ### `delete_block_document_reference` ```python theme={null} delete_block_document_reference(db: PrefectDBInterface, session: AsyncSession, block_document_reference_id: UUID) -> bool ```