simdb.database package

Database module.

The database module contains the code for creating and interacting with the database. Using SQLAlchemy the code can be used with various types of databases including SQLite and PostgreSQL.

class simdb.database.Database(db_type: DBMS, scopefunc=None, **kwargs)

Bases: object

Class to wrap the database access.

class DBMS(value)

Bases: Enum

DBMSs supported.

MSSQL = 3

POSTGRESQL = 2

SQLITE = 1

add_watcher(sim_ref: str, watcher: Watcher)

close()

Close the database session and dispose of the engine.

delete_simulation(sim_ref: str) → Simulation

Delete the specified simulation from the database.

Parameters:

sim_ref – The simulation UUID or alias.

Returns:

None

engine: sqlalchemy.engine.Engine

get_aliases(prefix: str | None) → List[str]

get_file(file_uuid_str: str) → File

Get the specified file from the database.

Parameters:

file_uuid_str – The string representation of the file UUID.

Returns:

The File.

get_metadata(sim_ref: str, name: str) → List[str]

Get all the metadata for the given simulation with the given key.

Parameters:

• sim_ref – the simulation identifier

• name – the metadata key

Returns:

The matching MetaData.

get_simulation(sim_ref: str) → Simulation

Get the specified simulation from the database.

Parameters:

sim_ref – The simulation UUID or alias.

Returns:

The Simulation.

get_simulation_children(simulation: Simulation) → List[dict]

get_simulation_data(query)

get_simulation_parents(simulation: Simulation) → List[dict]

insert_simulation(simulation: Simulation) → None

Insert the given simulation into the database.

Parameters:

simulation – The Simulation to insert.

Returns:

None

list_files() → List[File]

Return a list of all the files stored in the database.

Returns:

A list of Files.

list_metadata_keys() → List[dict]

list_metadata_values(name: str) → List[str]

list_simulation_data(meta_keys: List[str] = None, limit: int = 0, page: int = 1, sort_by: str = '', sort_asc: bool = False) → Tuple[int, List[dict]]

Return a list of all the simulations stored in the database.

Returns:

A list of Simulations.

list_simulations(meta_keys: List[str] = None, limit: int = 0) → List[Simulation]

Return a list of all the simulations stored in the database.

Returns:

A list of Simulations.

list_watchers(sim_ref: str) → List[Watcher]

query_meta(constraints: List[Tuple[str, str, QueryType]]) → List[Simulation]

Query the metadata and return matching simulations.

Returns:

query_meta_data(constraints: List[Tuple[str, str, QueryType]], meta_keys: List[str], limit: int = 0, page: int = 1, sort_by: str = '', sort_asc: bool = False) → Tuple[int, List[dict]]

Query the metadata and return matching simulations.

Returns:

remove()

Remove the current session

remove_watcher(sim_ref: str, username: str)

reset() → None

Clear all the data out of the database.

Returns:

None

exception simdb.database.DatabaseError

Bases: RuntimeError

simdb.database.get_local_db(config: Config) → Database

Subpackages

• simdb.database.models package
  • Base
    • Base.metadata
    • Base.registry
  • File
    • File.checksum
    • File.data()
    • File.datetime
    • File.from_data()
    • File.generate_checksum()
    • File.get_creation_date()
    • File.id
    • File.type
    • File.uri
    • File.uuid
  • MetaData
    • MetaData.data()
    • MetaData.element
    • MetaData.from_data()
    • MetaData.id
    • MetaData.sim_id
    • MetaData.value
  • Simulation
    • Simulation.Status
      • Simulation.Status.ACCEPTED
      • Simulation.Status.DELETED
      • Simulation.Status.DEPRECATED
      • Simulation.Status.FAILED
      • Simulation.Status.NOT_VALIDATED
      • Simulation.Status.PASSED
    • Simulation.alias
    • Simulation.data()
    • Simulation.datetime
    • Simulation.file_paths()
    • Simulation.find_meta()
    • Simulation.from_data()
    • Simulation.id
    • Simulation.inputs
    • Simulation.meta
    • Simulation.meta_dict()
    • Simulation.outputs
    • Simulation.remove_meta()
    • Simulation.set_meta()
    • Simulation.status
    • Simulation.uuid
    • Simulation.validate_meta()
    • Simulation.watchers
  • Watcher
    • Watcher.NOTIFICATION_CHOICES
    • Watcher.data()
    • Watcher.email
    • Watcher.from_data()
    • Watcher.id
    • Watcher.notification
    • Watcher.username
    • Watcher.validate_email()
  • Submodules
    • simdb.database.models.base module
      • BaseModel
    • simdb.database.models.file module
      • File
    • simdb.database.models.metadata module
      • MetaData
    • simdb.database.models.simulation module
      • Simulation
    • simdb.database.models.types module
      • ChoiceType
      • URI
      • UUID
    • simdb.database.models.utils module
      • checked_get()
      • flatten_dict()
      • unflatten_dict()
    • simdb.database.models.watcher module
      • Watcher

Submodules

• simdb.database.database module
  • Database
    • Database.DBMS
      • Database.DBMS.MSSQL
      • Database.DBMS.POSTGRESQL
      • Database.DBMS.SQLITE
    • Database.add_watcher()
    • Database.close()
    • Database.delete_simulation()
    • Database.engine
    • Database.get_aliases()
    • Database.get_file()
    • Database.get_metadata()
    • Database.get_simulation()
    • Database.get_simulation_children()
    • Database.get_simulation_data()
    • Database.get_simulation_parents()
    • Database.insert_simulation()
    • Database.list_files()
    • Database.list_metadata_keys()
    • Database.list_metadata_values()
    • Database.list_simulation_data()
    • Database.list_simulations()
    • Database.list_watchers()
    • Database.query_meta()
    • Database.query_meta_data()
    • Database.remove()
    • Database.remove_watcher()
    • Database.reset()
    • Database.session
  • DatabaseError
  • Session
    • Session.add()
    • Session.commit()
    • Session.delete()
    • Session.query()
    • Session.rollback()
  • get_local_db()