Skip to content

job batch run

Run a batch job using the specified gear and target containers.

Usage

Description

The job batch run command runs a batch job, executing a gear across multiple containers simultaneously.

Target Containers and Job Queuing

This command attempts to queue jobs across all child sessions or acquisitions of the specified container, based on the gear’s input requirements:

  • If the gear requires or optionally accepts an input file, one job will be queued for each child acquisition.
  • If the gear does not require input files, one job will be queued for each child session. In this case, it is assumed that the gear can locate necessary files via the SDK.

Once the target containers are identified, each container is evaluated against the gear’s input file requirements:

  • If a target container has multiple files that match the same input type, or if multiple inputs require files of the same type, a job will not be queued for that container.

Before executing the queued jobs, the command provides a summary of:

  • The number of jobs successfully queued.
  • The number of target containers skipped due to ambiguous file inputs.

Optional Input Policy

The optional-input-policy option determines how optional input files are handled during the batch run:

  • ignored (default): The gear runs without an optional input file.
  • flexible: The gear runs and populates the optional input if a matching file is found.
  • required: The gear only runs in containers where a matching file is found for the optional input.

Configuration Options

By default, the gear’s configuration values remain unchanged. However, you can use the -m/--modify-config option to modify them. When this option is used, you will be prompted to adjust each configuration value before execution.

More Information

For more details on batch jobs, see this article.