spinetoolbox.spine_db_parcel

SpineDBParcel class.

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

_get_field_values(db_map, item_type, field, ids)

Returns a list of field values for items of given type, having given ids.

push_entity_class_ids(db_map_ids)

Pushes entity_class ids.

push_entity_ids(db_map_ids)

Pushes entity ids.

push_parameter_value_list_ids(db_map_ids)

Pushes parameter_value_list ids.

push_parameter_definition_ids(db_map_ids)

Pushes parameter_definition ids.

push_parameter_value_ids(db_map_ids)

Pushes parameter_value ids.

push_entity_group_ids(db_map_ids)

Pushes entity group ids.

push_alternative_ids(db_map_ids)

Pushes alternative ids.

push_scenario_ids(db_map_ids)

Pushes scenario ids.

push_scenario_alternative_ids(db_map_ids)

Pushes scenario_alternative ids.

full_push_entity_class_ids(db_map_ids)

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

full_push_entity_ids(db_map_ids)

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

full_push_scenario_ids(db_map_ids)

inner_push_entity_ids(db_map_ids)

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

inner_push_parameter_value_ids(db_map_ids)

Pushes parameter_value ids.

_update_ids(db_map_ids, key)

Updates ids for given database item.

Parameters

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

• key (str) – the key

_setdefault(db_map)

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

Parameters

db_map (DatabaseMapping) – a database map

Returns

mapping from item name to set of ids

Return type

dict