spinedb_api.import_functions

Functions for importing data into a Spine database in a standard format. This functionaly is equivalent to the one provided by DatabaseMapping.add_update_item(), but the syntax is a little more compact.

Module Contents

Functions

import_data(db_map[, unparse_value, on_conflict])	Imports data into a Spine database using a standard format.
get_data_for_import(db_map[, unparse_value, ...])	Yields data to import into a Spine DB.
import_superclass_subclasses(db_map, data)	Imports superclass_subclasses into a Spine database using a standard format.
import_entity_classes(db_map, data)	Imports entity classes into a Spine database using a standard format.
import_entities(db_map, data)	Imports entities into a Spine database using a standard format.
import_entity_alternatives(db_map, data)	Imports entity alternatives into a Spine database using a standard format.
import_entity_groups(db_map, data)	Imports entity groups into a Spine database using a standard format.
import_parameter_definitions(db_map, data[, unparse_value])	Imports parameter definitions into a Spine database using a standard format.
import_parameter_values(db_map, data[, unparse_value, ...])	Imports parameter values into a Spine database using a standard format.
import_alternatives(db_map, data)	Imports alternatives into a Spine database using a standard format.
import_scenarios(db_map, data)	Imports scenarios into a Spine database using a standard format.
import_scenario_alternatives(db_map, data)	Imports scenario alternatives into a Spine database using a standard format.
import_parameter_value_lists(db_map, data[, unparse_value])	Imports parameter value lists into a Spine database using a standard format.
import_metadata(db_map, data)	Imports metadata into a Spine database using a standard format.

spinedb_api.import_functions.import_data(db_map, unparse_value=to_database, on_conflict='merge', **kwargs)

Imports data into a Spine database using a standard format.

Example:

entity_classes = [
    ('example_class', ()), ('other_class', ()), ('multi_d_class', ('example_class', 'other_class'))
]
alternatives = [('example_alternative', 'An example')]
scenarios = [('example_scenario', 'An example')]
scenario_alternatives = [
    ('example_scenario', 'example_alternative'), ('example_scenario', 'Base', 'example_alternative')
]
parameter_value_lists = [("example_list", "value1"), ("example_list", "value2")]
parameter_definitions = [('example_class', 'example_parameter'), ('multi_d_class', 'other_parameter')]
entities = [
    ('example_class', 'example_entity'),
    ('example_class', 'example_group'),
    ('example_class', 'example_member'),
    ('other_class', 'other_entity'),
    ('multi_d_class', ('example_entity', 'other_entity')),
]
entity_groups = [
    ('example_class', 'example_group', 'example_member'),
    ('example_class', 'example_group', 'example_entity'),
]
parameter_values = [
    ('example_object_class', 'example_entity', 'example_parameter', 3.14),
    ('multi_d_class', ('example_entity', 'other_entity'), 'rel_parameter', 2.718),
]
entity_alternatives = [
    ('example_class', 'example_entity', "example_alternative", True),
    ('example_class', 'example_entity', "example_alternative", False),
]
import_data(
    db_map,
    entity_classes=entity_classes,
    alternatives=alternatives,
    scenarios=scenarios,
    scenario_alternatives=scenario_alternatives,
    parameter_value_lists=parameter_value_lists,
    parameter_definitions=parameter_definitions,
    entities=entities,
    entity_groups=entity_groups,
    parameter_values=parameter_values,
    entity_alternatives=entity_alternatives,
)

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• on_conflict (str) – Conflict resolution strategy for parameter_value.fix_conflict()

• entity_classes (list(tuple(str,tuple,str,int)) – tuples of (name, dimension name tuple, description, display icon integer)

• parameter_definitions (list(tuple(str,str,str,str)) – tuples of (class name, parameter name, default value, parameter value list name, description)

• entities – (list(tuple(str,str or tuple(str)): tuples of (class name, entity name or element name list)

• entity_alternatives – (list(tuple(str,str or tuple(str),str,bool): tuples of (class name, entity name or element name list, alternative name, activity)

• entity_groups (list(tuple(str,str,str))) – tuples of (class name, group entity name, member entity name)

• parameter_values (list(tuple(str,str or tuple(str),str,str|numeric,str]) – tuples of (class name, entity name or element name list, parameter name, value, alternative name)

• alternatives (list(str,str)) – tuples of (name, description)

• scenarios (list(str,str)) – tuples of (name, description)

• scenario_alternatives (list(str,str,str)) – tuples of (scenario name, alternative name, preceeding alternative name)

• parameter_value_lists (list(str,str|numeric)) – tuples of (list name, value)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.get_data_for_import(db_map, unparse_value=to_database, on_conflict='merge', entity_classes=(), entities=(), entity_groups=(), entity_alternatives=(), parameter_definitions=(), parameter_values=(), parameter_value_lists=(), alternatives=(), scenarios=(), scenario_alternatives=(), metadata=(), entity_metadata=(), parameter_value_metadata=(), superclass_subclasses=(), object_classes=(), relationship_classes=(), object_parameters=(), relationship_parameters=(), objects=(), relationships=(), object_groups=(), object_parameter_values=(), relationship_parameter_values=(), object_metadata=(), relationship_metadata=(), object_parameter_value_metadata=(), relationship_parameter_value_metadata=(), tools=(), features=(), tool_features=(), tool_feature_methods=())

Yields data to import into a Spine DB.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• on_conflict (str) – Conflict resolution strategy for fix_conflict()

• entity_classes (list(tuple(str,tuple,str,int)) – tuples of (name, dimension name tuple, description, display icon integer)

• parameter_definitions (list(tuple(str,str,str,str)) – tuples of (class name, parameter name, default value, parameter value list name)

• entities – (list(tuple(str,str or tuple(str)): tuples of (class name, entity name or element name list)

• entity_alternatives – (list(tuple(str,str or tuple(str),str,bool): tuples of (class name, entity name or element name list, alternative name, activity)

• entity_groups (list(tuple(str,str,str))) – tuples of (class name, group entity name, member entity name)

• parameter_values (list(tuple(str,str or tuple(str),str,str|numeric,str]) – tuples of (class name, entity name or element name list, parameter name, value, alternative name)

• alternatives (list(str,str)) – tuples of (name, description)

• scenarios (list(str,str)) – tuples of (name, description)

• scenario_alternatives (list(str,str,str)) – tuples of (scenario name, alternative name, preceeding alternative name)

• parameter_value_lists (list(str,str|numeric)) – tuples of (list name, value)

Yields:

str – item type tuple(list,list,list): tuple of (items to add, items to update, errors)

spinedb_api.import_functions.import_superclass_subclasses(db_map, data)

Imports superclass_subclasses into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data (list(tuple(str,tuple,str,int)) – tuples of (superclass name, subclass name)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_entity_classes(db_map, data)

Imports entity classes into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data (list(tuple(str,tuple,str,int,bool)) – tuples of (name, dimension name tuple, description, display icon integer, active by default flag)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_entities(db_map, data)

Imports entities into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data – (list(tuple(str,str or tuple(str)): tuples of (class name, entity name or element name list)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_entity_alternatives(db_map, data)

Imports entity alternatives into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data – (list(tuple(str,str or tuple(str),str,bool): tuples of (class name, entity name or element name list, alternative name, activity)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_entity_groups(db_map, data)

Imports entity groups into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data (list(tuple(str,str,str))) – tuples of (class name, group entity name, member entity name)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_parameter_definitions(db_map, data, unparse_value=to_database)

Imports parameter definitions into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data (list(tuple(str,str,str,str)) – tuples of (class name, parameter name, default value, parameter value list name)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_parameter_values(db_map, data, unparse_value=to_database, on_conflict='merge')

Imports parameter values into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data (list(tuple(str,str or tuple(str),str,str|numeric,str]) – tuples of (class name, entity name or element name list, parameter name, value, alternative name)

• on_conflict (str) – Conflict resolution strategy for fix_conflict()

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_alternatives(db_map, data)

Imports alternatives into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data (list(str,str)) – tuples of (name, description)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_scenarios(db_map, data)

Imports scenarios into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data (list(str, bool, str)) – tuples of (name, <unused_bool>, description)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_scenario_alternatives(db_map, data)

Imports scenario alternatives into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data (list(str,str,str)) – tuples of (scenario name, alternative name, preceeding alternative name)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_parameter_value_lists(db_map, data, unparse_value=to_database)

Imports parameter value lists into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data (list(str,str|numeric)) – tuples of (list name, value)

Returns:

number of items imported list: errors

Return type:

int

spinedb_api.import_functions.import_metadata(db_map, data)

Imports metadata into a Spine database using a standard format.

Parameters:

• db_map (spinedb_api.DiffDatabaseMapping) – database mapping

• data (list(tuple(str,str))) – tuples of (entry name, value)

Returns:

number of items imported list: errors

Return type:

int