datacatalog.linkedstores.annotations.tag package

Submodules

datacatalog.linkedstores.annotations.tag.document module

class datacatalog.linkedstores.annotations.tag.document.TagAnnotation(*args, **kwargs)

Bases: attrdict.dictionary.AttrDict

class datacatalog.linkedstores.annotations.tag.document.TagAnnotationDocument(schema=None, **kwargs)

Bases: datacatalog.extensible.ExtensibleAttrDict

Instantiates an instance of Tag Annotation

DELETE_FIELD = '_visible'

PARAMS = [('name', True, 'name', 'generic.tag'), ('description', False, 'description', ''), ('owner', True, 'owner', 'public'), ('_visible', False, '_visible', True)]

class datacatalog.linkedstores.annotations.tag.document.TagAnnotationSchema(inheritance=True, **kwargs)

Bases: datacatalog.linkedstores.basestore.heritableschema.HeritableDocumentSchema

Defines the Tag Annotation schema

DELETE_FIELD = '_visible'

datacatalog.linkedstores.annotations.tag.schemas module

datacatalog.linkedstores.annotations.tag.schemas.get_schemas()

Get JSON schemas for TagAnnotationDocument

Returns:Object and document JSON schema that define the store Return type:JSONSchemaCollection

datacatalog.linkedstores.annotations.tag.store module

class datacatalog.linkedstores.annotations.tag.store.StoreInterface(mongodb, config={}, session=None, agave=None, **kwargs)

Bases: datacatalog.linkedstores.annotations.tag.store.TagAnnotationStore

class datacatalog.linkedstores.annotations.tag.store.TagAnnotationStore(mongodb, config={}, session=None, agave=None, **kwargs)

Bases: datacatalog.linkedstores.basestore.softdelete.SoftDelete, datacatalog.linkedstores.basestore.store.LinkedStore

Manage storage and retrieval of TagAnnotation documents

LINK_FIELDS = []

new_tag(name, description=None, owner=None, token=None, **kwargs)

Create a new Tag Annotation

Parameters:

• name (str) – The tag’s name
• owner (str) – TACC.cloud owner of the tag
• description (str, optional) – Optional text description of the tag

Returns:

Representation of the newly-created text annotation

Return type:

dict