imas.backends.db_entry_impl.DBEntryImpl¶

class imas.backends.db_entry_impl.DBEntryImpl¶

Bases: ABC

Interface for DBEntry implementations.

__init__()¶

Methods

__init__()
access_layer_version()	Get the access layer version used to store data.
close(*[, erase])	Close the data source.
delete_data(ids_name, occurrence)	Implement DBEntry.delete_data()
from_pulse_run(backend_id, db_name, pulse, ...)	Open a datasource with pulse, run and other legacy arguments.
from_uri(uri, mode, factory)	Open a datasource by URI.
get(ids_name, occurrence, parameters, ...)	Implement DBEntry.get/get_slice/get_sample.
list_all_occurrences(ids_name)	Implement DBEntry.list_all_occurrences()
put(ids, occurrence, is_slice)	Implement DBEntry.put()/put_slice(): store data.
read_dd_version(ids_name, occurrence)	Read data dictionary version that the requested IDS was stored with.

abstract access_layer_version() → str¶

Get the access layer version used to store data.

abstract close(*, erase: bool = False) → None¶

Close the data source.

Keyword Arguments:

erase: bool = False¶

The Access Layer allowed a parameter to erase data files when closing. This parameter may be ignored when implementing a backend.

abstract delete_data(ids_name: str, occurrence: int) → None¶

Implement DBEntry.delete_data()

classmethod from_pulse_run(backend_id: int, db_name: str, pulse: int, run: int, user_name: str | None, data_version: str | None, mode: int, options: Any, factory: IDSFactory) → DBEntryImpl¶

Open a datasource with pulse, run and other legacy arguments.

abstract classmethod from_uri(uri: str, mode: str, factory: IDSFactory) → DBEntryImpl¶

Open a datasource by URI.

abstract get(ids_name: str, occurrence: int, parameters: None | GetSliceParameters | GetSampleParameters, destination: IDSToplevel, lazy: bool, nbc_map: NBCPathMap | None) → IDSToplevel¶

Implement DBEntry.get/get_slice/get_sample. Load data from the data source.

Parameters:

ids_name: str¶

Name of the IDS to load.

occurrence: int¶

Which occurence of the IDS to load.

parameters: None | GetSliceParameters | GetSampleParameters¶

Additional parameters for a get_slice/get_sample call.

destination: IDSToplevel¶

IDS object to store data in.

lazy: bool¶

Use lazy loading.

nbc_map: NBCPathMap | None¶

NBCPathMap to use for implicit conversion. When None, no implicit conversion needs to be done.

abstract list_all_occurrences(ids_name: str) → list[int]¶

Implement DBEntry.list_all_occurrences()

abstract put(ids: IDSToplevel, occurrence: int, is_slice: bool) → None¶

Implement DBEntry.put()/put_slice(): store data.

Parameters:

ids: IDSToplevel¶

IDS to store in the data source.

occurrence: int¶

Which occurrence of the IDS to store to.

is_slice: bool¶

True: put_slice(), False: put()

abstract read_dd_version(ids_name: str, occurrence: int) → str¶

Read data dictionary version that the requested IDS was stored with.

This method should raise a DataEntryException if the specified ids/occurrence is not filled.