spinetoolbox.spine_db_parcel

SpineDBParcel class.

authors

13. Marin (KTH)

date

10.5.2020

Module Contents

Classes

SpineDBParcel

A class to create parcels of data from a Spine db.

class spinetoolbox.spine_db_parcel.SpineDBParcel(db_mngr)

A class to create parcels of data from a Spine db. Mainly intended for the Export selection action in the Spine db editor:

• push methods push items with everything they need to live in a standalone db.

• full_push and inner_push methods do something more specific

Initializes the parcel object.

Parameters

db_mngr (SpineDBManager) –

property data(self)

_get_fields(self, db_map, item_type, field, ids)

push_object_class_ids(self, db_map_ids)

Pushes object_class ids.

push_relationship_class_ids(self, db_map_ids)

Pushes relationship_class ids.

push_object_ids(self, db_map_ids)

Pushes object ids.

push_relationship_ids(self, db_map_ids)

Pushes relationship ids.

push_parameter_value_list_ids(self, db_map_ids)

Pushes parameter_value_list ids.

push_parameter_definition_ids(self, db_map_ids, entity_type)

Pushes parameter_definition ids.

push_parameter_value_ids(self, db_map_ids, entity_type)

Pushes parameter_value ids.

push_object_group_ids(self, db_map_ids)

Pushes object group ids.

push_alternative_ids(self, db_map_ids)

Pushes alternative ids.

push_scenario_ids(self, db_map_ids)

Pushes scenario ids.

push_scenario_alternative_ids(self, db_map_ids)

Pushes scenario_alternative ids.

full_push_object_class_ids(self, db_map_ids)

Pushes parameter definitions associated with given object classes. This essentially full_pushes the object classes and their parameter definitions.

full_push_relationship_class_ids(self, db_map_ids)

Pushes parameter definitions associated with given relationship classes. This essentially full_pushes the relationships classes, their parameter definitions, and their member object classes.

full_push_object_ids(self, db_map_ids)

Pushes parameter values associated with objects and with any relationships involving those objects. This essentially full_pushes objects, their relationships, all the parameter values, and all the necessary classes, definitions, and lists.

full_push_relationship_ids(self, db_map_ids)

Pushes parameter values associated with relationships. This essentially full_pushes relationships, their parameter values, and all the necessary classes, definitions, and lists.

inner_push_object_ids(self, db_map_ids)

Pushes object ids, cascading relationship ids, and the associated parameter values, but not any entity classes or parameter definitions. Mainly intended for the Duplicate object action.

inner_push_relationship_ids(self, db_map_ids)

Pushes relationship ids, and the associated parameter values, but not any entity classes or parameter definitions.

inner_push_parameter_value_ids(self, db_map_ids, entity_type)

Pushes parameter_value ids.

_update_ids(self, db_map_ids, which)

Updates ids for given database item.

Parameters

• db_map_ids (dict) – mapping from DatabaseMappingBase to ids or Asterisk

• which (str) – item name

_setdefault(self, db_map)

Adds new id sets for given db_map or returns existing ones.

Parameters

db_map (DatabaseMappingBase) – a database map

Returns

mapping from item name to set of ids

Return type

dict