aito.schema.AitoColumnTypeSchema

class aito.schema.AitoColumnTypeSchema(data_type: aito.schema.AitoDataTypeSchema, nullable: bool = None, link: aito.schema.AitoColumnLink = None, analyzer: aito.schema.AitoAnalyzerSchema = None)

Aito ColumnType schema

Parameters

  • data_type (AitoDataTypeSchema) – the type of the column

  • nullable (bool, default to False) – when true, null values are allowed

  • link (AitoColumnLink, optional) – path to a linked column

  • analyzer (AnalyzerSchema, optional) – the analyzer of the column if the column is of type Text

Methods

from_deserialized_object(obj)

create an AitoSchema object from a JSON deserialized object

from_json_string(json_string, **kwargs)

create an AitoSchema object from a JSON string

to_json_serializable()

convert the AitoSchema object to a json serializable object (dict, in most case)

to_json_string(**kwargs)

the AitoSchema object as a JSON string

Attributes

analyzer

comparison_properties

iterable of the properties that will be used for comparison with another schema object of the same type

data_type

has_link

return true if the column is linked to another column

nullable

True if the column allow null value

type

the type of the schema component