graflo.architecture.evolution.aspects.sync

The sync aspect: a record's sync hash on the vertex types it owns.

The lift adds one reserved field, sync_hash, set_by: sync, to each type a resource's sync block owns. A bulk load and a sync run write it; an upsert sets it to null, so the next sync rewrites the record.

Modules:

Name	Description
plan	Planning the sync aspect: a reserved sync_hash field on every owned type.

Attributes

SYNC_HASH = 'sync_hash' module-attribute

__all__ = ['SYNC_HASH', 'plan_sync', 'sync_field'] module-attribute

Functions:

plan_sync(manifest)

The ops that give every type a resource owns a sync_hash.

Raises:

Type	Description
LiftError	no schema, or no resource declares a sync block.

Source code in graflo/architecture/evolution/aspects/sync/plan.py

def plan_sync(manifest: GraphManifest) -> list[ManifestOp]:
    """The ops that give every type a resource owns a ``sync_hash``.

    Raises:
        LiftError: no schema, or no resource declares a ``sync`` block.
    """
    if manifest.graph_schema is None:
        raise LiftError("cannot lift a manifest with no schema block")
    model = manifest.ingestion_model
    owned = sorted(
        {r.sync.owns for r in (model.resources if model else []) if r.sync is not None}
    )
    if not owned:
        raise LiftError(
            "the sync aspect labels the types a resource's sync block owns; "
            "no resource declares one"
        )
    return join(
        manifest.graph_schema.core_schema,
        vertex_fields={name: [sync_field()] for name in owned},
    )

sync_field()

sync_hash: a reserved digest of what the owner record wrote.

Source code in graflo/architecture/evolution/aspects/sync/plan.py

def sync_field() -> Field:
    """``sync_hash``: a reserved digest of what the owner record wrote."""
    return Field(
        name=SYNC_HASH,
        type=FieldType.STRING,
        reserved=True,
        set_by="sync",
        description=(
            "Digest of what the owner record wrote: the vertex's properties and "
            "its owned edges. Set by a bulk or sync write; null after an upsert."
        ),
    )