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

dataItem

Type

str

deltaIndex

deltaIndex

Type

int

class Part
partKey

partKey

Type

PartKey

snap

snap

Type

DataDefinition.Snap

class Snap
deltas

deltas

Type

List[DataDefinition.Delta]

snapIndex

snapIndex

Type

int

parts

parts

Type

Dict[str, DataDefinition.Part]

schema

schema

Type

Optional[SchemaDefinition]

schemaId

schemaId

Type

Optional[TagSelector]

storageId

storageId

Type

TagSelector

class tracdap.rt.metadata.data.FieldSchema
businessKey

businessKey

Type

bool

categorical

categorical

Type

bool

fieldName

fieldName

Type

str

fieldOrder

fieldOrder

Type

int

fieldType

fieldType

Type

BasicType

formatCode

formatCode

Type

Optional[str]

label

label

Type

str

class tracdap.rt.metadata.data.PartKey
opaqueKey

opaqueKey

Type

str

partRangeMax

partRangeMax

Type

Optional[Value]

partRangeMin

partRangeMin

Type

Optional[Value]

partType

partType

Type

PartType

partValues

partValues

Type

List[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

Type

PartType

schemaType

schemaType

Type

SchemaType

table

table

Type

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

fields

Type

List[FieldSchema]