WJb Docs - Reference

JobQuery

Represents criteria used to search for jobs.

JobQuery is used to retrieve jobs that match specific conditions.

Purpose

Use JobQuery when filtering or locating jobs.

JobQuery
    ↓
 Store
    ↓
 JobInfo

Queries allow applications and administrative tools to retrieve only the jobs they are interested in.

Typical Usage

Job queries are commonly used for:

• Monitoring
• Dashboards
• Reporting
• Administration
• Diagnostics

Examples:

Failed Jobs
Running Jobs
Scheduled Jobs
Completed Jobs

Execution Flow

JobQuery
    ↓
IJobStoreQuery
    ↓
Store
    ↓
JobInfo

The store evaluates the query and returns matching jobs.

Filtering

A query may be used to narrow results based on job characteristics.

Typical filters include:

• Status
• Time range
• Action name
• Queue
• Runtime metadata

The exact capabilities depend on the underlying store implementation.

Monitoring Scenarios

Common scenarios include:

Show failed jobs
Show jobs currently running
Show recently completed jobs
Show scheduled work

Relationship to JobInfo

JobQuery defines what should be returned.

JobInfo represents the returned jobs.

JobQuery
    ↓
JobInfo

Relationship to IJobStoreQuery

IJobStoreQuery executes queries against a store.

JobQuery
    ↓
IJobStoreQuery
    ↓
Results

Best Practices

Query Only What You Need

Prefer targeted queries over retrieving all jobs.

Filter Early

Apply filters as part of the query whenever possible.

Use for Monitoring and Reporting

Job queries are intended to provide visibility into runtime activity.

Related Types

• JobInfo
• JobStatus
• IJobStoreQuery
• JobProgress

See Also

• JobInfo
• JobStatus
• IJobStoreQuery
• JobProgress