jobflow_remote.cli.admin module

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

Add an index to one of the queue collections

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

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

jobflow_remote.cli.admin.reset(validation: ~typing.Annotated[str | None, <typer.models.ArgumentInfo object at 0x7fc04d86d3d0>] = None, reset_output: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d7a1510>] = False, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d797710>] = 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 0x7fc04d794d90>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fc04d7953d0>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.JobState] | None, <typer.models.OptionInfo object at 0x7fc04d795e50>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7fc04d796ad0>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7fc04d796d90>] = None, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d797710>] = False) → None

Forcibly removes the lock from the documents of the selected jobs. If no criteria is specified all the locked jobs will be selected. 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 0x7fc04d794d90>] = None, db_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fc04d7953d0>] = None, flow_id: ~typing.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fc04d795850>] = None, state: ~typing.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7fc04d7961d0>] = None, start_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7fc04d796ad0>] = None, end_date: ~typing.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7fc04d796d90>] = None, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d797710>] = False) → None

Forcibly removes the lock from the documents of the selected jobs. If no criteria is specified all the locked flows will be selected. WARNING: can lead to inconsistencies if the processes is actually running.

jobflow_remote.cli.admin.unlock_runner() → None

Forcibly removes the lock from the runner document. WARNING: can lead to inconsistencies if a runner daemon is actually running.

jobflow_remote.cli.admin.upgrade(no_dry_run: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047fe5fd0>] = False, check_env: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047ffc510>] = False, target: ~typing.Annotated[str | None, <typer.models.OptionInfo object at 0x7fc04e233010>] = None) → None

Upgrade the jobflow database. WARNING: can modify all the data. Previous version cannot be retrieved anymore. It preferable to perform a backup before upgrading.