Skip to content

logical_worker_entity

Module for managing database entities related to logical workers.

This module defines the LogicalWorkerEntity class, which extends the abstract base class DatabaseEntity, to encapsulate logical-worker-specific operations and behaviors.

LogicalWorkerEntity

Bases: DatabaseEntity[LogicalWorkerModel], RunManagementMixin, QueueManagementMixin, NameMixin

A class representing a logical worker in the database.

This class provides methods to interact with and manage a logical worker's data, including retrieving, adding, and removing run IDs and physical worker IDs from their respective lists, as well as saving or deleting the logical worker itself from the database.

Attributes:

Name Type Description
entity_info LogicalWorkerModel

An instance of the LogicalWorkerModel class containing the logical worker's metadata.
backend ResultsBackend

An instance of the ResultsBackend class used to interact with the database.

Methods:

Name Description
__repr__

Provide a string representation of the LogicalWorkerEntity instance.
__str__

Provide a human-readable string representation of the LogicalWorkerEntity instance.
reload_data

Reload the latest data for this logical worker from the database.
get_id

Retrieve the unique ID of the logical worker. Implementation found in DatabaseEntity.get_id.
get_additional_data

Retrieve any additional metadata associated with the logical worker. Implementation found in DatabaseEntity.get_additional_data.
get_name

Retrieve the name of the logical worker.
get_runs

Retrieve the IDs of the runs using this logical worker.
add_run

Add a run ID to the list of runs.
remove_run

Remove a run ID from the list of runs.
get_physical_workers

Retrieve the IDs of the physical workers created from this logical worker.
add_physical_worker

Add a physical worker ID to the list of physical workers.
remove_physical_worker

Remove a physical worker ID from the list of physical workers.
get_queues

Retrieve the list of queues that this worker is assigned to.
save

Save the current state of the logical worker to the database.
load

(classmethod) Load a LogicalWorkerEntity instance from the database by its ID.
delete

(classmethod) Delete a logical worker from the database by its ID.
Source code in merlin/db_scripts/entities/logical_worker_entity.py 
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
class LogicalWorkerEntity(DatabaseEntity[LogicalWorkerModel], RunManagementMixin, QueueManagementMixin, NameMixin):
    """
    A class representing a logical worker in the database.

    This class provides methods to interact with and manage a logical worker's data, including
    retrieving, adding, and removing run IDs and physical worker IDs from their respective lists,
    as well as saving or deleting the logical worker itself from the database.

    Attributes:
        entity_info (db_scripts.data_models.LogicalWorkerModel): An instance of the `LogicalWorkerModel`
            class containing the logical worker's metadata.
        backend (backends.results_backend.ResultsBackend): An instance of the `ResultsBackend`
            class used to interact with the database.

    Methods:
        __repr__:
            Provide a string representation of the `LogicalWorkerEntity` instance.

        __str__:
            Provide a human-readable string representation of the `LogicalWorkerEntity` instance.

        reload_data:
            Reload the latest data for this logical worker from the database.

        get_id:
            Retrieve the unique ID of the logical worker. _Implementation found in
                [`DatabaseEntity.get_id`][db_scripts.entities.db_entity.DatabaseEntity.get_id]._

        get_additional_data:
            Retrieve any additional metadata associated with the logical worker. _Implementation found in
                [`DatabaseEntity.get_additional_data`][db_scripts.entities.db_entity.DatabaseEntity.get_additional_data]._

        get_name:
            Retrieve the name of the logical worker.

        get_runs:
            Retrieve the IDs of the runs using this logical worker.

        add_run:
            Add a run ID to the list of runs.

        remove_run:
            Remove a run ID from the list of runs.

        get_physical_workers:
            Retrieve the IDs of the physical workers created from this logical worker.

        add_physical_worker:
            Add a physical worker ID to the list of physical workers.

        remove_physical_worker:
            Remove a physical worker ID from the list of physical workers.

        get_queues:
            Retrieve the list of queues that this worker is assigned to.

        save:
            Save the current state of the logical worker to the database.

        load:
            (classmethod) Load a `LogicalWorkerEntity` instance from the database by its ID.

        delete:
            (classmethod) Delete a logical worker from the database by its ID.
    """

    @classmethod
    def _get_entity_type(cls) -> str:
        return "logical_worker"

    def __repr__(self) -> str:
        """
        Provide a string representation of the `LogicalWorkerEntity` instance.

        Returns:
            A human-readable string representation of the `LogicalWorkerEntity` instance.
        """
        return (
            f"LogicalWorkerEntity("
            f"id={self.get_id()}, "
            f"name={self.get_name()}, "
            f"runs={self.get_runs()}, "
            f"queues={self.get_queues()}, "
            f"physical_workers={self.get_physical_workers()}, "
            f"additional_data={self.get_additional_data()}, "
            f"backend={self.backend.get_name()})"
        )

    def __str__(self) -> str:
        """
        Provide a string representation of the `LogicalWorkerEntity` instance.

        Returns:
            A human-readable string representation of the `LogicalWorkerEntity` instance.
        """
        worker_id = self.get_id()
        physical_workers = [
            PhysicalWorkerEntity.load(physical_worker_id, self.backend) for physical_worker_id in self.get_physical_workers()
        ]
        physical_worker_str = ""
        if physical_workers:
            for physical_worker in physical_workers:
                physical_worker_str += f"  - ID: {physical_worker.get_id()}\n    Name: {physical_worker.get_name()}\n"
        else:
            physical_worker_str = "  No physical workers found.\n"
        return (
            f"Logical Worker with ID {worker_id}\n"
            f"------------{'-' * len(worker_id)}\n"
            f"Name: {self.get_name()}\n"
            f"Runs:\n{self.construct_run_string()}"
            f"Queues: {self.get_queues()}\n"
            f"Physical Workers:\n{physical_worker_str}"
            f"Additional Data: {self.get_additional_data()}\n\n"
        )

    def get_physical_workers(self) -> List[str]:
        """
        Get the physical instances of this logical worker.

        Returns:
            A list of physical worker IDs.
        """
        self.reload_data()
        return self.entity_info.physical_workers

    def add_physical_worker(self, physical_worker_id: str):
        """
        Add a new physical worker id to the list of physical workers.

        Args:
            physical_worker_id: The id of the physical worker to add.
        """
        self.entity_info.physical_workers.append(physical_worker_id)
        self.save()

    def remove_physical_worker(self, physical_worker_id: str):
        """
        Remove a physical worker id from the list of physical workers.

        Does *not* delete a [`PhysicalWorkerEntity`][db_scripts.entities.physical_worker_entity.PhysicalWorkerEntity]
        from the database. This will only remove the physical worker's id from the list in this worker.

        Args:
            physical_worker_id: The ID of the physical worker to remove.
        """
        self.reload_data()
        self.entity_info.physical_workers.remove(physical_worker_id)
        self.save()

__repr__()

Provide a string representation of the LogicalWorkerEntity instance.

Returns:

Type Description
str

A human-readable string representation of the LogicalWorkerEntity instance.
Source code in merlin/db_scripts/entities/logical_worker_entity.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def __repr__(self) -> str:
    """
    Provide a string representation of the `LogicalWorkerEntity` instance.

    Returns:
        A human-readable string representation of the `LogicalWorkerEntity` instance.
    """
    return (
        f"LogicalWorkerEntity("
        f"id={self.get_id()}, "
        f"name={self.get_name()}, "
        f"runs={self.get_runs()}, "
        f"queues={self.get_queues()}, "
        f"physical_workers={self.get_physical_workers()}, "
        f"additional_data={self.get_additional_data()}, "
        f"backend={self.backend.get_name()})"
    )

__str__()

Provide a string representation of the LogicalWorkerEntity instance.

Returns:

Type Description
str

A human-readable string representation of the LogicalWorkerEntity instance.
Source code in merlin/db_scripts/entities/logical_worker_entity.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def __str__(self) -> str:
    """
    Provide a string representation of the `LogicalWorkerEntity` instance.

    Returns:
        A human-readable string representation of the `LogicalWorkerEntity` instance.
    """
    worker_id = self.get_id()
    physical_workers = [
        PhysicalWorkerEntity.load(physical_worker_id, self.backend) for physical_worker_id in self.get_physical_workers()
    ]
    physical_worker_str = ""
    if physical_workers:
        for physical_worker in physical_workers:
            physical_worker_str += f"  - ID: {physical_worker.get_id()}\n    Name: {physical_worker.get_name()}\n"
    else:
        physical_worker_str = "  No physical workers found.\n"
    return (
        f"Logical Worker with ID {worker_id}\n"
        f"------------{'-' * len(worker_id)}\n"
        f"Name: {self.get_name()}\n"
        f"Runs:\n{self.construct_run_string()}"
        f"Queues: {self.get_queues()}\n"
        f"Physical Workers:\n{physical_worker_str}"
        f"Additional Data: {self.get_additional_data()}\n\n"
    )

add_physical_worker(physical_worker_id)

Add a new physical worker id to the list of physical workers.

Parameters:

Name Type Description Default
physical_worker_id str

The id of the physical worker to add.

 required
Source code in merlin/db_scripts/entities/logical_worker_entity.py 
154
155
156
157
158
159
160
161
162
def add_physical_worker(self, physical_worker_id: str):
    """
    Add a new physical worker id to the list of physical workers.

    Args:
        physical_worker_id: The id of the physical worker to add.
    """
    self.entity_info.physical_workers.append(physical_worker_id)
    self.save()

get_physical_workers()

Get the physical instances of this logical worker.

Returns:

Type Description
List[str]

A list of physical worker IDs.
Source code in merlin/db_scripts/entities/logical_worker_entity.py 
144
145
146
147
148
149
150
151
152
def get_physical_workers(self) -> List[str]:
    """
    Get the physical instances of this logical worker.

    Returns:
        A list of physical worker IDs.
    """
    self.reload_data()
    return self.entity_info.physical_workers

remove_physical_worker(physical_worker_id)

Remove a physical worker id from the list of physical workers.

Does not delete a PhysicalWorkerEntity from the database. This will only remove the physical worker's id from the list in this worker.

Parameters:

Name Type Description Default
physical_worker_id str

The ID of the physical worker to remove.

 required
Source code in merlin/db_scripts/entities/logical_worker_entity.py 
164
165
166
167
168
169
170
171
172
173
174
175
176
def remove_physical_worker(self, physical_worker_id: str):
    """
    Remove a physical worker id from the list of physical workers.

    Does *not* delete a [`PhysicalWorkerEntity`][db_scripts.entities.physical_worker_entity.PhysicalWorkerEntity]
    from the database. This will only remove the physical worker's id from the list in this worker.

    Args:
        physical_worker_id: The ID of the physical worker to remove.
    """
    self.reload_data()
    self.entity_info.physical_workers.remove(physical_worker_id)
    self.save()