Skip to content

Advanced Features

Database management

The backend uses MongoDB to store task data. The server itself does not preserve any state or data. This allows you to directly access the database using a database management tool to navigate and manage the tasks.

Queue management

Create queue

labtasker create-queue --client-config ./my_client_config.env --queue-name my_queue_name

Task management

Getting task list (no pop)

# get a single task
labtasker ls-tasks --client-config ./my_client_config.env --task-id my_task_id

# get tasks by name
labtasker ls-tasks --client-config ./my_client_config.env --task-name my_task_name

# get all tasks in a queue, specified in my_client_config.env
labtasker ls-tasks --client-config ./my_client_config.env

Adding metadata to tasks

When submitting tasks, you can add metadata to the task. Metadata is a separate field from args. This allows for flexible task management and reporting.

Example: Tags implemented by metadata

You can implement tag feature using metadata.

import labtasker

tasker = labtasker.LabtaskerClient(client_config="./my_client_config.env")

tasker.submit(
    task_name="optional_task_name",
    args={"my_param_1": my_param_1, "my_param_2": my_param_2},
    metadata={"tags": ["my_tag_1", "my_tag_2"]}
)

labtasker submit --client-config ./my_client_config.env \
--task-name optional_task_name \
--metadata '{"tags": ["my_tag_1", "my_tag_2"]}' \
--args '{"my_param_1": $my_param_1, "my_param_2": $my_param_2}'

Task settings

Priority

Timeout

Retries

Task filtering

Worker management

Suspend worker

Daemon in bash API

Heartbeat via bash