Skip to content

graflo.connections.graflo_backend

Configuration for GraFlo file backend connections.

Classes

GraFloBackendConfig

Bases: DBConfig

Configuration for a GraFlo on-disk graph backend directory.

Source code in graflo/connections/graflo_backend.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class GraFloBackendConfig(DBConfig):
    """Configuration for a GraFlo on-disk graph backend directory."""

    model_config = SettingsConfigDict(
        env_prefix="GRAFLO_BACKEND_",
        case_sensitive=False,
    )

    output_dir: Path = Field(
        ...,
        description="Root directory for schema, index, and chunked data files.",
    )
    chunk_size: int = Field(
        default=50_000,
        ge=1,
        description="Maximum records per gzip JSONL chunk file.",
    )
    target_flavor_hint: DBType | None = Field(
        default=None,
        description=(
            "When set, schema written to disk is sanitized for this target DB flavor."
        ),
    )

    def _get_default_port(self) -> int:
        return 0

    def _get_effective_database(self) -> str | None:
        return None

    def _get_effective_schema(self) -> str | None:
        return self.output_dir.name

    @classmethod
    def from_docker_env(
        cls, docker_dir: str | Path | None = None
    ) -> GraFloBackendConfig:
        raise NotImplementedError(
            "GraFlo file backend does not support from_docker_env; use output_dir instead."
        )

Attributes

chunk_size = Field(default=50000, ge=1, description='Maximum records per gzip JSONL chunk file.') class-attribute instance-attribute
model_config = SettingsConfigDict(env_prefix='GRAFLO_BACKEND_', case_sensitive=False) class-attribute instance-attribute
output_dir = Field(..., description='Root directory for schema, index, and chunked data files.') class-attribute instance-attribute
target_flavor_hint = Field(default=None, description='When set, schema written to disk is sanitized for this target DB flavor.') class-attribute instance-attribute

Methods:

from_docker_env(docker_dir=None) classmethod
Source code in graflo/connections/graflo_backend.py 
47
48
49
50
51
52
53
@classmethod
def from_docker_env(
    cls, docker_dir: str | Path | None = None
) -> GraFloBackendConfig:
    raise NotImplementedError(
        "GraFlo file backend does not support from_docker_env; use output_dir instead."
    )