datacatalog.linkedstores.annotation package

Submodules

datacatalog.linkedstores.annotation.annotation module

class datacatalog.linkedstores.annotation.annotation.AnnotationDocument(schema=None, **kwargs)[source]

Bases: datacatalog.extensible.ExtensibleAttrDict

Instantiates an instance of inline annotation

PARAMS = [('uuid', False, 'uuid', None), ('date', False, 'date', None), ('data', False, 'data', 'Empty annotation')]
class datacatalog.linkedstores.annotation.annotation.AnnotationSchema(inheritance=True, **kwargs)[source]

Bases: datacatalog.linkedstores.basestore.heritableschema.HeritableDocumentSchema

Defines the inline annotation schema

datacatalog.linkedstores.annotation.inline module

class datacatalog.linkedstores.annotation.inline.InlineAnnotationDocument(schema=None, **kwargs)[source]

Bases: datacatalog.extensible.ExtensibleAttrDict

Instantiates an instance of inline annotation

PARAMS = [('uuid', False, 'uuid', None), ('date', False, 'date', None), ('data', False, 'data', 'Empty annotation')]
class datacatalog.linkedstores.annotation.inline.InlineAnnotationSchema(data=None)[source]

Bases: datacatalog.linkedstores.basestore.heritableschema.HeritableDocumentSchema

Defines the inline annotation schema

class datacatalog.linkedstores.annotation.inline.InlineAnnotationStore[source]

Bases: object

datacatalog.linkedstores.annotation.schemas module

datacatalog.linkedstores.annotation.schemas.get_schemas()[source]

Get JSON schemas for this submodule

Returns:Return the object and document JSON schema that define the store
Return type:dict

datacatalog.linkedstores.annotation.store module

class datacatalog.linkedstores.annotation.store.AnnotationStore(mongodb, config={}, session=None, **kwargs)[source]

Bases: datacatalog.linkedstores.basestore.store.LinkedStore

Manage storage and retrieval of AnnotationDocuments

exception datacatalog.linkedstores.annotation.store.AnnotationUpdateFailure[source]

Bases: datacatalog.linkedstores.basestore.exceptions.CatalogUpdateFailure

class datacatalog.linkedstores.annotation.store.StoreInterface(mongodb, config={}, session=None, **kwargs)[source]

Bases: datacatalog.linkedstores.annotation.store.AnnotationStore