Skip to content

cayu.storage.knowledge_transition

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

from cayu.storage import assess_knowledge_revision_transition

Classify a complete, backend-owned legacy knowledge population inspection.

Each backend migration supplies its exact legacy table set. Requiring an exact match prevents an omitted table from silently turning an incomplete inspection into approval.

assess_knowledge_revision_transition(row_counts: Mapping[str, int], *, required_tables: Iterable[str]) -> KnowledgeRevisionTransitionAssessment

Release source · Runtime guarantees · Capability guides

from cayu.storage import KNOWLEDGE_REVISION_RESET_POLICY_VERSION
KNOWLEDGE_REVISION_RESET_POLICY_VERSION = 'cayu.knowledge_revision_reset.v1'

Release source · Runtime guarantees · Capability guides

from cayu.storage import KnowledgeRevisionResetRequired

A populated mutable-knowledge database cannot be upgraded in place.

Bases: RuntimeError.

KnowledgeRevisionResetRequired.__init__(assessment: KnowledgeRevisionTransitionAssessment) -> None

Release source · Runtime guarantees · Capability guides

from cayu.storage import KnowledgeRevisionTransitionAction

Bases: StrEnum.

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
INITIALIZE class attribute 'initialize'
REFUSE_RESET_REQUIRED class attribute 'refuse_reset_required'

Release source · Runtime guarantees · Capability guides

from cayu.storage import KnowledgeRevisionTransitionAssessment

Content-free evidence for the clean revision-schema transition decision.

Bases: BaseModel.

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
policy_version Literal['cayu.knowledge_revision_reset.v1'] KNOWLEDGE_REVISION_RESET_POLICY_VERSION
inspected_tables tuple[str, ...] required
populated_tables tuple[str, ...] required
action KnowledgeRevisionTransitionAction required
KnowledgeRevisionTransitionAssessment.validate_tables(value, info) -> tuple[str, ...]
KnowledgeRevisionTransitionAssessment.validate_decision() -> KnowledgeRevisionTransitionAssessment

Release source · Runtime guarantees · Capability guides

require_empty_knowledge_revision_transition

Section titled “require_empty_knowledge_revision_transition”
from cayu.storage import require_empty_knowledge_revision_transition

Allow fresh/empty initialization and fail closed for populated legacy data.

require_empty_knowledge_revision_transition(row_counts: Mapping[str, int], *, required_tables: Iterable[str]) -> KnowledgeRevisionTransitionAssessment

Release source · Runtime guarantees · Capability guides