Universal

amsdal_glue.Data dataclass

Represents a data entity.

Attributes:

Name	Type	Description
data	dict[str, Any]	The actual data stored in a dictionary format.
metadata	Metadata | None	Optional metadata associated with the data. Defaults to None.

amsdal_glue.CheckConstraint dataclass

Bases: BaseConstraint

Represents a check constraint.

Attributes:

Name	Type	Description
condition	Conditions	The condition that must be met for the constraint to be satisfied.

amsdal_glue.ForeignKeyConstraint dataclass

Bases: BaseConstraint

Represents a foreign key constraint.

Attributes:

Name	Type	Description
fields	list[str]	The list of fields that make up the foreign key.
reference_schema	SchemaReference	The schema that the foreign key references.
reference_fields	list[str]	The list of fields in the referenced schema.

amsdal_glue.IndexSchema dataclass

Represents an index schema.

Attributes:

Name	Type	Description
name	str	The name of the index.
fields	list[str]	The list of fields included in the index.
condition	Conditions | None	The condition under which the index applies. Defaults to None.

amsdal_glue.PrimaryKeyConstraint dataclass

Bases: BaseConstraint

Represents a primary key constraint.

Attributes:

Name	Type	Description
fields	list[str]	The list of fields that make up the primary key.

amsdal_glue.PropertySchema dataclass

Represents a property within a schema.

Attributes:

Name	Type	Description
name	str	The name of the property.
type	Union[Schema, SchemaReference, FIELD_TYPE]	The type of the property.
required	bool	Whether the property is required.
description	str | None	The description of the property. Defaults to None.
default	Any | None	The default value of the property. Defaults to None.

amsdal_glue.Schema dataclass

Represents a schema definition.

Attributes:

Name	Type	Description
name	str	The name of the schema.
version	str | Version	The version of the schema.
namespace	str	The namespace of the schema. Defaults to an empty string.
extends	Optional[SchemaReference]	The schema that this schema extends. Defaults to None.
properties	list[PropertySchema]	The list of properties in the schema.
constraints	list[BaseConstraint] | None	The list of constraints in the schema. Defaults to None.
indexes	list[IndexSchema] | None	The list of indexes in the schema. Defaults to None.

amsdal_glue.SchemaReference dataclass

Represents a reference to another schema.

Attributes:

Name	Type	Description
name	str	The name of the referenced schema.
version	str | Version	The version of the referenced schema.
alias	str | None	The alias of the referenced schema. Defaults to None.
namespace	str | None	The namespace of the referenced schema. Defaults to None.

amsdal_glue.UniqueConstraint dataclass

Bases: BaseConstraint

Represents a unique constraint.

Attributes:

Name	Type	Description
fields	list[str]	The list of fields that must be unique.
condition	Conditions | None	The condition under which the constraint applies. Defaults to None.

amsdal_glue.Version

Bases: str, Enum

Represents the version of a schema.

Attributes:

Name	Type	Description
LATEST	str	The latest version.
ALL	str	All versions.