Cancelling jobs with a tag

[becca9835]

When using a shared database, how do I cancel only jobs submitted with run_cloud with a specific tag?

[jacksund]

If you submit jobs with something like this...

for structure in structures:
    status = workflow.run_cloud(
        structure=structure,
        tags = ["radomster", "attempt-2"],
    )

Then you can cancel those jobs in python with one of these options....

from simmate.database import connect
from simmate.engine.execution import WorkItem

# viewing ALL jobs (pending, running, completed, etc.)
all_jobs = WorkItem.objects.to_dataframe()

# Filtering jobs with specific tags
# option 1
radomster_jobs = WorkItem.objects.filter(
    tags=["radomster", "attempt-2"],
    status="P",  # Pending (optional filter)
).all()
# option 2 ("__contains" only works with postgres!)
radomster_jobs_2 = WorkItem.objects.filter(tags__contains="attempt-2").all()

# canceling jobs that you pulled
for job in radomster_jobs:
    job.cancel()

[jacksund]

in the next release (v0.14.0) you'll be able to delete jobs using this command:

simmate engine delete --tag mytag123 --confirm

[scott-materials]

I forget whether to use tag or tags and often have to check which to use. Right now, I use tags for submission but tag for workers . If possible, could we make it the same throughout?

[jacksund]

I had the same complaint when writing these functions... The command line isn't the same because of a limitation in Typer/Click.

Long story short, a list of strings parameter in typer cli looks like simmate engine start worker --tag example1 --tag example2. There's no "standard" way to do something like simmate engine start worker --tags example1 example2. Here are the typer docs on it.

Meanwhile python it's much easier to provide a list of strings as tags=["example1", "example2"] but has the reverse issue of being hacky if you add one tag at a time.