1 datasets.store_inventory

datasets.store_inventory

Explicit metadata-only discovery of root and rollout stores.

Snapshots describe recorded evidence and local availability, never content verification, corpus admission, or training compatibility. Refreshing scans configured roots again; writers and individual store readers retain authority.

1.1 Classes

Name Description
StoreInventory Derived metadata snapshot shared by command-line and app consumers.
StoreInventoryRequest Scan roots and retain explicitly registered paths even when missing.

1.1.1 StoreInventory

datasets.store_inventory.StoreInventory(
    scanned_at_utc,
    elapsed_seconds,
    roots,
    entries,
    failures,
)

Derived metadata snapshot shared by command-line and app consumers.

1.1.1.1 Attributes

Name Description
scanned_at_utc UTC timestamp at the start of this acquisition.
elapsed_seconds Wall time for discovery and metadata inspection; not generation runtime.
roots Requested discovery roots and their availability or scan errors.
entries One metadata row per physical store and kind; aliases remain references.
failures Unavailable roots or unreadable store metadata, without hiding other rows.

1.1.1.2 Methods

Name Description
to_jsonable Return a detached JSON projection, without promoting it to authority.
1.1.1.2.1 to_jsonable
datasets.store_inventory.StoreInventory.to_jsonable()

Return a detached JSON projection, without promoting it to authority.

1.1.2 StoreInventoryRequest

datasets.store_inventory.StoreInventoryRequest(
    roots=(),
    root_stores=(),
    rollout_stores=(),
)

Scan roots and retain explicitly registered paths even when missing.

roots enables recursive filename discovery only on an explicit refresh. Exact root/rollout paths avoid discovery and preserve unavailable references.

1.1.2.1 Attributes

Name Description
roots Directories whose store filenames are discovered recursively.
root_stores Known exact VIN paths, including aliases or unavailable stores.
rollout_stores Known exact rollout paths, including aliases or unavailable stores.

1.2 Functions

Name Description
indexed_rollout_store_state Observe indexed rollout locators without recursive discovery or array reads.
rebuild_store_availability_index Explicitly reconcile a derived promoted-rollout index and retain missing locators.
refresh_store_inventory Discover and inspect fresh metadata without loading numeric payloads.
register_published_rollout_store Add one sealed promoted locator after publication, with no tree scan.
store_availability_index_path Locate a disposable local publication index beside, outside, store payloads.

1.2.1 indexed_rollout_store_state

datasets.store_inventory.indexed_rollout_store_state(root)

Observe indexed rollout locators without recursive discovery or array reads.

None means no index exists and permits legacy discovery. An invalid index raises and requires explicit reconciliation. The returned identity includes each current bounded store fingerprint, so atomic replacement invalidates projections even when this disposable index has not yet been rebuilt. Missing or unsealed historical entries remain in the index’s metadata-only history. Readable historical stores remain visible to selectors without acquiring promotion authority; readers still own payload validation and scientific admission.

1.2.2 rebuild_store_availability_index

datasets.store_inventory.rebuild_store_availability_index(
    root,
    *,
    inventory=None,
)

Explicitly reconcile a derived promoted-rollout index and retain missing locators.

A local advisory lock serializes rebuilds and publication updates; it is not a distributed writer lock. Atomic replacement publishes a complete index. Corruption is repaired from exact metadata, without modifying any stores. Roots have no standard in-store seal and remain in the explicit inventory; controller root publication receipts are not inferred here.

1.2.3 refresh_store_inventory

datasets.store_inventory.refresh_store_inventory(request)

Discover and inspect fresh metadata without loading numeric payloads.

VIN index records and manifests are read through their domain formats; rollout inventory reads top-level metadata only, including recorded counts. Metadata decoding errors remain visible. Readable metadata does not prove payload availability, source binding correctness, or scientific eligibility.

1.2.4 register_published_rollout_store

datasets.store_inventory.register_published_rollout_store(root, store)

Add one sealed promoted locator after publication, with no tree scan.

This hook never seals, promotes, verifies payload bytes, or changes corpus membership. Call it only after the generation/transfer owner has published the store. Metadata admission is rechecked under a local index lock. No deleted store or missing locator is removed from the historical index.

1.2.5 store_availability_index_path

datasets.store_inventory.store_availability_index_path(root)

Locate a disposable local publication index beside, outside, store payloads.

Back to top