Skip to content

boost_library_docs_tracker.md

Latest commit

 

History

History
39 lines (26 loc) · 3.58 KB

boost_library_docs_tracker.md

File metadata and controls

39 lines (26 loc) · 3.58 KB

boost_library_docs_tracker.services

Module path: boost_library_docs_tracker.services Description: Boost library docs content storage and (library-version, page) relation tracking with scrape/sync status. Single place for all writes to boost_library_docs_tracker models.

Type notation: BoostDocContent and BoostLibraryDocumentation are from boost_library_docs_tracker.models. BoostLibraryVersion is from boost_library_tracker.models (read-only cross-app reference).

Pinecone upsert state is stored on BoostDocContent.is_upserted, not on BoostLibraryDocumentation (the join table has only the two FKs plus created_at).

BoostDocContent

Function Parameter types Return type Notes
get_or_create_doc_content url: str, content_hash: str, version_id: int | None = None tuple[BoostDocContent, str] See return values below. ValueError if url is empty.
set_doc_content_upserted doc: BoostDocContent, value: bool BoostDocContent Sets is_upserted.
set_doc_content_upserted_by_ids ids: list[int], value: bool int Bulk UPDATE; returns number of rows updated.
get_unupserted_doc_contents — QuerySet[BoostDocContent] is_upserted=False; used for Pinecone sync worklists.

get_or_create_doc_content return values

The second element is a str indicating what changed:

change_type Condition Side effects
"created" content_hash not in DB Inserts row with url, content_hash, scraped_at=now(), is_upserted=False. May set first_version_id / last_version_id when version_id is passed.
"unchanged" content_hash already exists Updates scraped_at, and may update url and version FKs; same hash identity.

BoostLibraryDocumentation

Join table: one row per (boost_library_version, boost_doc_content) pair. No page_count, status fields, or updated_at on the model.

Function Parameter types Return type Notes
link_content_to_library_version library_version_id: int, doc_content_id: int tuple[BoostLibraryDocumentation, bool] get_or_create on the pair. Second value is created.
get_docs_for_library_version library_version_id: int QuerySet[BoostLibraryDocumentation] All join rows for that library version.