jobflow_remote.cli.admin module

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

Add an index to one of the queue collections

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

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

jobflow_remote.cli.admin.reset(validation: Annotated[str | None, <typer.models.ArgumentInfo object at 0x7fbc7a47f690>]=None, reset_output: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc79319e50>]=False, yes_all: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7dd0>]=False, force_deprecated: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7bd0>]=False) → None

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

jobflow_remote.cli.admin.unlock(job_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc7a238a50>]=None, db_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f4350>]=None, state: JobState] | None, <typer.models.OptionInfo object at 0x7fbc792f61d0>]=None, start_date: datetime | None, <typer.models.OptionInfo object at 0x7fbc7a2472d0>]=None, end_date: datetime | None, <typer.models.OptionInfo object at 0x7fbc7a25d5d0>]=None, yes_all: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7dd0>]=False, force_deprecated: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7bd0>]=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: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f4810>]=None, db_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f4350>]=None, flow_id: Annotated[list[str] | None, <typer.models.OptionInfo object at 0x7fbc792f60d0>]=None, state: FlowState] | None, <typer.models.OptionInfo object at 0x7fbc792f6350>]=None, start_date: datetime | None, <typer.models.OptionInfo object at 0x7fbc7a2472d0>]=None, end_date: datetime | None, <typer.models.OptionInfo object at 0x7fbc7a25d5d0>]=None, yes_all: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7dd0>]=False, force_deprecated: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc792f7bd0>]=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: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc738f3050>]=False, check_env: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc738f10d0>]=False, target: Annotated[str | None, <typer.models.OptionInfo object at 0x7fbc7a2310d0>]=None, force: Annotated[bool, <typer.models.OptionInfo object at 0x7fbc793197d0>]=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.