spinetoolbox.spine_db_manager

The SpineDBManager class

authors:

16. Vennström (VTT) and M. Marin (KTH)

date:

2.10.2019

Module Contents

spinetoolbox.spine_db_manager.do_create_new_spine_database(url, for_spine_model)

Creates a new spine database at the given url.

class spinetoolbox.spine_db_manager.SpineDBManager(logger, project)

Bases: PySide2.QtCore.QObject

Class to manage DBs within a project.

TODO: Expand description, how it works, the cache, the signals, etc.

Initializes the instance.

Parameters:

• logger (LoggingInterface) – a general, non-database-specific logger
• project (SpineToolboxProject) –

session_refreshed

session_committed

session_rolled_back

object_classes_added

objects_added

relationship_classes_added

relationships_added

parameter_definitions_added

_parameter_definitions_added

parameter_values_added

_parameter_values_added

parameter_value_lists_added

parameter_tags_added

object_classes_removed

objects_removed

relationship_classes_removed

relationships_removed

parameter_definitions_removed

parameter_values_removed

parameter_value_lists_removed

parameter_tags_removed

object_classes_updated

objects_updated

relationship_classes_updated

relationships_updated

parameter_definitions_updated

_parameter_definitions_updated

parameter_values_updated

_parameter_values_updated

parameter_value_lists_updated

parameter_tags_updated

parameter_definition_tags_set

items_removed_from_cache

_GROUP_SEP = ǀ

db_maps

create_new_spine_database(self, url, for_spine_model=False)

close_session(self, url)

Pops any db map on the given url and closes its connection.

Parameters:url (str) –

close_all_sessions(self)

Closes connections to all database mappings.

get_db_map(self, url, upgrade=False, codename=None)

Returns a DiffDatabaseMapping instance from url if possible, None otherwise. If needed, asks the user to upgrade to the latest db version.

Parameters:

• url (str, URL) –
• upgrade (bool, optional) –
• codename (str, NoneType, optional) –

Returns:

DiffDatabaseMapping, NoneType

do_get_db_map(self, url, upgrade, codename)

Returns a memorized DiffDatabaseMapping instance from url. Called by get_db_map.

Parameters:

• url (str, URL) –
• upgrade (bool, optional) –
• codename (str, NoneType, optional) –

Returns:

DiffDatabaseMapping

get_db_map_for_listener(self, listener, url, upgrade=False, codename=None)

remove_db_map_listener(self, db_map, listener)

set_logger_for_db_map(self, logger, db_map)

unset_logger_for_db_map(self, db_map)

refresh_session(self, *db_maps)

commit_session(self, *db_maps)

static _get_commit_msg(db_map)

rollback_session(self, *db_maps)

_commit_db_map_session(self, db_map)

_rollback_db_map_session(self, db_map)

ok_to_close(self, db_map)

Prompts the user to commit or rollback changes to given database map.

Returns:True if successfully committed or rolled back, False otherwise Return type:bool

connect_signals(self)

Connects signals.

error_msg(self, db_map_error_log)

cache_items(self, item_type, db_map_data)

Caches data for a given type. It works for both insert and update operations.

Parameters:

• item_type (str) –
• db_map_data (dict) – lists of dictionary items keyed by DiffDatabaseMapping

cache_parameter_definition_tags(self, db_map_data)

Caches parameter definition tags in the parameter definition dictionary.

Parameters:db_map_data (dict) – lists of parameter definition items keyed by DiffDatabaseMapping

uncache_items(self, item_type, db_map_data)

Removes data from cache.

Parameters:

• item_type (str) –
• db_map_data (dict) – lists of dictionary items keyed by DiffDatabaseMapping

update_icons(self, db_map_data)

Runs when object classes are added or updated. Setups icons for those classes. :param item_type: :type item_type: str :param db_map_data: lists of dictionary items keyed by DiffDatabaseMapping :type db_map_data: dict

entity_class_icon(self, db_map, entity_type, entity_class_id)

Returns an appropriate icon for a given entity class.

Parameters:

• db_map (DiffDatabaseMapping) –
• entity_type (str) – either ‘object class’ or ‘relationship class’
• entity_class_id (int) –

Returns:

QIcon

get_item(self, db_map, item_type, id_)

Returns the item of the given type in the given db map that has the given id, or an empty dict if not found.

Parameters:

• db_map (DiffDatabaseMapping) –
• item_type (str) –
• id (int) –

Returns:

dict

get_item_by_field(self, db_map, item_type, field, value)

Returns the first item of the given type in the given db map that has the given value for the given field Returns an empty dictionary if none found.

Parameters:

• db_map (DiffDatabaseMapping) –
• item_type (str) –
• field (str) –
• value –

Returns:

dict

get_items_by_field(self, db_map, item_type, field, value)

Returns all items of the given type in the given db map that have the given value for the given field. Returns an empty list if none found.

Parameters:

• db_map (DiffDatabaseMapping) –
• item_type (str) –
• field (str) –
• value –

Returns:

list

get_items(self, db_map, item_type)

Returns all the items of the given type in the given db map, or an empty list if none found.

Parameters:

• db_map (DiffDatabaseMapping) –
• item_type (str) –

Returns:

list

_get_items_from_db(self, db_map, item_type)

Returns all items of the given type in the given db map. Called by the above methods whenever they don’t find what they’re looking for in cache.

get_field(self, db_map, item_type, id_, field)

get_value(self, db_map, item_type, id_, field, role=Qt.DisplayRole)

Returns the value or default value of a parameter.

Parameters:

• db_map (DiffDatabaseMapping) –
• item_type (str) – either “parameter definition” or “parameter value”
• id (int) –
• field (str) – either “value” or “default_value”
• role (int, optional) –

parse_value(self, value)

static _display_data(parsed_value)

Returns the value’s database representation formatted for Qt.DisplayRole.

static _tool_tip_data(parsed_value)

Returns the value’s database representation formatted for Qt.ToolTipRole.

get_object_classes(self, db_map, cache=True)

Returns object classes from database.

Parameters:db_map (DiffDatabaseMapping) – Returns:dictionary items Return type:list

get_objects(self, db_map, class_id=None, cache=True)

Returns objects from database.

Parameters:

• db_map (DiffDatabaseMapping) –
• class_id (int, optional) –

Returns:

dictionary items

Return type:

list

get_relationship_classes(self, db_map, ids=None, object_class_id=None, cache=True)

Returns relationship classes from database.

Parameters:

• db_map (DiffDatabaseMapping) –
• ids (set, optional) –
• object_class_id (int, optional) –

Returns:

dictionary items

Return type:

list

get_relationships(self, db_map, ids=None, class_id=None, object_id=None, cache=True)

Returns relationships from database.

Parameters:

• db_map (DiffDatabaseMapping) –
• ids (set, optional) –
• class_id (int, optional) –
• object_id (int, optional) –

Returns:

dictionary items

Return type:

list

get_object_parameter_definitions(self, db_map, ids=None, object_class_id=None, cache=True)

Returns object parameter definitions from database.

Parameters:

• db_map (DiffDatabaseMapping) –
• ids (set, optional) –
• object_class_id (int, optional) –

Returns:

dictionary items

Return type:

list

get_relationship_parameter_definitions(self, db_map, ids=None, relationship_class_id=None, cache=True)

Returns relationship parameter definitions from database.

Parameters:

• db_map (DiffDatabaseMapping) –
• ids (set, optional) –
• relationship_class_id (int, optional) –

Returns:

dictionary items

Return type:

list

get_object_parameter_values(self, db_map, ids=None, object_class_id=None, cache=True)

Returns object parameter values from database.

Parameters:

• db_map (DiffDatabaseMapping) –
• ids (set) –
• object_class_id (int) –

Returns:

dictionary items

Return type:

list

get_relationship_parameter_values(self, db_map, ids=None, relationship_class_id=None, cache=True)

Returns relationship parameter values from database.

Parameters:

• db_map (DiffDatabaseMapping) –
• ids (set) –
• relationship_class_id (int) –

Returns:

dictionary items

Return type:

list

get_parameter_definitions(self, db_map, ids=None, entity_class_id=None, cache=True)

Returns both object and relationship parameter definitions.

Parameters:

• db_map (DiffDatabaseMapping) –
• ids (set, optional) –
• entity_class_id (int, optional) –

Returns:

dictionary items

Return type:

list

get_parameter_values(self, db_map, ids=None, entity_class_id=None, cache=True)

Returns both object and relationship parameter values.

Parameters:

• db_map (DiffDatabaseMapping) –
• ids (set, optional) –
• entity_class_id (int, optional) –

Returns:

dictionary items

Return type:

list

get_parameter_value_lists(self, db_map, cache=True)

Returns parameter value lists from database.

Parameters:db_map (DiffDatabaseMapping) – Returns:dictionary items Return type:list

get_parameter_tags(self, db_map, cache=True)

Get parameter tags from database.

Parameters:db_map (DiffDatabaseMapping) – Returns:dictionary items Return type:list

add_or_update_items(self, db_map_data, method_name, signal_name)

Adds or updates items in db.

Parameters:

• db_map_data (dict) – lists of items to add or update keyed by DiffDatabaseMapping
• method_name (str) – attribute of DiffDatabaseMapping to call for performing the operation
• signal_name (str) – signal attribute of SpineDBManager to emit if successful

add_object_classes(self, db_map_data)

Adds object classes to db.

Parameters:db_map_data (dict) – lists of items to add keyed by DiffDatabaseMapping

add_objects(self, db_map_data)

Adds objects to db.

Parameters:db_map_data (dict) – lists of items to add keyed by DiffDatabaseMapping

add_relationship_classes(self, db_map_data)

Adds relationship classes to db.

Parameters:db_map_data (dict) – lists of items to add keyed by DiffDatabaseMapping

add_relationships(self, db_map_data)

Adds relationships to db.

Parameters:db_map_data (dict) – lists of items to add keyed by DiffDatabaseMapping

add_parameter_definitions(self, db_map_data)

Adds parameter definitions to db.

Parameters:db_map_data (dict) – lists of items to add keyed by DiffDatabaseMapping

add_parameter_values(self, db_map_data)

Adds parameter values to db.

Parameters:db_map_data (dict) – lists of items to add keyed by DiffDatabaseMapping

add_checked_parameter_values(self, db_map_data)

Adds parameter values in db without checking integrity.

Parameters:db_map_data (dict) – lists of items to add keyed by DiffDatabaseMapping

add_parameter_value_lists(self, db_map_data)

Adds parameter value lists to db.

Parameters:db_map_data (dict) – lists of items to add keyed by DiffDatabaseMapping

add_parameter_tags(self, db_map_data)

Adds parameter tags to db.

Parameters:db_map_data (dict) – lists of items to add keyed by DiffDatabaseMapping

update_object_classes(self, db_map_data)

Updates object classes in db.

Parameters:db_map_data (dict) – lists of items to update keyed by DiffDatabaseMapping

update_objects(self, db_map_data)

Updates objects in db.

Parameters:db_map_data (dict) – lists of items to update keyed by DiffDatabaseMapping

update_relationship_classes(self, db_map_data)

Updates relationship classes in db.

Parameters:db_map_data (dict) – lists of items to update keyed by DiffDatabaseMapping

update_relationships(self, db_map_data)

Updates relationships in db.

Parameters:db_map_data (dict) – lists of items to update keyed by DiffDatabaseMapping

update_parameter_definitions(self, db_map_data)

Updates parameter definitions in db.

Parameters:db_map_data (dict) – lists of items to update keyed by DiffDatabaseMapping

update_parameter_values(self, db_map_data)

Updates parameter values in db.

Parameters:db_map_data (dict) – lists of items to update keyed by DiffDatabaseMapping

update_checked_parameter_values(self, db_map_data)

Updates parameter values in db without checking integrity.

Parameters:db_map_data (dict) – lists of items to update keyed by DiffDatabaseMapping

update_parameter_value_lists(self, db_map_data)

Updates parameter value lists in db.

Parameters:db_map_data (dict) – lists of items to update keyed by DiffDatabaseMapping

update_parameter_tags(self, db_map_data)

Updates parameter tags in db.

Parameters:db_map_data (dict) – lists of items to update keyed by DiffDatabaseMapping

set_parameter_definition_tags(self, db_map_data)

Sets parameter definition tags in db.

Parameters:db_map_data (dict) – lists of items to set keyed by DiffDatabaseMapping

remove_items(self, db_map_typed_data)

do_remove_items(self, db_map_typed_data)

Removes items from database.

Parameters:db_map_typed_data (dict) – lists of items to remove, keyed by item type (str), keyed by DiffDatabaseMapping

static _to_ids(db_map_data)

cascade_remove_objects(self, db_map_data)

Removes objects in cascade when removing object classes.

Parameters:db_map_data (dict) – lists of removed items keyed by DiffDatabaseMapping

cascade_remove_relationship_classes(self, db_map_data)

Removes relationship classes in cascade when removing object classes.

Parameters:db_map_data (dict) – lists of removed items keyed by DiffDatabaseMapping

cascade_remove_relationships_by_class(self, db_map_data)

Removes relationships in cascade when removing objects.

Parameters:db_map_data (dict) – lists of removed items keyed by DiffDatabaseMapping

cascade_remove_relationships_by_object(self, db_map_data)

Removes relationships in cascade when removing relationship classes.

Parameters:db_map_data (dict) – lists of removed items keyed by DiffDatabaseMapping

cascade_remove_parameter_definitions(self, db_map_data)

Removes parameter definitions in cascade when removing entity classes.

Parameters:db_map_data (dict) – lists of removed items keyed by DiffDatabaseMapping

cascade_remove_parameter_values_by_entity_class(self, db_map_data)

Removes parameter values in cascade when removing entity classes.

Parameters:db_map_data (dict) – lists of removed items keyed by DiffDatabaseMapping

cascade_remove_parameter_values_by_entity(self, db_map_data)

Removes parameter values in cascade when removing entity classes when removing entities.

Parameters:db_map_data (dict) – lists of removed items keyed by DiffDatabaseMapping

cascade_remove_parameter_values_by_definition(self, db_map_data)

Removes parameter values in cascade when when removing parameter definitions.

Parameters:db_map_data (dict) – lists of removed items keyed by DiffDatabaseMapping

cascade_refresh_relationship_classes(self, db_map_data)

Refreshes cached relationship classes when updating object classes.

Parameters:db_map_data (dict) – lists of updated items keyed by DiffDatabaseMapping

cascade_refresh_relationships_by_object(self, db_map_data)

Refreshed cached relationships in cascade when updating objects.

Parameters:db_map_data (dict) – lists of updated items keyed by DiffDatabaseMapping

cascade_refresh_parameter_definitions(self, db_map_data)

Refreshes cached parameter definitions in cascade when updating entity classes.

Parameters:db_map_data (dict) – lists of updated items keyed by DiffDatabaseMapping

cascade_refresh_parameter_definitions_by_value_list(self, db_map_data)

Refreshes cached parameter definitions when updating parameter value lists.

Parameters:db_map_data (dict) – lists of updated items keyed by DiffDatabaseMapping

cascade_refresh_parameter_definitions_by_tag(self, db_map_data)

Refreshes cached parameter definitions when updating parameter tags.

Parameters:db_map_data (dict) – lists of updated items keyed by DiffDatabaseMapping

cascade_refresh_parameter_values_by_entity_class(self, db_map_data)

Refreshes cached parameter values in cascade when updating entity classes.

Parameters:db_map_data (dict) – lists of updated items keyed by DiffDatabaseMapping

cascade_refresh_parameter_values_by_entity(self, db_map_data)

Refreshes cached parameter values in cascade when updating entities.

Parameters:db_map_data (dict) – lists of updated items keyed by DiffDatabaseMapping

cascade_refresh_parameter_values_by_definition(self, db_map_data)

Refreshes cached parameter values in cascade when updating parameter definitions.

Parameters:db_map_data (dict) – lists of updated items keyed by DiffDatabaseMapping

find_cascading_relationship_classes(self, db_map_ids)

Finds and returns cascading relationship classes for the given object class ids.

find_cascading_entities(self, db_map_ids, item_type)

Finds and returns cascading entities for the given entity class ids.

find_cascading_relationships(self, db_map_ids)

Finds and returns cascading relationships for the given object ids.

find_cascading_parameter_data(self, db_map_ids, item_type)

Finds and returns cascading parameter definitions or values for the given entity class ids.

find_cascading_parameter_definitions_by_value_list(self, db_map_ids)

Finds and returns cascading parameter definitions for the given parameter value list ids.

find_cascading_parameter_definitions_by_tag(self, db_map_ids)

Finds and returns cascading parameter definitions for the given parameter tag ids.

find_cascading_parameter_values_by_entity(self, db_map_ids)

Finds and returns cascading parameter values for the given entity ids.

find_cascading_parameter_values_by_definition(self, db_map_ids)

Finds and returns cascading parameter values for the given parameter definition ids.

do_add_parameter_definitions(self, db_map_data)

Adds parameter definitions in extended format given data in compact format.

Parameters:db_map_data (dict) – lists of parameter definition items keyed by DiffDatabaseMapping

do_add_parameter_values(self, db_map_data)

Adds parameter values in extended format given data in compact format.

Parameters:db_map_data (dict) – lists of parameter value items keyed by DiffDatabaseMapping

do_update_parameter_definitions(self, db_map_data)

Updates parameter definitions in extended format given data in compact format.

Parameters:db_map_data (dict) – lists of parameter definition items keyed by DiffDatabaseMapping

do_update_parameter_values(self, db_map_data)

Updates parameter values in extended format given data in compact format.

Parameters:db_map_data (dict) – lists of parameter value items keyed by DiffDatabaseMapping