spinedb_api.db_mapping

This module defines the DatabaseMapping class, the main mean to communicate with a Spine DB. If you’re planning to use this class, it is probably a good idea to first familiarize yourself a little bit with the DB mapping schema.

Classes

DatabaseMapping

Enables communication with a Spine DB.

Module Contents

class spinedb_api.db_mapping.DatabaseMapping(db_url, username=None, upgrade=False, backup_url='', create=False, apply_filters=True, memory=False, commit_lock=None, sqlite_timeout=1800)

Bases: spinedb_api.db_mapping_query_mixin.DatabaseMappingQueryMixin, spinedb_api.db_mapping_commit_mixin.DatabaseMappingCommitMixin, spinedb_api.db_mapping_base.DatabaseMappingBase

Enables communication with a Spine DB.

The DB is incrementally mapped into memory as data is requested/modified, following the DB mapping schema.

Data is typically retrieved using item() or find(). If the requested data is already in memory, it is returned from there; otherwise it is fetched from the DB, stored in memory, and then returned. In other words, the data is fetched from the DB exactly once.

For convenience, we also provide specialized getter methods for each item type, e.g., entity() and find_entities().

Data is added via add(); updated via update(); removed via remove(); and restored via restore(). add_or_update() adds an item or updates an existing one. All the above methods modify the in-memory mapping (not the DB itself). These methods also fetch data from the DB into the in-memory mapping to perform the necessary integrity checks (unique and foreign key constraints).

For convenience, we also provide specialized ‘add’, ‘update’, ‘remove’, and ‘restore’ methods for each item type, e.g., add_entity(), update_entity(), remove_entity() and restore_entity().

Modifications to the in-memory mapping are committed (written) to the DB via commit_session(), or rolled back (discarded) via rollback_session().

The DB fetch status is reset via refresh_session(). This allows new items in the DB (added by other clients in the meantime) to be retrieved as well.

You can also control the fetching process via fetch_more() and/or fetch_all(). For example, you can call fetch_more() in a dedicated thread while you do some work on the main thread. This will nicely place items in the in-memory mapping, so you can access them later, without the overhead of fetching them from the DB.

The query() method is also provided as an alternative way to retrieve data from the DB while bypassing the in-memory mapping entirely.

You usually use this class as a context manager, e.g.:

with DatabaseMapping(db_url) as db_map:
    # Do stuff with db_map
    ...

or:

db_map = DatabaseMapping(db_url)
...
with db_map:
    # Do stuff with db_map
    ...

Parameters:

• db_url (str or URL) – A URL in RFC-1738 format pointing to the database to be mapped, or to a DB server.

• username (str, optional) – A user name. If not given, it gets replaced by the string anon.

• upgrade (bool, optional) – Whether the DB at the given url should be upgraded to the most recent version.

• backup_url (str, optional) – A URL to backup the DB before upgrading.

• create (bool, optional) – Whether to create a new Spine DB at the given url if it’s not already one.

• apply_filters (bool, optional) – Whether to apply filters in the url’s query segment.

• commit_lock (threading.Lock, optional) – If given, committing to the DB is done with the lock.

• memory (bool, optional) – Whether to use a SQLite memory DB as replacement for the original one.

• sqlite_timeout (int, optional) – The number of seconds to wait before raising SQLite connection errors.

static item_types() → list[spinedb_api.helpers.ItemType]

Returns a list of public item types from the DB mapping schema (equivalent to the table names).

static all_item_types() → list[spinedb_api.helpers.ItemType]

Returns a list of all item types from the DB mapping schema (equivalent to the table names).

static item_factory(item_type: spinedb_api.helpers.ItemType) → Type[spinedb_api.db_mapping_base.MappedItemBase]

Returns a subclass of MappedItemBase to make items of given type.

add(mapped_table: spinedb_api.db_mapping_base.MappedTable, **kwargs) → spinedb_api.db_mapping_base.PublicItem

Adds an item to the in-memory mapping.

Example:

with DatabaseMapping(db_url) as db_map:
    class_table = db_map.mapped_table("entity_class")
    db_map.add(class_table, name="musician")
    entity_table = db_map.mapped_table("entity")
    db_map.add(entity_table, entity_class_name="musician", name="Prince")

item(mapped_table: spinedb_api.db_mapping_base.MappedTable, **kwargs) → spinedb_api.db_mapping_base.PublicItem

Returns an item matching the keyword arguments.

Example:

with DatabaseMapping(db_url) as db_map:
    entity_table = db_map.mapped_table("entity")
    prince = db_map.get_item(entity_table, entity_class_name="musician", name="Prince")

find(mapped_table: spinedb_api.db_mapping_base.MappedTable, **kwargs) → list[spinedb_api.db_mapping_base.PublicItem]

Finds items that match the keyword arguments.

Example:

with DatabaseMapping(db_url) as db_map:
    entity_table = db_map.mapped_table("entity")
    entities = db_map.find(entity_table, entity_class_name="musician")
    for entity in entities:
        print(f"{entity['name']}: {entity['description']}")

static update(mapped_table: spinedb_api.db_mapping_base.MappedTable, **kwargs) → spinedb_api.db_mapping_base.PublicItem | None

Updates an existing item.

Returns the updated item or None if nothing was updated.

Example:

with DatabaseMapping(db_url) as db_map:
    entity_table = db_map.mapped_table("entity")
    prince = db_map.item(entity_table, entity_class_name="musician", name="Prince")
    db_map.update(
        entity_table, id=prince["id"], name="the Artist", description="Formerly known as Prince."
    )

add_or_update(mapped_table: spinedb_api.db_mapping_base.MappedTable, **kwargs) → spinedb_api.db_mapping_base.PublicItem | None

Adds an item if it does not exist, otherwise updates it.

Returns the added/updated item or None if nothing was changed.

static remove(mapped_table: spinedb_api.db_mapping_base.MappedTable, **kwargs) → None

Removes an item matching the keyword arguments.

Example:

with DatabaseMapping(db_url) as db_map:
    entity_table = db_map.mapped_table("entity")
    prince = db_map.item(entity_table, entity_class_name="musician", name="Prince")
    db_map.remove_item(entity_table, id=prince["id"])

static restore(mapped_table: spinedb_api.db_mapping_base.MappedTable, **kwargs) → spinedb_api.db_mapping_base.PublicItem

Restores a previously removed item.

Example:

with DatabaseMapping(db_url) as db_map:
    entity_table = db_map.mapped_table("entity")
    db_map.restore(entity_table, entity_class_name="musician", name="Prince")

get_item(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, fetch: bool = True, skip_removed: bool = True, **kwargs) → spinedb_api.db_mapping_base.PublicItem | dict

Finds and returns an item matching the arguments, or an empty dict if none found.

This is legacy method. Use item() instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• fetch – Whether to fetch the DB in case the item is not found in memory.

• skip_removed – Whether to ignore removed items.

• **kwargs – Fields and values for one the unique keys as specified for the item type in DB mapping schema.

Returns:

PublicItem or empty dict

get_items(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, fetch: bool = True, skip_removed: bool = True, **kwargs) → list[spinedb_api.db_mapping_base.PublicItem]

Finds and returns all the items of one type.

This is legacy method. Use find() instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• fetch – Whether to fetch the DB before returning the items.

• skip_removed – Whether to ignore removed items.

• **kwargs – Fields and values for one the unique keys as specified for the item type in DB mapping schema.

Returns:

The items.

add_item(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, check: bool = True, **kwargs) → tuple[spinedb_api.db_mapping_base.PublicItem | None, str | None]

Adds an item to the in-memory mapping.

This is legacy method. Use add() instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• check – Whether to check for data integrity.

• **kwargs – Fields and values as specified for the item type in DB mapping schema.

Returns:

The added item and any errors.

add_items(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, *items: dict, check: bool = True, strict: bool = False) → tuple[list[spinedb_api.db_mapping_base.PublicItem | None], list[str | None]]

Adds many items to the in-memory mapping.

This is legacy method. Use the add_entities(), add_entity_classes() etc. methods instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• *items – One or more dict objects mapping fields to values of the item type, as specified in DB mapping schema.

• check – Whether to check for data integrity.

• strict – Whether the method should raise SpineIntegrityError if the insertion of one of the items violates an integrity constraint.

Returns:

items successfully added and found violations.

update_item(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, check: bool = True, **kwargs) → tuple[spinedb_api.db_mapping_base.PublicItem | None, str | None]

Updates an item in the in-memory mapping.

This is legacy method. Use update() instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• check – Whether to check for data integrity and legacy item types.

• **kwargs – Fields to update and their new values as specified for the item type in DB mapping schema.

Returns:

The updated item and any errors.

update_items(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, *items: dict, check: bool = True, strict: bool = False) → tuple[list[spinedb_api.db_mapping_base.PublicItem | None], list[str | None]]

Updates many items in the in-memory mapping.

This is legacy method. Use the update_entities(), update_entity_classes() etc. methods instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• *items – One or more dict objects mapping fields to values of the item type, as specified in DB mapping schema and including the id.

• check – Whether to check for data integrity.

• strict – Whether the method should raise SpineIntegrityError if the update of one of the items violates an integrity constraint.

Returns:

items successfully updated and found violations.

add_update_item(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, check: bool = True, **kwargs) → tuple[spinedb_api.db_mapping_base.PublicItem | None, spinedb_api.db_mapping_base.PublicItem | None, str | None]

Adds an item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

This is legacy method. Use add_or_update() instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• check – Whether to check for data integrity.

• **kwargs – Fields and values as specified for the item type in DB mapping schema.

Returns:

The added item if any, the updated item if any, and any errors.

add_update_items(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, *items: spinedb_api.db_mapping_base.PublicItem | spinedb_api.db_mapping_base.MappedItemBase | dict, check: bool = True, strict: bool = False) → tuple[list[spinedb_api.db_mapping_base.PublicItem | None], list[spinedb_api.db_mapping_base.PublicItem | None], list[str | None]]

Adds or updates many items into the in-memory mapping.

This is legacy method. Use add_or_update_entities(), add_or_update_entity_classes() etc. methods instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• *items – One or more dict objects mapping fields to values of the item type, as specified in DB mapping schema.

• check – Whether to check for data integrity.

• strict – Whether the method should raise SpineIntegrityError if the insertion of one of the items violates an integrity constraint.

Returns:

items successfully added, items successfully updated, and found violations.

remove_item(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, id_: spinedb_api.temp_id.TempId | int, check: bool = True) → tuple[spinedb_api.db_mapping_base.PublicItem | None, str | None]

Removes an item from the in-memory mapping.

This is legacy method. Use remove() instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• id – The id of the item to remove.

• check – Whether to check for data integrity.

Returns:

The removed item and any errors.

Return type:

tuple(PublicItem or None, str)

remove_items(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, *ids: spinedb_api.temp_id.TempId | int, check: bool = True, strict: bool = False) → tuple[list[spinedb_api.db_mapping_base.PublicItem], list[str]]

Removes many items from the in-memory mapping.

This is legacy method. Use remove_entities(), remove_entity_classes() etc. methods instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• *ids – Ids of items to be removed.

• check – Whether to check for data integrity.

• strict – Whether the method should raise SpineIntegrityError if the update of one of the items violates an integrity constraint.

Returns:

items successfully removed and found violations.

restore_item(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, id_: spinedb_api.temp_id.TempId | int) → tuple[spinedb_api.db_mapping_base.PublicItem | None, str | None]

Restores a previously removed item into the in-memory mapping.

This is legacy method. Use restore() instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• id – The id of the item to restore.

Returns:

The restored item if any and possible error.

restore_items(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, *ids: spinedb_api.temp_id.TempId | int) → tuple[list[spinedb_api.db_mapping_base.PublicItem | None], list[str | None]]

Restores many previously removed items into the in-memory mapping.

This is legacy method. Use restore_entities(), restore_entity_classes() etc. methods instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• *ids – Ids of items to be removed.

Returns:

items successfully restored and found violations.

purge_items(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType) → bool

Removes all items of one type.

This is legacy method. Use remove_entity(), remove_entity_class() etc. with id=Asterisk instead. This method supports legacy item types, e.g. object and relationship_class.

Parameters:

item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

Returns:

True if any data was removed, False otherwise.

fetch_more(item_type: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType, offset: int = 0, limit: int | None = None, **kwargs) → list[spinedb_api.db_mapping_base.PublicItem]

Fetches items from the DB into the in-memory mapping, incrementally.

Parameters:

• item_type – One of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location.

• offset – The initial row.

• limit – The maximum number of rows to fetch.

• **kwargs – Fields and values for one the unique keys as specified for the item type in DB mapping schema.

Returns:

The items fetched.

fetch_all(*item_types: spinedb_api.helpers.ItemType | spinedb_api.helpers.LegacyItemType) → list[spinedb_api.db_mapping_base.PublicItem]

Fetches items from the DB into the in-memory mapping. Unlike fetch_more(), this method fetches entire tables.

Parameters:

*item_types – One or more of alternative, scenario, scenario_alternative, entity_class, display_mode, entity_class_display_mode, superclass_subclass, entity, entity_group, entity_alternative, parameter_value_list, list_value, parameter_type, parameter_group, parameter_definition, parameter_value, metadata, entity_metadata, parameter_value_metadata, entity_location. If none given, then the entire DB is fetched.

query(*entities, **kwargs) → sqlalchemy.orm.Query

Returns a Query object to execute against the mapped DB.

To perform custom SELECT statements, call this method with one or more of the documented subquery properties of DatabaseMappingQueryMixin returning Subquery objetcs. For example, to select the entity class with id equal to 1:

from spinedb_api import DatabaseMapping
url = 'sqlite:///spine.db'
...
with DatabaseMapping(url) as db_map:
    entity_record = db_map.query(db_map.entity_class_sq).filter_by(id=1).one_or_none()
    if entity_record is not None:
        ...

To perform more complex queries, use SQLAlchemy’s Query interface. For example, to select all entity class names and the names of their entities concatenated in a comma-separated string:

from sqlalchemy import func

with DatabaseMapping(ur) as db_map:
    classes = db_map.query(
        db_map.entity_class_sq.c.name,
        func.group_concat(db_map.entity_sq.c.name).label("entities")
    ).filter(
        db_map.entity_sq.c.class_id == db_map.entity_class_sq.c.id
    ).group_by(
        db_map.entity_class_sq.c.name
    ).all()
    for entity_class in classes:
        print(f"{entity_class.name}: {entity_class.entities}")

Returns:

The resulting query.

Return type:

Query

commit_session(comment: str, apply_compatibility_transforms: bool = True) → spinedb_api.compatibility.CompatibilityTransformations

Commits the changes from the in-memory mapping to the database.

Parameters:

• comment – commit message

• apply_compatibility_transforms – if True, apply compatibility transforms

Returns:

compatibility transformations

rollback_session() → None

Discards all the changes from the in-memory mapping.

has_external_commits() → bool

Tests whether the database has had commits from other sources than this mapping.

Returns:

True if database has external commits, False otherwise

get_filter_configs() → list[dict]

Returns the config dicts of filters applied to this database mapping.

close() → None

Closes this DB mapping.

alternative(**kwargs)

Returns an alternative item matching the keyword arguments.

Parameters:

name (str) – The alternative name.

Returns:

PublicItem

scenario(**kwargs)

Returns a scenario item matching the keyword arguments.

Parameters:

name (str) – The scenario name.

Returns:

PublicItem

scenario_alternative(**kwargs)

Returns a scenario_alternative item matching the keyword arguments.

Parameters:

• alternative_name (str) – The alternative name.

• scenario_name (str) – The scenario name.

• rank (int) – The rank - higher has precedence.

Returns:

PublicItem

entity_class(**kwargs)

Returns an entity_class item matching the keyword arguments.

Parameters:

name (str) – The class name.

Returns:

PublicItem

display_mode(**kwargs)

Returns a display_mode item matching the keyword arguments.

Parameters:

name (str) – The display mode name.

Returns:

PublicItem

entity_class_display_mode(**kwargs)

Returns an entity_class_display_mode item matching the keyword arguments.

Parameters:

• display_mode_name (int) – The display mode name.

• entity_class_name (str) – The entity class name.

Returns:

PublicItem

superclass_subclass(**kwargs)

Returns a superclass_subclass item matching the keyword arguments.

Parameters:

subclass_name (str) – The subclass name.

Returns:

PublicItem

entity(**kwargs)

Returns an entity item matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The entity name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

Returns:

PublicItem

entity_group(**kwargs)

Returns an entity_group item matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• member_name (str) – The member entity name.

• group_name (str) – The group entity name.

Returns:

PublicItem

entity_alternative(**kwargs)

Returns an entity_alternative item matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

Returns:

PublicItem

parameter_value_list(**kwargs)

Returns a parameter_value_list item matching the keyword arguments.

Parameters:

name (str) – The parameter value list name.

Returns:

PublicItem

list_value(**kwargs)

Returns a list_value item matching the keyword arguments.

Parameters:

• parameter_value_list_name (str) – The parameter value list name.

• index (int, optional) – The value index.

Returns:

PublicItem

parameter_type(**kwargs)

Returns a parameter_type item matching the keyword arguments.

Parameters:

• type (str) – The value type.

• entity_class_name (str) – The entity class name.

• rank (int) – The rank of the type.

• parameter_definition_name (str) – The parameter name.

Returns:

PublicItem

parameter_group(**kwargs)

Returns a parameter_group item matching the keyword arguments.

Parameters:

name (str) – The parameter group name.

Returns:

PublicItem

parameter_definition(**kwargs)

Returns a parameter_definition item matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The parameter name.

Returns:

PublicItem

parameter_value(**kwargs)

Returns a parameter_value item matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str, optional) – The alternative name - defaults to ‘Base’.

• parameter_definition_name (str) – The parameter name.

Returns:

PublicItem

metadata(**kwargs)

Returns a metadata item matching the keyword arguments.

Parameters:

• name (str) – The metadata entry name.

• value (str) – The metadata entry value.

Returns:

PublicItem

entity_metadata(**kwargs)

Returns an entity_metadata item matching the keyword arguments.

Parameters:

• metadata_name (str) – The metadata entry name.

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• metadata_value (str) – The metadata entry value.

Returns:

PublicItem

parameter_value_metadata(**kwargs)

Returns a parameter_value_metadata item matching the keyword arguments.

Parameters:

• alternative_name (str) – The alternative name.

• metadata_name (str) – The metadata entry name.

• entity_class_name (str) – The entity class name.

• metadata_value (str) – The metadata entry value.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

Returns:

PublicItem

entity_location(**kwargs)

Returns an entity_location item matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

Returns:

PublicItem

find_alternatives(**kwargs)

Finds and returns all alternative items matching the keyword arguments.

Parameters:

name (str) – The alternative name.

Returns:

The items.

Return type:

list of PublicItem

find_scenarios(**kwargs)

Finds and returns all scenario items matching the keyword arguments.

Parameters:

name (str) – The scenario name.

Returns:

The items.

Return type:

list of PublicItem

find_scenario_alternatives(**kwargs)

Finds and returns all scenario_alternative items matching the keyword arguments.

Parameters:

• alternative_name (str) – The alternative name.

• scenario_name (str) – The scenario name.

• rank (int) – The rank - higher has precedence.

Returns:

The items.

Return type:

list of PublicItem

find_entity_classes(**kwargs)

Finds and returns all entity_class items matching the keyword arguments.

Parameters:

name (str) – The class name.

Returns:

The items.

Return type:

list of PublicItem

find_display_modes(**kwargs)

Finds and returns all display_mode items matching the keyword arguments.

Parameters:

name (str) – The display mode name.

Returns:

The items.

Return type:

list of PublicItem

find_entity_class_display_modes(**kwargs)

Finds and returns all entity_class_display_mode items matching the keyword arguments.

Parameters:

• display_mode_name (int) – The display mode name.

• entity_class_name (str) – The entity class name.

Returns:

The items.

Return type:

list of PublicItem

find_superclass_subclasses(**kwargs)

Finds and returns all superclass_subclass items matching the keyword arguments.

Parameters:

subclass_name (str) – The subclass name.

Returns:

The items.

Return type:

list of PublicItem

find_entities(**kwargs)

Finds and returns all entity items matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The entity name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

Returns:

The items.

Return type:

list of PublicItem

find_entity_groups(**kwargs)

Finds and returns all entity_group items matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• member_name (str) – The member entity name.

• group_name (str) – The group entity name.

Returns:

The items.

Return type:

list of PublicItem

find_entity_alternatives(**kwargs)

Finds and returns all entity_alternative items matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

Returns:

The items.

Return type:

list of PublicItem

find_parameter_value_lists(**kwargs)

Finds and returns all parameter_value_list items matching the keyword arguments.

Parameters:

name (str) – The parameter value list name.

Returns:

The items.

Return type:

list of PublicItem

find_list_values(**kwargs)

Finds and returns all list_value items matching the keyword arguments.

Parameters:

• parameter_value_list_name (str) – The parameter value list name.

• index (int, optional) – The value index.

Returns:

The items.

Return type:

list of PublicItem

find_parameter_types(**kwargs)

Finds and returns all parameter_type items matching the keyword arguments.

Parameters:

• type (str) – The value type.

• entity_class_name (str) – The entity class name.

• rank (int) – The rank of the type.

• parameter_definition_name (str) – The parameter name.

Returns:

The items.

Return type:

list of PublicItem

find_parameter_groups(**kwargs)

Finds and returns all parameter_group items matching the keyword arguments.

Parameters:

name (str) – The parameter group name.

Returns:

The items.

Return type:

list of PublicItem

find_parameter_definitions(**kwargs)

Finds and returns all parameter_definition items matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The parameter name.

Returns:

The items.

Return type:

list of PublicItem

find_parameter_values(**kwargs)

Finds and returns all parameter_value items matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str, optional) – The alternative name - defaults to ‘Base’.

• parameter_definition_name (str) – The parameter name.

Returns:

The items.

Return type:

list of PublicItem

find_metadata_items(**kwargs)

Finds and returns all metadata items matching the keyword arguments.

Parameters:

• name (str) – The metadata entry name.

• value (str) – The metadata entry value.

Returns:

The items.

Return type:

list of PublicItem

find_entity_metadata_items(**kwargs)

Finds and returns all entity_metadata items matching the keyword arguments.

Parameters:

• metadata_name (str) – The metadata entry name.

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• metadata_value (str) – The metadata entry value.

Returns:

The items.

Return type:

list of PublicItem

find_parameter_value_metadata_items(**kwargs)

Finds and returns all parameter_value_metadata items matching the keyword arguments.

Parameters:

• alternative_name (str) – The alternative name.

• metadata_name (str) – The metadata entry name.

• entity_class_name (str) – The entity class name.

• metadata_value (str) – The metadata entry value.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

Returns:

The items.

Return type:

list of PublicItem

find_entity_locations(**kwargs)

Finds and returns all entity_location items matching the keyword arguments.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

Returns:

The items.

Return type:

list of PublicItem

add_alternative(**kwargs)

Adds an alternative item to the in-memory mapping.

Parameters:

• name (str) – The alternative name.

• description (str, optional) – The alternative description.

Returns:

The added item.

Return type:

PublicItem

add_scenario(**kwargs)

Adds a scenario item to the in-memory mapping.

Parameters:

• name (str) – The scenario name.

• description (str, optional) – The scenario description.

• active (bool, optional) – Not in use at the moment.

Returns:

The added item.

Return type:

PublicItem

add_scenario_alternative(**kwargs)

Adds a scenario_alternative item to the in-memory mapping.

Parameters:

• scenario_name (str) – The scenario name.

• alternative_name (str) – The alternative name.

• rank (int) – The rank - higher has precedence.

Returns:

The added item.

Return type:

PublicItem

add_entity_class(**kwargs)

Adds an entity_class item to the in-memory mapping.

Parameters:

• name (str) – The class name.

• dimension_name_list (tuple, optional) – The dimension names for a multi-dimensional class.

• entity_class_byname (tuple) – A tuple with the class name as single element if the class is 0-dimensional, or the 0-dimensional class names if it is multi-dimensional.

• description (str, optional) – The class description.

• display_icon (int, optional) – An integer representing an icon within your application.

• display_order (int, optional) – Not in use at the moment.

• hidden (int, optional) – Not in use at the moment.

• active_by_default (bool, optional) – Default activity for the entity alternatives of the class.

Returns:

The added item.

Return type:

PublicItem

add_display_mode(**kwargs)

Adds a display_mode item to the in-memory mapping.

Parameters:

• name (str) – The display mode name.

• description (str, optional) – The display mode description.

Returns:

The added item.

Return type:

PublicItem

add_entity_class_display_mode(**kwargs)

Adds an entity_class_display_mode item to the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• display_mode_name (int) – The display mode name.

• display_order (int) – The display order.

• display_status (str) – The display status; one of ‘visible’, ‘hidden’ or ‘greyed_out’.

• display_font_color (str, optional) – The color of the font.

• display_background_color (str, optional) – The color of the background.

Returns:

The added item.

Return type:

PublicItem

add_superclass_subclass(**kwargs)

Adds a superclass_subclass item to the in-memory mapping.

Parameters:

• superclass_name (str) – The superclass name.

• subclass_name (str) – The subclass name.

Returns:

The added item.

Return type:

PublicItem

add_entity(**kwargs)

Adds an entity item to the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The entity name.

• element_name_list (tuple) – The element names if the entity is multi-dimensional.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• description (str, optional) – The entity description.

• lat (float, optional) – The latitude of entity.

• lon (float, optional) – The longitude of entity.

• alt (float, optional) – The altitude of entity.

• shape_name (str, optional) – The name of the entity’s shape.

• shape_blob (str, optional) – The shape as GEOJSON string.

Returns:

The added item.

Return type:

PublicItem

add_entity_group(**kwargs)

Adds an entity_group item to the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• group_name (str) – The group entity name.

• member_name (str) – The member entity name.

Returns:

The added item.

Return type:

PublicItem

add_entity_alternative(**kwargs)

Adds an entity_alternative item to the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

• active (bool, optional) – Whether the entity is active in the alternative - defaults to True.

Returns:

The added item.

Return type:

PublicItem

add_parameter_value_list(**kwargs)

Adds a parameter_value_list item to the in-memory mapping.

Parameters:

name (str) – The parameter value list name.

Returns:

The added item.

Return type:

PublicItem

add_list_value(**kwargs)

Adds a list_value item to the in-memory mapping.

Parameters:

• parameter_value_list_name (str) – The parameter value list name.

• value (bytes) – The value’s database representation.

• type (str, optional) – The value’s type.

• parsed_value (ParameterValue, optional) – The value.

• index (int, optional) – The value index.

Returns:

The added item.

Return type:

PublicItem

add_parameter_type(**kwargs)

Adds a parameter_type item to the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• rank (int) – The rank of the type.

• type (str) – The value type.

Returns:

The added item.

Return type:

PublicItem

add_parameter_group(**kwargs)

Adds a parameter_group item to the in-memory mapping.

Parameters:

• name (str) – The parameter group name.

• color (str) – Group’s color as HEX.

• priority (int) – Group’s priority.

Returns:

The added item.

Return type:

PublicItem

add_parameter_definition(**kwargs)

Adds a parameter_definition item to the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The parameter name.

• parameter_group_name (str, optional) – The name of the group of the parameter.

• parameter_type_list (tuple, optional) – List of valid value types.

• default_value (bytes, optional) – The default value’s database representation.

• default_type (str, optional) – The default value’s type.

• parsed_value (ParameterValue, optional) – The default value.

• parameter_value_list_name (str, optional) – The parameter value list name if any.

• description (str, optional) – The parameter description.

Returns:

The added item.

Return type:

PublicItem

add_parameter_value(**kwargs)

Adds a parameter_value item to the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• value (bytes) – The value’s database representation.

• type (str, optional) – The value’s type. Optional only when value is null.

• parsed_value (ParameterValue, optional) – The value.

• alternative_name (str, optional) – The alternative name - defaults to ‘Base’.

Returns:

The added item.

Return type:

PublicItem

add_metadata(**kwargs)

Adds a metadata item to the in-memory mapping.

Parameters:

• name (str) – The metadata entry name.

• value (str) – The metadata entry value.

Returns:

The added item.

Return type:

PublicItem

add_entity_metadata(**kwargs)

Adds an entity_metadata item to the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• metadata_name (str) – The metadata entry name.

• metadata_value (str) – The metadata entry value.

Returns:

The added item.

Return type:

PublicItem

add_parameter_value_metadata(**kwargs)

Adds a parameter_value_metadata item to the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

• metadata_name (str) – The metadata entry name.

• metadata_value (str) – The metadata entry value.

Returns:

The added item.

Return type:

PublicItem

add_entity_location(**kwargs)

Adds an entity_location item to the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• lat (float, optional) – Latitude.

• lon (float, optional) – Longitude.

• alt (float, optional) – Altitude.

• shape_name (str, optional) – Name identifying the shape.

• shape_blob (str, optional) – Shape as GEOJSON feature.

Returns:

The added item.

Return type:

PublicItem

add_alternatives(items)

Adds multiple alternative items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_scenarios(items)

Adds multiple scenario items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_scenario_alternatives(items)

Adds multiple scenario_alternative items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_entity_classes(items)

Adds multiple entity_class items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_display_modes(items)

Adds multiple display_mode items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_entity_class_display_modes(items)

Adds multiple entity_class_display_mode items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_superclass_subclasses(items)

Adds multiple superclass_subclass items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_entities(items)

Adds multiple entity items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_entity_groups(items)

Adds multiple entity_group items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_entity_alternatives(items)

Adds multiple entity_alternative items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_parameter_value_lists(items)

Adds multiple parameter_value_list items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_list_values(items)

Adds multiple list_value items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_parameter_types(items)

Adds multiple parameter_type items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_parameter_groups(items)

Adds multiple parameter_group items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_parameter_definitions(items)

Adds multiple parameter_definition items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_parameter_values(items)

Adds multiple parameter_value items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_metadata_items(items)

Adds multiple metadata items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_entity_metadata_items(items)

Adds multiple entity_metadata items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_parameter_value_metadata_items(items)

Adds multiple parameter_value_metadata items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

add_entity_locations(items)

Adds multiple entity_location items to the in-memory mapping.

Parameters:

items (list of dict) – items to add

update_alternative(**kwargs)

Updates an alternative item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• name (str) – The alternative name.

• description (str, optional) – The alternative description.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_scenario(**kwargs)

Updates a scenario item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• name (str) – The scenario name.

• description (str, optional) – The scenario description.

• active (bool, optional) – Not in use at the moment.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_scenario_alternative(**kwargs)

Updates a scenario_alternative item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• scenario_name (str) – The scenario name.

• alternative_name (str) – The alternative name.

• rank (int) – The rank - higher has precedence.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_entity_class(**kwargs)

Updates an entity_class item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• name (str) – The class name.

• dimension_name_list (tuple, optional) – The dimension names for a multi-dimensional class.

• entity_class_byname (tuple) – A tuple with the class name as single element if the class is 0-dimensional, or the 0-dimensional class names if it is multi-dimensional.

• description (str, optional) – The class description.

• display_icon (int, optional) – An integer representing an icon within your application.

• display_order (int, optional) – Not in use at the moment.

• hidden (int, optional) – Not in use at the moment.

• active_by_default (bool, optional) – Default activity for the entity alternatives of the class.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_display_mode(**kwargs)

Updates a display_mode item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• name (str) – The display mode name.

• description (str, optional) – The display mode description.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_entity_class_display_mode(**kwargs)

Updates an entity_class_display_mode item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• entity_class_name (str) – The entity class name.

• display_mode_name (int) – The display mode name.

• display_order (int) – The display order.

• display_status (str) – The display status; one of ‘visible’, ‘hidden’ or ‘greyed_out’.

• display_font_color (str, optional) – The color of the font.

• display_background_color (str, optional) – The color of the background.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_superclass_subclass(**kwargs)

Updates a superclass_subclass item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• superclass_name (str) – The superclass name.

• subclass_name (str) – The subclass name.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_entity(**kwargs)

Updates an entity item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• entity_class_name (str) – The entity class name.

• name (str) – The entity name.

• element_name_list (tuple) – The element names if the entity is multi-dimensional.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• description (str, optional) – The entity description.

• lat (float, optional) – The latitude of entity.

• lon (float, optional) – The longitude of entity.

• alt (float, optional) – The altitude of entity.

• shape_name (str, optional) – The name of the entity’s shape.

• shape_blob (str, optional) – The shape as GEOJSON string.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_entity_group(**kwargs)

Updates an entity_group item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• entity_class_name (str) – The entity class name.

• group_name (str) – The group entity name.

• member_name (str) – The member entity name.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_entity_alternative(**kwargs)

Updates an entity_alternative item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

• active (bool, optional) – Whether the entity is active in the alternative - defaults to True.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_parameter_value_list(**kwargs)

Updates a parameter_value_list item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• name (str) – The parameter value list name.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_list_value(**kwargs)

Updates a list_value item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• parameter_value_list_name (str) – The parameter value list name.

• value (bytes) – The value’s database representation.

• type (str, optional) – The value’s type.

• parsed_value (ParameterValue, optional) – The value.

• index (int, optional) – The value index.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_parameter_type(**kwargs)

Updates a parameter_type item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• rank (int) – The rank of the type.

• type (str) – The value type.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_parameter_group(**kwargs)

Updates a parameter_group item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• name (str) – The parameter group name.

• color (str) – Group’s color as HEX.

• priority (int) – Group’s priority.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_parameter_definition(**kwargs)

Updates a parameter_definition item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• entity_class_name (str) – The entity class name.

• name (str) – The parameter name.

• parameter_group_name (str, optional) – The name of the group of the parameter.

• parameter_type_list (tuple, optional) – List of valid value types.

• default_value (bytes, optional) – The default value’s database representation.

• default_type (str, optional) – The default value’s type.

• parsed_value (ParameterValue, optional) – The default value.

• parameter_value_list_name (str, optional) – The parameter value list name if any.

• description (str, optional) – The parameter description.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_parameter_value(**kwargs)

Updates a parameter_value item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• value (bytes) – The value’s database representation.

• type (str, optional) – The value’s type. Optional only when value is null.

• parsed_value (ParameterValue, optional) – The value.

• alternative_name (str, optional) – The alternative name - defaults to ‘Base’.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_metadata(**kwargs)

Updates a metadata item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• name (str) – The metadata entry name.

• value (str) – The metadata entry value.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_entity_metadata(**kwargs)

Updates an entity_metadata item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• metadata_name (str) – The metadata entry name.

• metadata_value (str) – The metadata entry value.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_parameter_value_metadata(**kwargs)

Updates a parameter_value_metadata item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

• metadata_name (str) – The metadata entry name.

• metadata_value (str) – The metadata entry value.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_entity_location(**kwargs)

Updates an entity_location item in the in-memory mapping.

Parameters:

• id (int) – The id of the item to update.

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• lat (float, optional) – Latitude.

• lon (float, optional) – Longitude.

• alt (float, optional) – Altitude.

• shape_name (str, optional) – Name identifying the shape.

• shape_blob (str, optional) – Shape as GEOJSON feature.

Returns:

The updated item or None if nothing was updated.

Return type:

PublicItem or None

update_alternatives(items)

Updates multiple alternative items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_scenarios(items)

Updates multiple scenario items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_scenario_alternatives(items)

Updates multiple scenario_alternative items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_entity_classes(items)

Updates multiple entity_class items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_display_modes(items)

Updates multiple display_mode items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_entity_class_display_modes(items)

Updates multiple entity_class_display_mode items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_superclass_subclasses(items)

Updates multiple superclass_subclass items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_entities(items)

Updates multiple entity items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_entity_groups(items)

Updates multiple entity_group items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_entity_alternatives(items)

Updates multiple entity_alternative items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_parameter_value_lists(items)

Updates multiple parameter_value_list items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_list_values(items)

Updates multiple list_value items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_parameter_types(items)

Updates multiple parameter_type items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_parameter_groups(items)

Updates multiple parameter_group items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_parameter_definitions(items)

Updates multiple parameter_definition items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_parameter_values(items)

Updates multiple parameter_value items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_metadata_items(items)

Updates multiple metadata items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_entity_metadata_items(items)

Updates multiple entity_metadata items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_parameter_value_metadata_items(items)

Updates multiple parameter_value_metadata items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

update_entity_locations(items)

Updates multiple entity_location items in the in-memory mapping.

Parameters:

items (list of dict) – items to update

add_or_update_alternative(**kwargs)

Adds an alternative item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• name (str) – The alternative name.

• description (str, optional) – The alternative description.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_scenario(**kwargs)

Adds a scenario item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• name (str) – The scenario name.

• description (str, optional) – The scenario description.

• active (bool, optional) – Not in use at the moment.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_scenario_alternative(**kwargs)

Adds a scenario_alternative item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• scenario_name (str) – The scenario name.

• alternative_name (str) – The alternative name.

• rank (int) – The rank - higher has precedence.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_entity_class(**kwargs)

Adds an entity_class item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• name (str) – The class name.

• dimension_name_list (tuple, optional) – The dimension names for a multi-dimensional class.

• entity_class_byname (tuple) – A tuple with the class name as single element if the class is 0-dimensional, or the 0-dimensional class names if it is multi-dimensional.

• description (str, optional) – The class description.

• display_icon (int, optional) – An integer representing an icon within your application.

• display_order (int, optional) – Not in use at the moment.

• hidden (int, optional) – Not in use at the moment.

• active_by_default (bool, optional) – Default activity for the entity alternatives of the class.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_display_mode(**kwargs)

Adds a display_mode item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• name (str) – The display mode name.

• description (str, optional) – The display mode description.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_entity_class_display_mode(**kwargs)

Adds an entity_class_display_mode item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• entity_class_name (str) – The entity class name.

• display_mode_name (int) – The display mode name.

• display_order (int) – The display order.

• display_status (str) – The display status; one of ‘visible’, ‘hidden’ or ‘greyed_out’.

• display_font_color (str, optional) – The color of the font.

• display_background_color (str, optional) – The color of the background.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_superclass_subclass(**kwargs)

Adds a superclass_subclass item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• superclass_name (str) – The superclass name.

• subclass_name (str) – The subclass name.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_entity(**kwargs)

Adds an entity item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The entity name.

• element_name_list (tuple) – The element names if the entity is multi-dimensional.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• description (str, optional) – The entity description.

• lat (float, optional) – The latitude of entity.

• lon (float, optional) – The longitude of entity.

• alt (float, optional) – The altitude of entity.

• shape_name (str, optional) – The name of the entity’s shape.

• shape_blob (str, optional) – The shape as GEOJSON string.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_entity_group(**kwargs)

Adds an entity_group item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• entity_class_name (str) – The entity class name.

• group_name (str) – The group entity name.

• member_name (str) – The member entity name.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_entity_alternative(**kwargs)

Adds an entity_alternative item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

• active (bool, optional) – Whether the entity is active in the alternative - defaults to True.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_parameter_value_list(**kwargs)

Adds a parameter_value_list item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

name (str) – The parameter value list name.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_list_value(**kwargs)

Adds a list_value item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• parameter_value_list_name (str) – The parameter value list name.

• value (bytes) – The value’s database representation.

• type (str, optional) – The value’s type.

• parsed_value (ParameterValue, optional) – The value.

• index (int, optional) – The value index.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_parameter_type(**kwargs)

Adds a parameter_type item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• rank (int) – The rank of the type.

• type (str) – The value type.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_parameter_group(**kwargs)

Adds a parameter_group item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• name (str) – The parameter group name.

• color (str) – Group’s color as HEX.

• priority (int) – Group’s priority.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_parameter_definition(**kwargs)

Adds a parameter_definition item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The parameter name.

• parameter_group_name (str, optional) – The name of the group of the parameter.

• parameter_type_list (tuple, optional) – List of valid value types.

• default_value (bytes, optional) – The default value’s database representation.

• default_type (str, optional) – The default value’s type.

• parsed_value (ParameterValue, optional) – The default value.

• parameter_value_list_name (str, optional) – The parameter value list name if any.

• description (str, optional) – The parameter description.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_parameter_value(**kwargs)

Adds a parameter_value item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• value (bytes) – The value’s database representation.

• type (str, optional) – The value’s type. Optional only when value is null.

• parsed_value (ParameterValue, optional) – The value.

• alternative_name (str, optional) – The alternative name - defaults to ‘Base’.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_metadata(**kwargs)

Adds a metadata item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• name (str) – The metadata entry name.

• value (str) – The metadata entry value.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_entity_metadata(**kwargs)

Adds an entity_metadata item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• metadata_name (str) – The metadata entry name.

• metadata_value (str) – The metadata entry value.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_parameter_value_metadata(**kwargs)

Adds a parameter_value_metadata item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

• metadata_name (str) – The metadata entry name.

• metadata_value (str) – The metadata entry value.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_entity_location(**kwargs)

Adds an entity_location item to the in-memory mapping if it doesn’t exist; otherwise updates the current one.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• lat (float, optional) – Latitude.

• lon (float, optional) – Longitude.

• alt (float, optional) – Altitude.

• shape_name (str, optional) – Name identifying the shape.

• shape_blob (str, optional) – Shape as GEOJSON feature.

Returns:

The added or updated item or None if nothing was added or updated.

Return type:

PublicItem or None

add_or_update_alternatives(items)

Adds multiple alternative items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_scenarios(items)

Adds multiple scenario items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_scenario_alternatives(items)

Adds multiple scenario_alternative items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_entity_classes(items)

Adds multiple entity_class items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_display_modes(items)

Adds multiple display_mode items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_entity_class_display_modes(items)

Adds multiple entity_class_display_mode items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_superclass_subclasses(items)

Adds multiple superclass_subclass items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_entities(items)

Adds multiple entity items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_entity_groups(items)

Adds multiple entity_group items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_entity_alternatives(items)

Adds multiple entity_alternative items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_parameter_value_lists(items)

Adds multiple parameter_value_list items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_list_values(items)

Adds multiple list_value items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_parameter_types(items)

Adds multiple parameter_type items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_parameter_groups(items)

Adds multiple parameter_group items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_parameter_definitions(items)

Adds multiple parameter_definition items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_parameter_values(items)

Adds multiple parameter_value items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_metadata_items(items)

Adds multiple metadata items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_entity_metadata_items(items)

Adds multiple entity_metadata items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_parameter_value_metadata_items(items)

Adds multiple parameter_value_metadata items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

add_or_update_entity_locations(items)

Adds multiple entity_location items to the in-memory mapping if they don’t exist; otherwise updates the items.

Parameters:

items (list of dict) – items to add or update

remove_alternative(**kwargs)

Removes an alternative item from the in-memory mapping.

Parameters:

• name (str) – The alternative name.

• description (str, optional) – The alternative description.

remove_scenario(**kwargs)

Removes a scenario item from the in-memory mapping.

Parameters:

• name (str) – The scenario name.

• description (str, optional) – The scenario description.

• active (bool, optional) – Not in use at the moment.

remove_scenario_alternative(**kwargs)

Removes a scenario_alternative item from the in-memory mapping.

Parameters:

• scenario_name (str) – The scenario name.

• alternative_name (str) – The alternative name.

• rank (int) – The rank - higher has precedence.

remove_entity_class(**kwargs)

Removes an entity_class item from the in-memory mapping.

Parameters:

• name (str) – The class name.

• dimension_name_list (tuple, optional) – The dimension names for a multi-dimensional class.

• entity_class_byname (tuple) – A tuple with the class name as single element if the class is 0-dimensional, or the 0-dimensional class names if it is multi-dimensional.

• description (str, optional) – The class description.

• display_icon (int, optional) – An integer representing an icon within your application.

• display_order (int, optional) – Not in use at the moment.

• hidden (int, optional) – Not in use at the moment.

• active_by_default (bool, optional) – Default activity for the entity alternatives of the class.

remove_display_mode(**kwargs)

Removes a display_mode item from the in-memory mapping.

Parameters:

• name (str) – The display mode name.

• description (str, optional) – The display mode description.

remove_entity_class_display_mode(**kwargs)

Removes an entity_class_display_mode item from the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• display_mode_name (int) – The display mode name.

• display_order (int) – The display order.

• display_status (str) – The display status; one of ‘visible’, ‘hidden’ or ‘greyed_out’.

• display_font_color (str, optional) – The color of the font.

• display_background_color (str, optional) – The color of the background.

remove_superclass_subclass(**kwargs)

Removes a superclass_subclass item from the in-memory mapping.

Parameters:

• superclass_name (str) – The superclass name.

• subclass_name (str) – The subclass name.

remove_entity(**kwargs)

Removes an entity item from the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The entity name.

• element_name_list (tuple) – The element names if the entity is multi-dimensional.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• description (str, optional) – The entity description.

• lat (float, optional) – The latitude of entity.

• lon (float, optional) – The longitude of entity.

• alt (float, optional) – The altitude of entity.

• shape_name (str, optional) – The name of the entity’s shape.

• shape_blob (str, optional) – The shape as GEOJSON string.

remove_entity_group(**kwargs)

Removes an entity_group item from the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• group_name (str) – The group entity name.

• member_name (str) – The member entity name.

remove_entity_alternative(**kwargs)

Removes an entity_alternative item from the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

• active (bool, optional) – Whether the entity is active in the alternative - defaults to True.

remove_parameter_value_list(**kwargs)

Removes a parameter_value_list item from the in-memory mapping.

Parameters:

name (str) – The parameter value list name.

remove_list_value(**kwargs)

Removes a list_value item from the in-memory mapping.

Parameters:

• parameter_value_list_name (str) – The parameter value list name.

• value (bytes) – The value’s database representation.

• type (str, optional) – The value’s type.

• parsed_value (ParameterValue, optional) – The value.

• index (int, optional) – The value index.

remove_parameter_type(**kwargs)

Removes a parameter_type item from the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• rank (int) – The rank of the type.

• type (str) – The value type.

remove_parameter_group(**kwargs)

Removes a parameter_group item from the in-memory mapping.

Parameters:

• name (str) – The parameter group name.

• color (str) – Group’s color as HEX.

• priority (int) – Group’s priority.

remove_parameter_definition(**kwargs)

Removes a parameter_definition item from the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The parameter name.

• parameter_group_name (str, optional) – The name of the group of the parameter.

• parameter_type_list (tuple, optional) – List of valid value types.

• default_value (bytes, optional) – The default value’s database representation.

• default_type (str, optional) – The default value’s type.

• parsed_value (ParameterValue, optional) – The default value.

• parameter_value_list_name (str, optional) – The parameter value list name if any.

• description (str, optional) – The parameter description.

remove_parameter_value(**kwargs)

Removes a parameter_value item from the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• value (bytes) – The value’s database representation.

• type (str, optional) – The value’s type. Optional only when value is null.

• parsed_value (ParameterValue, optional) – The value.

• alternative_name (str, optional) – The alternative name - defaults to ‘Base’.

remove_metadata(**kwargs)

Removes a metadata item from the in-memory mapping.

Parameters:

• name (str) – The metadata entry name.

• value (str) – The metadata entry value.

remove_entity_metadata(**kwargs)

Removes an entity_metadata item from the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• metadata_name (str) – The metadata entry name.

• metadata_value (str) – The metadata entry value.

remove_parameter_value_metadata(**kwargs)

Removes a parameter_value_metadata item from the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

• metadata_name (str) – The metadata entry name.

• metadata_value (str) – The metadata entry value.

remove_entity_location(**kwargs)

Removes an entity_location item from the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• lat (float, optional) – Latitude.

• lon (float, optional) – Longitude.

• alt (float, optional) – Altitude.

• shape_name (str, optional) – Name identifying the shape.

• shape_blob (str, optional) – Shape as GEOJSON feature.

remove_alternatives(items)

Removes multiple alternative items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_scenarios(items)

Removes multiple scenario items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_scenario_alternatives(items)

Removes multiple scenario_alternative items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_entity_classes(items)

Removes multiple entity_class items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_display_modes(items)

Removes multiple display_mode items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_entity_class_display_modes(items)

Removes multiple entity_class_display_mode items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_superclass_subclasses(items)

Removes multiple superclass_subclass items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_entities(items)

Removes multiple entity items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_entity_groups(items)

Removes multiple entity_group items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_entity_alternatives(items)

Removes multiple entity_alternative items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_parameter_value_lists(items)

Removes multiple parameter_value_list items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_list_values(items)

Removes multiple list_value items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_parameter_types(items)

Removes multiple parameter_type items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_parameter_groups(items)

Removes multiple parameter_group items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_parameter_definitions(items)

Removes multiple parameter_definition items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_parameter_values(items)

Removes multiple parameter_value items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_metadata_items(items)

Removes multiple metadata items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_entity_metadata_items(items)

Removes multiple entity_metadata items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_parameter_value_metadata_items(items)

Removes multiple parameter_value_metadata items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

remove_entity_locations(items)

Removes multiple entity_location items from the in-memory mapping.

Parameters:

items (list of dict) – items to remove

restore_alternative(**kwargs)

Restores a previously removed alternative item into the in-memory mapping.

Parameters:

• name (str) – The alternative name.

• description (str, optional) – The alternative description.

Returns:

The restored item.

Return type:

PublicItem

restore_scenario(**kwargs)

Restores a previously removed scenario item into the in-memory mapping.

Parameters:

• name (str) – The scenario name.

• description (str, optional) – The scenario description.

• active (bool, optional) – Not in use at the moment.

Returns:

The restored item.

Return type:

PublicItem

restore_scenario_alternative(**kwargs)

Restores a previously removed scenario_alternative item into the in-memory mapping.

Parameters:

• scenario_name (str) – The scenario name.

• alternative_name (str) – The alternative name.

• rank (int) – The rank - higher has precedence.

Returns:

The restored item.

Return type:

PublicItem

restore_entity_class(**kwargs)

Restores a previously removed entity_class item into the in-memory mapping.

Parameters:

• name (str) – The class name.

• dimension_name_list (tuple, optional) – The dimension names for a multi-dimensional class.

• entity_class_byname (tuple) – A tuple with the class name as single element if the class is 0-dimensional, or the 0-dimensional class names if it is multi-dimensional.

• description (str, optional) – The class description.

• display_icon (int, optional) – An integer representing an icon within your application.

• display_order (int, optional) – Not in use at the moment.

• hidden (int, optional) – Not in use at the moment.

• active_by_default (bool, optional) – Default activity for the entity alternatives of the class.

Returns:

The restored item.

Return type:

PublicItem

restore_display_mode(**kwargs)

Restores a previously removed display_mode item into the in-memory mapping.

Parameters:

• name (str) – The display mode name.

• description (str, optional) – The display mode description.

Returns:

The restored item.

Return type:

PublicItem

restore_entity_class_display_mode(**kwargs)

Restores a previously removed entity_class_display_mode item into the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• display_mode_name (int) – The display mode name.

• display_order (int) – The display order.

• display_status (str) – The display status; one of ‘visible’, ‘hidden’ or ‘greyed_out’.

• display_font_color (str, optional) – The color of the font.

• display_background_color (str, optional) – The color of the background.

Returns:

The restored item.

Return type:

PublicItem

restore_superclass_subclass(**kwargs)

Restores a previously removed superclass_subclass item into the in-memory mapping.

Parameters:

• superclass_name (str) – The superclass name.

• subclass_name (str) – The subclass name.

Returns:

The restored item.

Return type:

PublicItem

restore_entity(**kwargs)

Restores a previously removed entity item into the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The entity name.

• element_name_list (tuple) – The element names if the entity is multi-dimensional.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• description (str, optional) – The entity description.

• lat (float, optional) – The latitude of entity.

• lon (float, optional) – The longitude of entity.

• alt (float, optional) – The altitude of entity.

• shape_name (str, optional) – The name of the entity’s shape.

• shape_blob (str, optional) – The shape as GEOJSON string.

Returns:

The restored item.

Return type:

PublicItem

restore_entity_group(**kwargs)

Restores a previously removed entity_group item into the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• group_name (str) – The group entity name.

• member_name (str) – The member entity name.

Returns:

The restored item.

Return type:

PublicItem

restore_entity_alternative(**kwargs)

Restores a previously removed entity_alternative item into the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

• active (bool, optional) – Whether the entity is active in the alternative - defaults to True.

Returns:

The restored item.

Return type:

PublicItem

restore_parameter_value_list(**kwargs)

Restores a previously removed parameter_value_list item into the in-memory mapping.

Parameters:

name (str) – The parameter value list name.

Returns:

The restored item.

Return type:

PublicItem

restore_list_value(**kwargs)

Restores a previously removed list_value item into the in-memory mapping.

Parameters:

• parameter_value_list_name (str) – The parameter value list name.

• value (bytes) – The value’s database representation.

• type (str, optional) – The value’s type.

• parsed_value (ParameterValue, optional) – The value.

• index (int, optional) – The value index.

Returns:

The restored item.

Return type:

PublicItem

restore_parameter_type(**kwargs)

Restores a previously removed parameter_type item into the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• rank (int) – The rank of the type.

• type (str) – The value type.

Returns:

The restored item.

Return type:

PublicItem

restore_parameter_group(**kwargs)

Restores a previously removed parameter_group item into the in-memory mapping.

Parameters:

• name (str) – The parameter group name.

• color (str) – Group’s color as HEX.

• priority (int) – Group’s priority.

Returns:

The restored item.

Return type:

PublicItem

restore_parameter_definition(**kwargs)

Restores a previously removed parameter_definition item into the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• name (str) – The parameter name.

• parameter_group_name (str, optional) – The name of the group of the parameter.

• parameter_type_list (tuple, optional) – List of valid value types.

• default_value (bytes, optional) – The default value’s database representation.

• default_type (str, optional) – The default value’s type.

• parsed_value (ParameterValue, optional) – The default value.

• parameter_value_list_name (str, optional) – The parameter value list name if any.

• description (str, optional) – The parameter description.

Returns:

The restored item.

Return type:

PublicItem

restore_parameter_value(**kwargs)

Restores a previously removed parameter_value item into the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• value (bytes) – The value’s database representation.

• type (str, optional) – The value’s type. Optional only when value is null.

• parsed_value (ParameterValue, optional) – The value.

• alternative_name (str, optional) – The alternative name - defaults to ‘Base’.

Returns:

The restored item.

Return type:

PublicItem

restore_metadata(**kwargs)

Restores a previously removed metadata item into the in-memory mapping.

Parameters:

• name (str) – The metadata entry name.

• value (str) – The metadata entry value.

Returns:

The restored item.

Return type:

PublicItem

restore_entity_metadata(**kwargs)

Restores a previously removed entity_metadata item into the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• metadata_name (str) – The metadata entry name.

• metadata_value (str) – The metadata entry value.

Returns:

The restored item.

Return type:

PublicItem

restore_parameter_value_metadata(**kwargs)

Restores a previously removed parameter_value_metadata item into the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• parameter_definition_name (str) – The parameter name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• alternative_name (str) – The alternative name.

• metadata_name (str) – The metadata entry name.

• metadata_value (str) – The metadata entry value.

Returns:

The restored item.

Return type:

PublicItem

restore_entity_location(**kwargs)

Restores a previously removed entity_location item into the in-memory mapping.

Parameters:

• entity_class_name (str) – The entity class name.

• entity_byname (tuple) – A tuple with the entity name as single element if the entity is 0-dimensional, or the 0-dimensional element names if it is multi-dimensional.

• lat (float, optional) – Latitude.

• lon (float, optional) – Longitude.

• alt (float, optional) – Altitude.

• shape_name (str, optional) – Name identifying the shape.

• shape_blob (str, optional) – Shape as GEOJSON feature.

Returns:

The restored item.

Return type:

PublicItem

restore_alternatives(items)

Restores multiple alternative items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_scenarios(items)

Restores multiple scenario items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_scenario_alternatives(items)

Restores multiple scenario_alternative items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_entity_classes(items)

Restores multiple entity_class items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_display_modes(items)

Restores multiple display_mode items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_entity_class_display_modes(items)

Restores multiple entity_class_display_mode items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_superclass_subclasses(items)

Restores multiple superclass_subclass items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_entities(items)

Restores multiple entity items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_entity_groups(items)

Restores multiple entity_group items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_entity_alternatives(items)

Restores multiple entity_alternative items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_parameter_value_lists(items)

Restores multiple parameter_value_list items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_list_values(items)

Restores multiple list_value items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_parameter_types(items)

Restores multiple parameter_type items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_parameter_groups(items)

Restores multiple parameter_group items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_parameter_definitions(items)

Restores multiple parameter_definition items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_parameter_values(items)

Restores multiple parameter_value items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_metadata_items(items)

Restores multiple metadata items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_entity_metadata_items(items)

Restores multiple entity_metadata items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_parameter_value_metadata_items(items)

Restores multiple parameter_value_metadata items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore

restore_entity_locations(items)

Restores multiple entity_location items back into the in-memory mapping.

Parameters:

items (list of dict) – items to restore