Quartz 4.1.0

Quartz.NET

Quartz.NET is a full-featured, open source job scheduling system that can be used from the smallest apps to large scale enterprise systems.

Installation

dotnet add package Quartz

That is everything a scheduler needs: dependency injection, hosting, the scheduler health check and System.Text.Json serialization are part of this package, where Quartz 3 shipped them separately.

Three things Quartz deliberately does not bring. The host below is Microsoft's — a project that has no Microsoft.Extensions.Hosting reference yet (a plain console one; the worker and web templates already have it) adds dotnet add package Microsoft.Extensions.Hosting. Quartz writes log events and leaves deciding where they go to the application, so it references Microsoft.Extensions.Logging.Abstractions rather than Microsoft.Extensions.Logging — a host brings the implementation with it, and a project that builds an ILoggerFactory itself adds dotnet add package Microsoft.Extensions.Logging. And a persistent store loads its ADO.NET driver by name, so UseSqlServer needs Microsoft.Data.SqlClient referenced, UsePostgres needs Npgsql, and so on.

Quick start

A job is a class with one method:

public sealed class HelloJob : IJob
{
    public async ValueTask Execute(IJobExecutionContext context, CancellationToken cancellationToken = default)
    {
        await Console.Out.WriteLineAsync("Greetings from HelloJob!");
    }
}

Register it with a trigger that fires it; the hosted service starts and stops the scheduler with the application:

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);

builder.AddQuartz(q => q.ScheduleJob<HelloJob>(trigger => trigger
    .WithIdentity("hello")
    .WithSimpleSchedule(TimeSpan.FromSeconds(10))));

builder.AddQuartzHostedService(options => options.WaitForJobsToComplete = true);

Console applications and tests build a scheduler without a host, from the same configuration API:

IScheduler scheduler = await QuartzSchedulerBuilder.Create().BuildScheduler();
await scheduler.Start();

Optional packages

Documentation

• Quick start
• Tutorial
• Configuration reference
• Publishing trimmed and native AOT
• Migrating from Quartz 3