jobflow_remote.cli.admin module

jobflow_remote.cli.admin.create(key: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7f48f4a1a1d0>], direction: ~types.Annotated[~jobflow_remote.cli.utils.IndexDirection | None, <typer.models.ArgumentInfo object at 0x7f48f4a1a2d0>] = IndexDirection.ASC, foreground: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a1a0d0>] = False, collection: ~types.Annotated[~jobflow_remote.jobs.data.DbCollection | None, <typer.models.OptionInfo object at 0x7f48f7477250>] = 'jobs', unique: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a1be10>] = False)

Add an index to one of the queue collections

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

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

jobflow_remote.cli.admin.reset(validation: ~types.Annotated[str | None, <typer.models.ArgumentInfo object at 0x7f48f75a8f90>] = None, reset_output: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a1b4d0>] = False, yes_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a194d0>] = False, force_deprecated: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a193d0>] = False) → None

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

jobflow_remote.cli.admin.unlock(job_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f746fad0>] = None, db_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32bd0>] = None, state: ~types.Annotated[list[~jobflow_remote.jobs.state.JobState] | None, <typer.models.OptionInfo object at 0x7f48f4a32f10>] = None, start_date: ~types.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f48f760afd0>] = None, end_date: ~types.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f48f4a33f50>] = None, yes_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a194d0>] = False, force_deprecated: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a193d0>] = 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: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f746fad0>] = None, db_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32bd0>] = None, flow_id: ~types.Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7f48f4a32e10>] = None, state: ~types.Annotated[list[~jobflow_remote.jobs.state.FlowState] | None, <typer.models.OptionInfo object at 0x7f48f4a33190>] = None, start_date: ~types.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f48f760afd0>] = None, end_date: ~types.Annotated[~datetime.datetime | None, <typer.models.OptionInfo object at 0x7f48f4a33f50>] = None, yes_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a194d0>] = False, force_deprecated: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a193d0>] = 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 0x7f48f517fed0>] = False, check_env: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f517fd50>] = False, target: ~types.Annotated[str | None, <typer.models.OptionInfo object at 0x7f48f4a1b550>] = None, force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a1b7d0>] = False) → 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.