tracdap.rt.metadata.data

Module Contents

Classes

DataDefinition

FieldSchema

PartKey

PartType

Generic enumeration.

SchemaDefinition

A schema definition describes the schema of a dataset

SchemaType

Enumeration of the available types of data schema

TableSchema

class tracdap.rt.metadata.data.DataDefinition
class Delta
dataItem :str
deltaIndex :int
class Part
partKey :PartKey
snap :DataDefinition
class Snap
deltas :List[DataDefinition]
snapIndex :int
parts :Dict[str, DataDefinition]
schema :Optional[SchemaDefinition]
schemaId :Optional[tracdap.rt.metadata.object_id.TagSelector]
storageId :tracdap.rt.metadata.object_id.TagSelector
class tracdap.rt.metadata.data.FieldSchema
businessKey :bool
categorical :bool
fieldName :str
fieldOrder :int
fieldType :tracdap.rt.metadata.object_id.BasicType
formatCode :Optional[str]
label :str
class tracdap.rt.metadata.data.PartKey
opaqueKey :str
partRangeMax :tracdap.rt.metadata.object_id.Value
partRangeMin :tracdap.rt.metadata.object_id.Value
partType :PartType
partValues :List[tracdap.rt.metadata.object_id.Value]
class tracdap.rt.metadata.data.PartType

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

PART_BY_RANGE = [1]
PART_BY_VALUE = [2]
PART_ROOT = [0]
class tracdap.rt.metadata.data.SchemaDefinition

A schema definition describes the schema of a dataset

Schema definitions can be top level objects (a type of object definition), in which case they can be referred to by multiple data definitions. Alternatively they can be embedded in a data definition to create datasets with one-off schemas.

A table schema describes the schema of a tabular data set. Other schema types may be added later, e.g. for matrices, tensors, curves, surfaces and structured datasets.

See also

DataDefinition

partType :PartType
schemaType :SchemaType
table :Optional[TableSchema]
class tracdap.rt.metadata.data.SchemaType

Bases: enum.Enum

Enumeration of the available types of data schema

Currently only table schemas are supported, other schema types may be added later.

See also

SchemaDefinition

SCHEMA_TYPE_NOT_SET = [0]
TABLE = [1]
class tracdap.rt.metadata.data.TableSchema
fields :List[FieldSchema]