cayu.storage.collaboration_postgres
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.
PostgresCollaborationStore
Section titled “PostgresCollaborationStore”from cayu.collaboration import PostgresCollaborationStoreBases: _PostgresStoreBase, CollaborationStore.
Fields and attributes
Section titled “Fields and attributes”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 |
|---|---|---|
request_contract_version |
class attribute |
2 |
planning_contract_version |
class attribute |
1 |
init (method)
Section titled “init (method)”PostgresCollaborationStore.__init__(*args, **kwargs) -> Noneensure_schema (method)
Section titled “ensure_schema (method)”async PostgresCollaborationStore.ensure_schema() -> NoneOpen the pool and reconcile the schema now (per schema_mode).
Normally reconciliation happens lazily on first use; the cayu storage
CLI calls this to run a migrate (or validate) as an explicit step.
close (method)
Section titled “close (method)”async PostgresCollaborationStore.close() -> Nonecapabilities (method)
Section titled “capabilities (method)”PostgresCollaborationStore.capabilities(owner: OwnerRef) -> CapabilityDescriptorinitialize (method)
Section titled “initialize (method)”async PostgresCollaborationStore.initialize(binding: CollaborationBootstrap, *, redactor: SecretRedactor) -> CollaborationInitializationregister_wait (method)
Section titled “register_wait (method)”async PostgresCollaborationStore.register_wait(initialized, wait, *, redactor: SecretRedactor)load_wait (method)
Section titled “load_wait (method)”async PostgresCollaborationStore.load_wait(initialized, wait, *, redactor: SecretRedactor, wait_for_settlement=False)record_wait_evidence (method)
Section titled “record_wait_evidence (method)”async PostgresCollaborationStore.record_wait_evidence(initialized, wait, evidence, *, redactor: SecretRedactor, wait_for_settlement=False)release_wait_sources (method)
Section titled “release_wait_sources (method)”async PostgresCollaborationStore.release_wait_sources(initialized, wait, *, redactor: SecretRedactor, wait_for_settlement=False)record_wait_delivery (method)
Section titled “record_wait_delivery (method)”async PostgresCollaborationStore.record_wait_delivery(initialized, wait, *, receipt_digest: str, delivery: Literal['accepted', 'excluded']='accepted', redactor: SecretRedactor, wait_for_settlement=False)cancel_wait (method)
Section titled “cancel_wait (method)”async PostgresCollaborationStore.cancel_wait(initialized, wait, *, expired: bool, redactor: SecretRedactor)lookup (method)
Section titled “lookup (method)”async PostgresCollaborationStore.lookup(initialized: CollaborationInitialization, expected: ExpectedOperation[ParticipantIntent], *, redactor: SecretRedactor) -> ExactLookup[ParticipantReceipt]apply (method)
Section titled “apply (method)”async PostgresCollaborationStore.apply(initialized: CollaborationInitialization, expected: ExpectedOperation[ParticipantIntent], *, redactor: SecretRedactor) -> ParticipantReceiptinspect_namespace (method)
Section titled “inspect_namespace (method)”async PostgresCollaborationStore.inspect_namespace(initialized: CollaborationInitialization, *, redactor: SecretRedactor) -> NamespaceInspectioninspect_retirement (method)
Section titled “inspect_retirement (method)”async PostgresCollaborationStore.inspect_retirement(initialized: CollaborationInitialization, namespace: NamespaceRef, *, redactor: SecretRedactor) -> NamespaceRetirementEvidence | Nonescan_obligations (method)
Section titled “scan_obligations (method)”async PostgresCollaborationStore.scan_obligations(initialized: CollaborationInitialization, participant: ParticipantRef, *, after: int, limit: int, pending_only: bool, retention_revision: int | None, redactor: SecretRedactor) -> tuple[int, tuple[ParticipantObligation, ...]]apply_lifecycle (method)
Section titled “apply_lifecycle (method)”async PostgresCollaborationStore.apply_lifecycle(initialized: CollaborationInitialization, expected: LifecycleCommand, *, redactor: SecretRedactor) -> LifecycleReceiptlookup_lifecycle (method)
Section titled “lookup_lifecycle (method)”async PostgresCollaborationStore.lookup_lifecycle(initialized: CollaborationInitialization, expected: LifecycleCommand, *, redactor: SecretRedactor) -> ExactLookup[LifecycleReceipt]inspect (method)
Section titled “inspect (method)”async PostgresCollaborationStore.inspect(initialized: CollaborationInitialization, participant: ParticipantRef, *, redactor: SecretRedactor) -> ParticipantInspectionresolve_alias (method)
Section titled “resolve_alias (method)”async PostgresCollaborationStore.resolve_alias(initialized: CollaborationInitialization, alias: str, *, redactor: SecretRedactor) -> ParticipantAlias | Nonescan (method)
Section titled “scan (method)”async PostgresCollaborationStore.scan(initialized: CollaborationInitialization, *, table: Literal['participants', 'events'], after: str | int, limit: int, allowed: tuple[ParticipantRef, ...] | None, redactor: SecretRedactor) -> tuple[ParticipantSnapshot | ParticipantEvent, ...]scan_events (method)
Section titled “scan_events (method)”async PostgresCollaborationStore.scan_events(initialized: CollaborationInitialization, *, after: int, limit: int, allowed: tuple[ParticipantRef, ...] | None, retention_revision: int | None, redactor: SecretRedactor) -> tuple[int, tuple[ParticipantEvent, ...]]