Database.get_data(
matrices,
units=True,
indeces=True,
auto_calc=True,
format='object',
scenarios=['baseline'],
base_scenario=None,
type='absolute',
)#

Return matrices, units and indexes in a structured payload.

Parameters:

  • matrices – One matrix name or an iterable of names to retrieve.

  • units – When True, include unit tables in the returned payload.

  • indeces – When True, include the index dictionaries in the returned payload.

  • auto_calc – When True, automatically compute missing matrices before returning them.

  • format – "object" returns namedtuples; "dict" returns nested dictionaries keyed by scenario.

  • scenarios – Scenario name or iterable of scenario names to retrieve.

  • base_scenario – Optional reference scenario used to return scenario differences.

  • type – Difference type used with base_scenario. Accepted values are "absolute" and "relative".

Returns:

Same payload shape as CoreModel.get_data(...).

Return type:

object | dict