LocalMetadataProvider Class Reference

Collaboration diagram for LocalMetadataProvider:

Public Member Functions
def	__init__ (self, filename, mode="read")
def	get_payload_count (self)
def	add_globaltag (self, tag_id, name, state, iovs)
def	get_globaltags (self)
def	get_payloads (self)
def	get_all_iovs (self, globalTag, exp=None, run=None, message=None)

Static Public Attributes
int	APPLICATION_ID = 0xb2cdb
	Application ID to be stored int the sqlite file.
int	SCHEMA_VERSION = 1
	Schema version, to be increased when the table definitions change so that we can check for safe append operation.
string	SCHEMA_SQL
	SQL script to create all necessary tables and views.

Private Member Functions
def	_resolve_id (self, name, entity)

Private Attributes
	_cache
	Cache name->id mappings from the database.
	_database
	sqlite Database connection

Detailed Description

Class to handle local sqlite dump of conditions database metadata

This class can create and read sqlite dumps of the central database in a format
compatible with the local metadata provider in basf2.

Definition at line 20 of file local_metadata.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			filename,
			mode = "read"
	)

Open an sqlite database and make sure that the schema exists in the
correct version or create it if ``mode=overwrite``

Arguments:
  filename (str): name of the database file
  readonly (str): how to open the file. Can be one of ``read`` to open
    the file readonly, ``append` to append new data to an existing file
    and ``overwrite`` to recreate all tables and overwrite the contents.

Definition at line 124 of file local_metadata.py.

    def __init__(self, filename, mode="read"):
        """
        Open an sqlite database and make sure that the schema exists in the
        correct version or create it if ``mode=overwrite``
 
        Arguments:
          filename (str): name of the database file
          readonly (str): how to open the file. Can be one of ``read`` to open
            the file readonly, ``append` to append new data to an existing file
            and ``overwrite`` to recreate all tables and overwrite the contents.
        """
 
        
        self._cache = {}
        
        self._database = None
 
        # connect to the database file ...
        if mode == "read":
            self._database = sqlite3.connect(f"file:{filename}?mode=ro", uri=True)
        elif mode in ["append", "overwrite"]:
            self._database = sqlite3.connect(filename)
        else:
            raise RuntimeError("invalid mode: please supply one of 'read', 'append', 'overwrite'")
 
        if mode == "overwrite":
            # drop and recreate all tables
            self._database.executescript(self.SCHEMA_SQL)
            # and set the application id/schema version correctly
            self._database.execute(f"PRAGMA application_id = {self.APPLICATION_ID}")
            self._database.execute(f"PRAGMA user_version = {self.SCHEMA_VERSION}")
            self._database.commit()
        else:
            # make sure the application id/schema version is the same
            application_id = self._database.execute("PRAGMA application_id").fetchone()[0]
            if application_id != self.APPLICATION_ID:
                raise RuntimeError("Not a b2conditionsdb database file")
            schema_version = self._database.execute("PRAGMA user_version").fetchone()[0]
            if schema_version != self.SCHEMA_VERSION:
                raise RuntimeError("Cannot use sqlite file: different schema version, please recreate")
 

Member Function Documentation

_resolve_id()

def _resolve_id (   self,   name,   entity  )

private

Resolve the id for a named entity in the database file.

Create new entities on demand and cache all known entities

Parameters:
  name (str): name to lookup
  entity (str): type of the entity, currently ``baseUrl`` or ``payloadName``

Definition at line 170 of file local_metadata.py.

add_globaltag()

def add_globaltag	(		self,
			tag_id,
			name,
			state,
			iovs
	)

Add a globaltag to the database file. If the globaltag already exists in
the file its contents will be replaced.

Parameters: tag_id (str): id of the globaltag in the central database
  name (str): name of the globaltag in the central database state (str):
  state of the globaltag in the central database iovs
  (list(PayloadInformation)): all iovs valid for this globaltag

Definition at line 190 of file local_metadata.py.

get_all_iovs()

def get_all_iovs	(		self,
			globalTag,
			exp = None,
			run = None,
			message = None
	)

Get all iovs for a given globaltag

Parameters:
  globalTag (str): name of the globaltag
  exp (int): experiment number to check (or None to return all iovs)
  run (int): run number to check (or None to return all iovs)
  message (str): ignored, just for compatibility with `ConditionsDB.get_all_iovs`

Returns:
  a sorted list of `PayloadInformation` objects

Definition at line 242 of file local_metadata.py.

get_globaltags()

def get_globaltags

(

self

)

Return the list of globaltags stored in the file

Returns:
  a list of (id, name, state) tuples for all globaltags

Definition at line 222 of file local_metadata.py.

get_payload_count()

def get_payload_count

(

self

)

Get the number of distinct payloads known to this file

Definition at line 165 of file local_metadata.py.

get_payloads()

def get_payloads

(

self

)

Get all payloads existing in this file

Returns:
  a sorted list of `PayloadInformation` objects for all payloads defined in this file with the iov set to None

Definition at line 231 of file local_metadata.py.

---

The documentation for this class was generated from the following file:

• framework/scripts/conditions_db/local_metadata.py