Skip to content

graflo.hq.sanitizer

Sanitization entry point for schema and ingestion contracts.

:class:Sanitizer is the public, stand-alone, DB-flavor-aware orchestrator that encodes the policy "sanitize this manifest for a given target DB flavor".

Sanitizing records physical names in schema.db_profile -- storage and relation names, and vertex/edge property names the flavor cannot store. The logical schema and the ingestion model are never rewritten, so documents keep their logical keys and the writer translates them at the database call.

It owns no mutation logic of its own. Instead, it builds a list of :mod:graflo.architecture.evolution ops and applies them to the manifest in place, preserving the long-standing :meth:Sanitizer.sanitize_manifest API for callers that prefer a one-liner over assembling ops by hand.

Examples

Sanitize an inferred manifest a posteriori for TigerGraph::

from graflo.hq.sanitizer import Sanitizer
from graflo.onto import DBType

Sanitizer(DBType.TIGERGRAPH).sanitize_manifest(manifest)

Equivalent low-level call (skip the policy layer)::

from graflo.architecture.evolution import SanitizeOp, apply_sanitize

apply_sanitize(manifest, SanitizeOp(db_flavor=DBType.TIGERGRAPH))

Attributes

logger = logging.getLogger(__name__) module-attribute

Classes

Sanitizer

DB-flavor-aware orchestrator for manifest sanitization.

The class encodes the per-flavor policy ("which evolution ops sanitize a manifest for db_flavor") and applies them in place. Callers that want a different sanitization recipe can either subclass and override :meth:build_ops or build ops directly via :mod:graflo.architecture.evolution.

Source code in graflo/hq/sanitizer.py 
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
class Sanitizer:
    """DB-flavor-aware orchestrator for manifest sanitization.

    The class encodes the per-flavor policy ("which evolution ops sanitize a
    manifest for *db_flavor*") and applies them in place. Callers that want a
    different sanitization recipe can either subclass and override
    :meth:`build_ops` or build ops directly via
    :mod:`graflo.architecture.evolution`.
    """

    def __init__(
        self, db_flavor: DBType, *, reserved_words: Iterable[str] | None = None
    ):
        """Initialize the sanitizer for a given target DB flavor.

        Args:
            db_flavor: Target database flavor.
            reserved_words: Override for the flavor's reserved words; by default
                they are loaded for *db_flavor*.
        """
        self.db_flavor = db_flavor
        self.reserved_words = (
            list(reserved_words) if reserved_words is not None else None
        )

    def build_ops(self, manifest: GraphManifest) -> list[ManifestOp]:
        """Return the ordered list of evolution ops that sanitize *manifest*.

        Today the list collapses to ``[SanitizeOp(db_flavor=...)]``; exposing
        it as a list keeps the door open for per-flavor composition.
        """
        del manifest  # currently policy is purely a function of db_flavor
        return [
            SanitizeOp(db_flavor=self.db_flavor, reserved_words=self.reserved_words)
        ]

    def sanitize_manifest(self, manifest: GraphManifest) -> GraphManifest:
        """Mutate *manifest* in place per :meth:`build_ops` and return it.

        Also sets ``db_profile.db_flavor`` to the target flavor, since the
        names recorded are that flavor's.

        Returns the same manifest object so callers can chain or simply assert
        that the in-place result is the original input.
        """
        if manifest.graph_schema is None:
            return manifest

        manifest.graph_schema.db_profile.db_flavor = self.db_flavor
        apply_manifest_ops_inplace(manifest, self.build_ops(manifest))

        manifest.finish_init()
        return manifest

Attributes

db_flavor = db_flavor instance-attribute
reserved_words = list(reserved_words) if reserved_words is not None else None instance-attribute

Methods:

__init__(db_flavor, *, reserved_words=None)

Initialize the sanitizer for a given target DB flavor.

Parameters:

Name Type Description Default
db_flavor DBType

Target database flavor.

 required
reserved_words Iterable[str] | None

Override for the flavor's reserved words; by default they are loaded for db_flavor.

 None
Source code in graflo/hq/sanitizer.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def __init__(
    self, db_flavor: DBType, *, reserved_words: Iterable[str] | None = None
):
    """Initialize the sanitizer for a given target DB flavor.

    Args:
        db_flavor: Target database flavor.
        reserved_words: Override for the flavor's reserved words; by default
            they are loaded for *db_flavor*.
    """
    self.db_flavor = db_flavor
    self.reserved_words = (
        list(reserved_words) if reserved_words is not None else None
    )
build_ops(manifest)

Return the ordered list of evolution ops that sanitize manifest.

Today the list collapses to [SanitizeOp(db_flavor=...)]; exposing it as a list keeps the door open for per-flavor composition.

Source code in graflo/hq/sanitizer.py 
74
75
76
77
78
79
80
81
82
83
def build_ops(self, manifest: GraphManifest) -> list[ManifestOp]:
    """Return the ordered list of evolution ops that sanitize *manifest*.

    Today the list collapses to ``[SanitizeOp(db_flavor=...)]``; exposing
    it as a list keeps the door open for per-flavor composition.
    """
    del manifest  # currently policy is purely a function of db_flavor
    return [
        SanitizeOp(db_flavor=self.db_flavor, reserved_words=self.reserved_words)
    ]
sanitize_manifest(manifest)

Mutate manifest in place per :meth:build_ops and return it.

Also sets db_profile.db_flavor to the target flavor, since the names recorded are that flavor's.

Returns the same manifest object so callers can chain or simply assert that the in-place result is the original input.

Source code in graflo/hq/sanitizer.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def sanitize_manifest(self, manifest: GraphManifest) -> GraphManifest:
    """Mutate *manifest* in place per :meth:`build_ops` and return it.

    Also sets ``db_profile.db_flavor`` to the target flavor, since the
    names recorded are that flavor's.

    Returns the same manifest object so callers can chain or simply assert
    that the in-place result is the original input.
    """
    if manifest.graph_schema is None:
        return manifest

    manifest.graph_schema.db_profile.db_flavor = self.db_flavor
    apply_manifest_ops_inplace(manifest, self.build_ops(manifest))

    manifest.finish_init()
    return manifest

Functions: