Skip to content

Index

The entities package defines database entity classes used throughout Merlin for managing core components such as studies, runs, and workers. These classes provide a structured interface for interacting with persisted data, ensuring consistency and maintainability.

At the heart of this package is the abstract base class DatabaseEntity, which outlines the standard methods that all database-backed entities must implement, including save, delete, and reload operations.

Subpackages
  • mixins/: Contains mixin classes for entities that help reduce shared code.

Modules:

Name Description
db_entity.py

Defines the abstract base class DatabaseEntity, which provides a common interface for all database entity classes.

logical_worker_entity.py

Implements the LogicalWorkerEntity class, representing logical workers and their associated operations.

physical_worker_entity.py

Defines the PhysicalWorkerEntity class for managing physical workers stored in the database.

run_entity.py

Implements the RunEntity class, which encapsulates database operations related to run records.

study_entity.py

Defines the StudyEntity class for handling study-related database interactions.