cfxdb.meta¶

Submodules¶

Classes¶

`Attribute`	Generic meta-data attributes that can be stored on objects in tables.
`Attributes`	Generic meta-data attributes that can be stored on objects in tables. Primary key of this table is `(table_oid, object_oid, attribute)`.
`DocFormat`
`Schema`	Generic metadata, like documentation, tags, comments and reactions that

Package Contents¶

class Attribute(from_fbs=None)[source]¶

Bases: object

Generic meta-data attributes that can be stored on objects in tables.

__str__()[source]¶

_attribute = None¶

_from_fbs = None¶

_modified = None¶

_object_oid = None¶

_table_oid = None¶

_value = None¶

property attribute: str¶: Attribute name (part of the key).

build(builder)[source]¶

static cast(buf)[source]¶

marshal() → dict[source]¶

property modified: numpy.datetime64¶: Timestamp when the attribute was last modified (or first created).

property object_oid: uuid.UUID¶: Object (within the table) holding the attribute.

property table_oid: uuid.UUID¶: Table of the object holding the attribute.

property value¶: Arbitrary attribute value, stored CBOR-serialized.

class Attributes(slot=None, compress=None, build=None, cast=None)[source]¶

Bases: zlmdb.MapUuidUuidStringFlatBuffers

Generic meta-data attributes that can be stored on objects in tables. Primary key of this table is (table_oid, object_oid, attribute).

Map zlmdb.MapUuidUuidStringFlatBuffers from (table_oid, object_oid, attribute) to cfxdb.meta.Attribute

class DocFormat[source]¶

Bases: object

DOCBOOK = 6¶

HTML = 4¶

MARKDOWN = 2¶

NONE = 0¶

NOTEBOOK = 7¶

REST = 3¶

TEXT = 1¶

XML = 5¶

class Schema(db)[source]¶

Bases: object

Generic metadata, like documentation, tags, comments and reactions that can be attach on any object with an UUID.

static attach(db)[source]¶

Attach database schema to database instance.

Parameters:: db (zlmdb.Database) – Database to attach schema to.

attributes: cfxdb.meta.attribute.Attributes¶: Generic meta data attributes for objects in other tables. Primary key of this table is (table_oid, object_oid, attribute).

db¶

docs: Docs¶

Documentation attached to a database object.

Database table cfxdb.mrealmschema.Docs

idx_object_to_doc: IndexObjectToDoc¶

by documented object ID

Database table cfxdb.mrealmschema.IndexObjectToDoc

Type:: Index on documentation