Glossary¶
This page lists each word that datarecord's pages use in one meaning only, with a link to the page that defines it.
| Word | Meaning |
|---|---|
| record | the object you hold: dims, properties and attributes under one schema, exposed through RecordLike |
| dim | a set of unique labels that values vary along, declared by a Dimension under dimensions |
| axis | the labels one dim has in one record, in order, which record.dims[dim] returns |
| label | one value of a dim, unique within it, which is a tuple on a multi-dim |
| multi-dim | a dim declared with over, whose labels are tuples of other dims' labels |
| coordinate | one named position in a key: a column of an attribute's rows, or a field of a multi-dim's tuple |
| point | one label or NULL on each coordinate of an attribute, where a row's value applies |
| property | a value per label of its subject dim, named subject.name, stored as a column of that dim's axis file |
| category | a label's value of a property of a dim in partial that refers to a dim with one_of |
| attribute | the values at points over the dims its AttributeSpec lists, stored as long rows, one file per attribute |
| indexed over | of an attribute: each dim its dims lists, and each dim that a coordinate of one of its multi-dims draws on |
| the broadcast rule | a NULL coordinate means every label of its dim, and where rows cover one point, datarecord keeps the row that leaves no dim NULL that another row there sets |
| schema | the Schema of a record: the dims, properties, attributes and partial that may exist |
partial |
the dims along which a layer overrides one value per label |
| layer | the data one revision adds on top of its parent, written once |
| revision | the id of one layer in a store, whose manifest lists its parent |
| to remove a label | to restate its dim's axis without it, which removes its values and the tuples that contain it |
| the fold | the step that builds the owner map along a revision's ancestry, one layer at a time |
| the owner map | the fold's result: per attribute, each key a layer wrote and the layer the map assigns it to |
| to cross | of two rows of two layers, to cover a common point where each row leaves NULL a dim that the other row sets |
| to materialise | to write a revision's owner map and pointers to its axes under resolved/, so that a read stops there |
| manifest | a layer's manifest.json: its id, parent, full schema, files and meta |
| registered view | a DuckDB view that Record.register creates for a SQL client |
| store | one location, local or on S3, that contains the layers of a tree of revisions |
| workspace | the DuckDB database and file access that its stores share |
| claim | a revision id that a store reserves before the layer is written |
| reader | code that reads a record through RecordLike, such as a tool or your script |
| flags | per attribute, the dims some row sets (varies) and the dims some row leaves NULL (broadcast) |
| to settle rows | to apply the broadcast rule to long rows with settle, one row per label passed at each point |
| selection | the Selection that select(record, **labels) returns: a record at the labels named |
| to squeeze | to select one label of a dim, which drops the dim from the selection's schema |
| to lift | to put the squeezed labels back on rows written over a selection, with Selection.lift |
| edit | a set, add or remove on a WorkingRecord, staged until store.commit writes it as a child layer |
| tool | a module under datarecord.tools that translates between a record and one framework |
| framework | a modelling framework, such as PyPSA, that builds a model from a record |