tracdap.rt.metadata.data
¶
Module Contents¶
Classes¶
Generic enumeration. |
|
A schema definition describes the schema of a dataset |
|
Enumeration of the available types of data schema |
|
- class tracdap.rt.metadata.data.DataDefinition¶
-
- 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:
- class tracdap.rt.metadata.data.FieldSchema¶
- businessKey¶
businessKey
- Type:
bool
- categorical¶
categorical
- Type:
bool
- fieldName¶
fieldName
- Type:
str
- fieldOrder¶
fieldOrder
- Type:
int
- formatCode¶
formatCode
- Type:
Optional[str]
- label¶
label
- Type:
str
- notNull¶
This could become mandatory with the next metadata update
- Type:
Optional[bool]
- 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
- schemaType¶
schemaType
- Type:
- 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
- SCHEMA_TYPE_NOT_SET = [0]¶
- TABLE = [1]¶
- class tracdap.rt.metadata.data.TableSchema¶
- fields¶
fields
- Type:
List[FieldSchema]