Skip to content

gds_software.erd.elements

ERD element declarations -- frozen Pydantic models for user-facing declarations.

Bases: BaseModel

An entity in an ER diagram.

Maps to: GDS Entity with StateVariables for each attribute.

Source code in packages/gds-software/gds_software/erd/elements.py 
33
34
35
36
37
38
39
40
41
class ERDEntity(BaseModel, frozen=True):
    """An entity in an ER diagram.

    Maps to: GDS Entity with StateVariables for each attribute.
    """

    name: str
    attributes: list[Attribute] = Field(default_factory=list)
    description: str = ""

Bases: BaseModel

An attribute of an ERD entity.

Maps to: GDS StateVariable within an Entity.

Source code in packages/gds-software/gds_software/erd/elements.py 
20
21
22
23
24
25
26
27
28
29
30
class Attribute(BaseModel, frozen=True):
    """An attribute of an ERD entity.

    Maps to: GDS StateVariable within an Entity.
    """

    name: str
    type: str = "string"
    is_primary_key: bool = False
    is_nullable: bool = True
    description: str = ""

Bases: BaseModel

A relationship between ERD entities.

Maps to: GDS Mechanism + SpecWiring (cross-entity updates).

Source code in packages/gds-software/gds_software/erd/elements.py 
44
45
46
47
48
49
50
51
52
53
54
class ERDRelationship(BaseModel, frozen=True):
    """A relationship between ERD entities.

    Maps to: GDS Mechanism + SpecWiring (cross-entity updates).
    """

    name: str
    source: str
    target: str
    cardinality: Cardinality = Cardinality.ONE_TO_MANY
    description: str = ""

Bases: StrEnum

Relationship cardinality.

Source code in packages/gds-software/gds_software/erd/elements.py 
11
12
13
14
15
16
17
class Cardinality(StrEnum):
    """Relationship cardinality."""

    ONE_TO_ONE = "1:1"
    ONE_TO_MANY = "1:N"
    MANY_TO_ONE = "N:1"
    MANY_TO_MANY = "N:N"