graflo.architecture.backend.index

Manifest model for on-disk GraFlo backend directories.

Classes

CollectionEntry

Bases: ConfigBaseModel

Inventory for one vertex type or edge collection on disk.

Source code in graflo/architecture/backend/index.py

class CollectionEntry(ConfigBaseModel):
    """Inventory for one vertex type or edge collection on disk."""

    chunks: list[str] = Field(
        default_factory=list,
        description="Relative paths to gzip JSONL chunk files.",
    )
    record_count: int = Field(default=0, ge=0)

Attributes

chunks = Field(default_factory=list, description='Relative paths to gzip JSONL chunk files.') class-attribute instance-attribute

record_count = Field(default=0, ge=0) class-attribute instance-attribute

GraFloIndex

Bases: ConfigBaseModel

Self-describing manifest for a GraFlo file backend directory.

Source code in graflo/architecture/backend/index.py

class GraFloIndex(ConfigBaseModel):
    """Self-describing manifest for a GraFlo file backend directory."""

    graflo_version: str = Field(
        ..., description="GraFlo package version at export time."
    )
    created_at: str = Field(
        default_factory=lambda: datetime.now(UTC).isoformat(),
        description="UTC timestamp when the export was finalized.",
    )
    schema_hash: str = Field(
        ..., description="Stable hash of the stored schema document."
    )
    vertices: dict[str, CollectionEntry] = Field(default_factory=dict)
    edges: dict[str, CollectionEntry] = Field(default_factory=dict)

Attributes

created_at = Field(default_factory=lambda: datetime.now(UTC).isoformat(), description='UTC timestamp when the export was finalized.') class-attribute instance-attribute

edges = Field(default_factory=dict) class-attribute instance-attribute

graflo_version = Field(..., description='GraFlo package version at export time.') class-attribute instance-attribute

schema_hash = Field(..., description='Stable hash of the stored schema document.') class-attribute instance-attribute

vertices = Field(default_factory=dict) class-attribute instance-attribute

Functions:

backend_schema_hash(schema)

Stable hash over schema deployment contract (graph + DB profile).

Source code in graflo/architecture/backend/index.py

def backend_schema_hash(schema: Schema) -> str:
    """Stable hash over schema deployment contract (graph + DB profile)."""
    payload = {
        "core_schema": schema.core_schema.to_minimal_canonical_dict(),
        "db_profile": schema.db_profile.to_minimal_canonical_dict(),
    }
    return suthing.stable_hash(payload)