Amazon DynamoDB jobstore for Quartz.NET
This library provides a fully functioning Amazon DynamoDB JobStore for Quartz.NET using the AWS SDK Dynamo client. Inspired by Nanoko's Quartz.NET-MongoDB project. It is an adaptation of the original "RAMJobStore".
Quartz.NET Quartz.NET is a full-featured, open source job scheduling system that can be used from smallest apps to large scale enterprise systems.
Add the nuget package.
Configure quartz.net to use the dynamodb job store.
Code:
var properties = new NameValueCollection();
properties[StdSchedulerFactory.PropertyJobStoreType] = typeof(Quartz.DynamoDB.JobStore).AssemblyQualifiedName;
var schedulerFactory = new StdSchedulerFactory(properties);
var scheduler = schedulerFactory.GetScheduler();
Configuration:
<configSections>
<section name="quartz" type="System.Configuration.NameValueSectionHandler, System, Version=1.0.5000.0,Culture=neutral, PublicKeyToken=b77a5c561934e089" />
</configSections>
<quartz>
<add key="quartz.jobStore.type" value="Quartz.DynamoDB.JobStore, QuartzNET-DynamoDB" />
</quartz>
Read more about configuring job stores in the quartz.net documentation.
There are a few ways to do this;
- Access key, secret key and region in the configuration file
<add key="AWSAccessKey" value="*******" />
<add key="AWSSecretKey" value="*************" />
<add key="AWSRegion" value="us-west-2" /> - A profile specified in the configuration file (or named default)
- Access key, secret key and region stored in environment variables
- An EC2 instance profile.
For more details see the AWS documentation.
The QuartzNet DynamoDB job store uses the following table names by default:
- QuartzScheduler.Calendar
- QuartzScheduler.Job
- QuartzScheduler.JobGroup
- QuartzScheduler.Scheduler
- QuartzScheduler.Trigger
- QuartzScheduler.TriggerGroup
If you run multiple scheduler instances, the instanceName will be used as the table prefix instead of "QuartzScheduler". You can set this in configuration:
<configSections>
<section name="quartz" type="System.Configuration.NameValueSectionHandler, System, Version=1.0.5000.0,Culture=neutral, PublicKeyToken=b77a5c561934e089" />
</configSections>
<quartz>
<add key="quartz.scheduler.instanceName" value="[YOURNAMEHERE]" />
</quartz>
When the DynamoDB job store is initialised it will check if the required tables exist, if they do not it will attempt to create them and poll for them to be active before continuing. If you are running in a console, you'll see an output like the following:
21:29:36:169 [INFO] Quartz.Core.QuartzScheduler - Quartz Scheduler v.2.5.0.0 created.
Table QuartzScheduler.Job doesn't exist.
Creating table QuartzScheduler.Job.
Waiting for Table QuartzScheduler.Job to become active.
Table QuartzScheduler.JobGroup doesn't exist.
Creating table QuartzScheduler.JobGroup.
Waiting for Table QuartzScheduler.JobGroup to become active.
Table QuartzScheduler.Trigger doesn't exist.
Creating table QuartzScheduler.Trigger.
Waiting for Table QuartzScheduler.Trigger to become active.
Table QuartzScheduler.TriggerGroup doesn't exist.
Creating table QuartzScheduler.TriggerGroup.
Waiting for Table QuartzScheduler.TriggerGroup to become active.
Table QuartzScheduler.Scheduler doesn't exist.
Creating table QuartzScheduler.Scheduler.
Waiting for Table QuartzScheduler.Scheduler to become active.
Table QuartzScheduler.Calendar doesn't exist.
Creating table QuartzScheduler.Calendar.
Waiting for Table QuartzScheduler.Calendar to become active.
Alternatively you may create the tables yourself before starting the scheduler.
The job store will create the tables with 1 unit of read and 1 unit of write capacity. You may adjust the capacity of the tables, the only time the job store sets these values is when it creates the tables.
Please see contributing.md.