jobflow_remote.cli.admin module

jobflow_remote.cli.admin.create(key: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7f5b8a1769d0>], direction: ~typing.Annotated[~jobflow_remote.cli.utils.IndexDirection | None, <typer.models.ArgumentInfo object at 0x7f5b8a176cd0>] = IndexDirection.ASC, foreground: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b8a1768d0>] = False, collection: ~typing.Annotated[~jobflow_remote.jobs.data.DbCollection | None, <typer.models.OptionInfo object at 0x7f5b8a177990>] = 'jobs', unique: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b8a177a10>] = False)

Add an index to one of the queue collections

jobflow_remote.cli.admin.rebuild(foreground: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b8a1768d0>] = False)

Rebuild all the standard indexes. Old indexes will be dropped, including the custom ones.

jobflow_remote.cli.admin.remove_lock(job_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f5b8a15f290>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f5b8a15f7d0>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.JobState] | None, <typer.models.OptionInfo object at 0x7f5b8a174190>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f5b8a1753d0>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f5b8a175450>] = None, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b8a175ed0>] = False) → None

DEPRECATED: use unlock instead Forcibly removes the lock from the documents of the selected jobs. WARNING: can lead to inconsistencies if the processes is actually running.

jobflow_remote.cli.admin.reset(reset_output: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b8aabc8d0>] = False, max_limit: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f5b8aaae590>] = 25, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b8a175ed0>] = False) → None

Reset the jobflow database. WARNING: deletes all the data. These could not be retrieved anymore.

jobflow_remote.cli.admin.unlock(job_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f5b8a15f290>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f5b8a15f7d0>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.JobState] | None, <typer.models.OptionInfo object at 0x7f5b8a174190>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f5b8a1753d0>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f5b8a175450>] = None, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b8a175ed0>] = False) → None

Forcibly removes the lock from the documents of the selected jobs. WARNING: can lead to inconsistencies if the processes is actually running.

jobflow_remote.cli.admin.unlock_flow(job_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f5b8a15f290>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f5b8a15f7d0>] = None, flow_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f5b8a15f990>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7f5b8a174890>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f5b8a1753d0>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f5b8a175450>] = None, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b8a175ed0>] = False) → None

Forcibly removes the lock from the documents of the selected jobs. WARNING: can lead to inconsistencies if the processes is actually running.