Table of Contents

Class AdoConstants

Namespace
Quartz.Impl.AdoJobStore
Assembly
Quartz.dll

The table, column and state names of the standard Quartz database schema, for IDriverDelegate and ITriggerPersistenceDelegate implementations that read and write it.

public static class AdoConstants
Inheritance
AdoConstants
Inherited Members

Remarks

These used to be inherited: a delegate declared : AdoConstants and referred to the names unqualified. Inheritance is not how a constant container is consumed — it burns the single base class of every type that wants to name a column — so this is a static class now, named explicitly at the use site.

Fields

AllGroupsPaused

The group name a store records in the paused-groups table to mean that every group is paused, including the ones added next.

public const string AllGroupsPaused = "_$_ALL_GROUPS_PAUSED_$_"

Field Value

string

ColumnBlob

The BLOB_DATA column of TableBlobTriggers.

public const string ColumnBlob = "BLOB_DATA"

Field Value

string

ColumnCalendar

The CALENDAR column of TableCalendars.

public const string ColumnCalendar = "CALENDAR"

Field Value

string

ColumnCalendarName

The CALENDAR_NAME column of TableCalendars.

public const string ColumnCalendarName = "CALENDAR_NAME"

Field Value

string

ColumnCheckinInterval

The CHECKIN_INTERVAL column of TableSchedulerState.

public const string ColumnCheckinInterval = "CHECKIN_INTERVAL"

Field Value

string

ColumnConsecutiveFailures

The CONSECUTIVE_FAILURES column of TableJobStatus: how many runs in a row have failed.

public const string ColumnConsecutiveFailures = "CONSECUTIVE_FAILURES"

Field Value

string

ColumnContinuationCondition

The CONTINUATION_CONDITION column of TableTriggers: the integer of the ContinuationCondition flags that release the wait.

public const string ColumnContinuationCondition = "CONTINUATION_CONDITION"

Field Value

string

ColumnContinuesTriggerGroup

The CONTINUES_TRIGGER_GROUP column of TableTriggers: the group of the trigger whose firing this one waits for.

public const string ColumnContinuesTriggerGroup = "CONTINUES_TRIGGER_GROUP"

Field Value

string

ColumnContinuesTriggerName

The CONTINUES_TRIGGER_NAME column of TableTriggers: the name of the trigger whose firing this one waits for.

public const string ColumnContinuesTriggerName = "CONTINUES_TRIGGER_NAME"

Field Value

string

ColumnCronExpression

The CRON_EXPRESSION column of TableCronTriggers.

public const string ColumnCronExpression = "CRON_EXPRESSION"

Field Value

string

ColumnDescription

The DESCRIPTION column of TableJobDetails.

public const string ColumnDescription = "DESCRIPTION"

Field Value

string

ColumnEndTime

The END_TIME column of TableTriggers.

public const string ColumnEndTime = "END_TIME"

Field Value

string

ColumnEntryId

The ENTRY_ID column of TableFiredTriggers.

public const string ColumnEntryId = "ENTRY_ID"

Field Value

string

ColumnEntryState

The STATE column of TableFiredTriggers.

public const string ColumnEntryState = "STATE"

Field Value

string

ColumnErrorMessage

The ERROR_MESSAGE column of TableExecutionHistory.

public const string ColumnErrorMessage = "ERROR_MESSAGE"

Field Value

string

ColumnExecutionGroup

The EXECUTION_GROUP column of TableTriggers.

public const string ColumnExecutionGroup = "EXECUTION_GROUP"

Field Value

string

ColumnExecutionLog

The EXECUTION_LOG column of TableExecutionHistory: the log lines the job wrote while it ran, when the scheduler captures them.

public const string ColumnExecutionLog = "EXECUTION_LOG"

Field Value

string

Remarks

Added by the optional 4.3 migration, and never read by the history listing: only IExecutionHistoryStore.GetExecution selects it.

ColumnFailureCount

The FAILURE_COUNT column of TableJobStatus: how many of them failed.

public const string ColumnFailureCount = "FAILURE_COUNT"

Field Value

string

ColumnFireInstanceId

The FIRE_INSTANCE_ID column of TableExecutionHistory: the firing's id, which links the row to its span and log scope.

public const string ColumnFireInstanceId = "FIRE_INSTANCE_ID"

Field Value

string

Remarks

Added by the optional 4.4 migration. Neither unique nor indexed: a fire instance id is not durable across a restart.

ColumnFiredTime

The FIRED_TIME column of TableFiredTriggers.

public const string ColumnFiredTime = "FIRED_TIME"

Field Value

string

ColumnFirstFiredTime

The FIRST_FIRED_TIME column of TableJobStatus: when the job first fired.

public const string ColumnFirstFiredTime = "FIRST_FIRED_TIME"

Field Value

string

ColumnFixedDelay

The FIXED_DELAY column of TableTriggers: whether a simple trigger measures its interval from the previous run's completion (MeasureIntervalFromCompletion), where null is a fixed rate (#4140).

public const string ColumnFixedDelay = "FIXED_DELAY"

Field Value

string

ColumnInstanceName

The INSTANCE_NAME column of TableFiredTriggers.

public const string ColumnInstanceName = "INSTANCE_NAME"

Field Value

string

ColumnInterruptRequestedTime

The INTERRUPT_REQUESTED_TIME column of TableFiredTriggers: when an interrupt of the firing was requested from another node, in ticks, and NULL while nobody has asked. The node running the firing reads it at every check-in (#4071).

public const string ColumnInterruptRequestedTime = "INTERRUPT_REQUESTED_TIME"

Field Value

string

ColumnIsDurable

The IS_DURABLE column of TableJobDetails.

public const string ColumnIsDurable = "IS_DURABLE"

Field Value

string

ColumnIsNonConcurrent

The IS_NONCONCURRENT column of TableJobDetails.

public const string ColumnIsNonConcurrent = "IS_NONCONCURRENT"

Field Value

string

ColumnIsUpdateData

The IS_UPDATE_DATA column of TableJobDetails.

public const string ColumnIsUpdateData = "IS_UPDATE_DATA"

Field Value

string

ColumnJobClass

The JOB_CLASS_NAME column of TableJobDetails.

public const string ColumnJobClass = "JOB_CLASS_NAME"

Field Value

string

ColumnJobDataMap

The JOB_DATA column of TableJobDetails.

public const string ColumnJobDataMap = "JOB_DATA"

Field Value

string

ColumnJobGroup

The JOB_GROUP column of TableJobDetails.

public const string ColumnJobGroup = "JOB_GROUP"

Field Value

string

ColumnJobInput

The JOB_INPUT column of TableExecutionHistory: the run's input, the string the scheduler stored under JobInput.

public const string ColumnJobInput = "JOB_INPUT"

Field Value

string

Remarks

Added by the optional 4.4 migration, and written only with RecordInput. Never read by the history listing: only IExecutionHistoryStore.GetExecution selects it.

ColumnJobInputTooLarge

The JOB_INPUT_TOO_LARGE column of TableExecutionHistory: whether the run's input was over MaxInputBytes, and so not kept.

public const string ColumnJobInputTooLarge = "JOB_INPUT_TOO_LARGE"

Field Value

string

Remarks

Added by the optional 4.4 migration, nullable as every 4.x migration's column is.

ColumnJobName

The JOB_NAME column of TableJobDetails.

public const string ColumnJobName = "JOB_NAME"

Field Value

string

ColumnLastCheckinTime

The LAST_CHECKIN_TIME column of TableSchedulerState.

public const string ColumnLastCheckinTime = "LAST_CHECKIN_TIME"

Field Value

string

ColumnLastEntryId

The LAST_ENTRY_ID column of TableJobStatus: the last run's history row.

public const string ColumnLastEntryId = "LAST_ENTRY_ID"

Field Value

string

ColumnLastFailureMessage

The LAST_FAILURE_MESSAGE column of TableJobStatus: what the last failed run said, as ColumnErrorMessage holds it.

public const string ColumnLastFailureMessage = "LAST_FAILURE_MESSAGE"

Field Value

string

ColumnLastFailureTime

The LAST_FAILURE_TIME column of TableJobStatus: when a run last failed.

public const string ColumnLastFailureTime = "LAST_FAILURE_TIME"

Field Value

string

ColumnLastFiredTime

The LAST_FIRED_TIME column of TableJobStatus: when the last run fired.

public const string ColumnLastFiredTime = "LAST_FIRED_TIME"

Field Value

string

ColumnLastInstanceName

The LAST_INSTANCE_NAME column of TableJobStatus: the node that ran it.

public const string ColumnLastInstanceName = "LAST_INSTANCE_NAME"

Field Value

string

ColumnLastResult

The LAST_RESULT column of TableJobStatus: the last run's result, as ColumnResult holds it.

public const string ColumnLastResult = "LAST_RESULT"

Field Value

string

ColumnLastRunTime

The LAST_RUN_TIME column of TableJobStatus: how long the last run took, in ticks, as ColumnRunTime.

public const string ColumnLastRunTime = "LAST_RUN_TIME"

Field Value

string

ColumnLastSuccessTime

The LAST_SUCCESS_TIME column of TableJobStatus: when a run last succeeded.

public const string ColumnLastSuccessTime = "LAST_SUCCESS_TIME"

Field Value

string

ColumnLastSummary

The LAST_SUMMARY column of TableJobStatus: the last run's ColumnSummary.

public const string ColumnLastSummary = "LAST_SUMMARY"

Field Value

string

ColumnLockName

The LOCK_NAME column of TableLocks.

public const string ColumnLockName = "LOCK_NAME"

Field Value

string

ColumnManual

The MANUAL column of TableExecutionHistory: whether TriggerJob fired the run.

public const string ColumnManual = "MANUAL"

Field Value

string

Remarks

Added by the optional 4.4 migration, nullable as every 4.x migration's column is.

ColumnMetrics

The METRICS column of TableExecutionHistory: the values the run reported, as JSON.

public const string ColumnMetrics = "METRICS"

Field Value

string

Remarks

Added by the optional 4.4 migration.

ColumnMisfireInstruction

The MISFIRE_INSTR column of TableTriggers.

public const string ColumnMisfireInstruction = "MISFIRE_INSTR"

Field Value

string

ColumnMisfireOriginalFireTime

The MISFIRE_ORIG_FIRE_TIME column of TableTriggers.

public const string ColumnMisfireOriginalFireTime = "MISFIRE_ORIG_FIRE_TIME"

Field Value

string

ColumnMisfireReason

The REASON column of TableMisfireHistory: the integer of the MisfireReason the firing was missed for, where null is MisfireReason.Missed.

public const string ColumnMisfireReason = "REASON"

Field Value

string

Remarks

Added by the optional 4.3 migration.

ColumnMisfireThreshold

The MISFIRE_THRESHOLD column of TableTriggers: the trigger's own MisfireThreshold in milliseconds, where null is the store's (#4070).

public const string ColumnMisfireThreshold = "MISFIRE_THRESHOLD"

Field Value

string

ColumnMisfireTime

The MISFIRE_TIME column of TableMisfireHistory: when the misfire was noticed, which is not a firing and so is not ColumnFiredTime.

public const string ColumnMisfireTime = "MISFIRE_TIME"

Field Value

string

ColumnNextFireTime

The NEXT_FIRE_TIME column of TableTriggers.

public const string ColumnNextFireTime = "NEXT_FIRE_TIME"

Field Value

string

ColumnOverlapPolicy

The OVERLAP_POLICY column of TableTriggers: the integer of the trigger's OverlapPolicy, where null is OverlapPolicy.Default.

public const string ColumnOverlapPolicy = "OVERLAP_POLICY"

Field Value

string

ColumnPauseReason

The PAUSE_REASON column of TableTriggers, TablePausedTriggers and TablePausedJobs: why the row was paused, cut to 250 characters.

public const string ColumnPauseReason = "PAUSE_REASON"

Field Value

string

ColumnPausedAt

The PAUSED_AT column of TableTriggers, TablePausedTriggers and TablePausedJobs: when the pause was made, in ticks. null on a row a 4.2 node paused.

public const string ColumnPausedAt = "PAUSED_AT"

Field Value

string

ColumnPausedBy

The PAUSED_BY column of TableTriggers, TablePausedTriggers and TablePausedJobs: who asked for the pause, cut to 200 characters.

public const string ColumnPausedBy = "PAUSED_BY"

Field Value

string

ColumnPreferredNode

The PREFERRED_NODE column of TableTriggers.

public const string ColumnPreferredNode = "PREFERRED_NODE"

Field Value

string

ColumnPreferredNodeAuto

The PREFERRED_NODE_AUTO column of TableTriggers.

public const string ColumnPreferredNodeAuto = "PREFERRED_NODE_AUTO"

Field Value

string

ColumnPreviousFireTime

The PREV_FIRE_TIME column of TableTriggers.

public const string ColumnPreviousFireTime = "PREV_FIRE_TIME"

Field Value

string

ColumnPriority

The PRIORITY column of TableTriggers.

public const string ColumnPriority = "PRIORITY"

Field Value

string

ColumnProgress

The PROGRESS column of TableFiredTriggers: the percentage a running job last reported through IJobExecutionContext.ReportProgress.

public const string ColumnProgress = "PROGRESS"

Field Value

string

ColumnProgressMessage

The PROGRESS_MESSAGE column of TableFiredTriggers: the message a running job last reported beside its percentage.

public const string ColumnProgressMessage = "PROGRESS_MESSAGE"

Field Value

string

ColumnQuartzVersion

The QUARTZ_VERSION column of TableSchedulerState: the Quartz version the node runs, as major.minor.patch, stamped at every check-in since 4.6 and NULL on a row an older node wrote (#4067).

public const string ColumnQuartzVersion = "QUARTZ_VERSION"

Field Value

string

ColumnRepeatCount

The REPEAT_COUNT column of TableSimpleTriggers.

public const string ColumnRepeatCount = "REPEAT_COUNT"

Field Value

string

ColumnRepeatInterval

The REPEAT_INTERVAL column of TableSimpleTriggers.

public const string ColumnRepeatInterval = "REPEAT_INTERVAL"

Field Value

string

ColumnRequestsRecovery

The REQUESTS_RECOVERY column of TableJobDetails.

public const string ColumnRequestsRecovery = "REQUESTS_RECOVERY"

Field Value

string

ColumnResult

The RESULT column of TableExecutionHistory: the integer of the run's JobRunResult.

public const string ColumnResult = "RESULT"

Field Value

string

Remarks

Added by the optional 4.4 migration. null on a row a 4.3 node wrote, whose outcome is ColumnSucceeded.

ColumnRetryAttempt

The RETRY_ATTEMPT column of TableTriggers.

public const string ColumnRetryAttempt = "RETRY_ATTEMPT"

Field Value

string

ColumnRetryPolicy

The RETRY_POLICY column of TableTriggers.

public const string ColumnRetryPolicy = "RETRY_POLICY"

Field Value

string

ColumnRetryScheduled

The RETRY_SCHEDULED column of TableExecutionHistory: whether the trigger answered this failure with another attempt, so the occurrence was not finished.

public const string ColumnRetryScheduled = "RETRY_SCHEDULED"

Field Value

string

Remarks

Beside ColumnRetryAttempt, which this table reuses from TableTriggers for the attempt the row is of. The two together are what lets a history page tell "failed, retrying" from "failed, and that was the last word" without reconstructing the occurrence from its rows.

ColumnRunCount

The RUN_COUNT column of TableJobStatus: how many runs the rollup counted.

public const string ColumnRunCount = "RUN_COUNT"

Field Value

string

ColumnRunTime

The RUN_TIME column of TableExecutionHistory, in ticks.

public const string ColumnRunTime = "RUN_TIME"

Field Value

string

Remarks

Ticks rather than the whole milliseconds every other duration here is kept as: a job's run time is whatever the clock measured, and GetDbTimeSpanValue(TimeSpan?) refuses a value that would not survive that round trip.

ColumnScheduledTime

The SCHED_TIME column of TableFiredTriggers.

public const string ColumnScheduledTime = "SCHED_TIME"

Field Value

string

ColumnSchedulerName

The SCHED_NAME column of TableJobDetails.

public const string ColumnSchedulerName = "SCHED_NAME"

Field Value

string

ColumnStartTime

The START_TIME column of TableTriggers.

public const string ColumnStartTime = "START_TIME"

Field Value

string

ColumnSucceeded

The SUCCEEDED column of TableExecutionHistory.

public const string ColumnSucceeded = "SUCCEEDED"

Field Value

string

ColumnSummary

The SUMMARY column of TableExecutionHistory: the one line the run reported, cut as ColumnErrorMessage is.

public const string ColumnSummary = "SUMMARY"

Field Value

string

Remarks

Added by the optional 4.4 migration.

ColumnTimeZoneId

The TIME_ZONE_ID column of TableBlobTriggers.

public const string ColumnTimeZoneId = "TIME_ZONE_ID"

Field Value

string

ColumnTimesTriggered

The TIMES_TRIGGERED column of TableSimpleTriggers.

public const string ColumnTimesTriggered = "TIMES_TRIGGERED"

Field Value

string

ColumnTriggerGroup

The TRIGGER_GROUP column of TableTriggers.

public const string ColumnTriggerGroup = "TRIGGER_GROUP"

Field Value

string

ColumnTriggerName

The TRIGGER_NAME column of TableTriggers.

public const string ColumnTriggerName = "TRIGGER_NAME"

Field Value

string

ColumnTriggerState

The TRIGGER_STATE column of TableTriggers.

public const string ColumnTriggerState = "TRIGGER_STATE"

Field Value

string

ColumnTriggerType

The TRIGGER_TYPE column of TableTriggers.

public const string ColumnTriggerType = "TRIGGER_TYPE"

Field Value

string

DefaultTablePrefix

The table prefix a store uses when the configuration names none.

public const string DefaultTablePrefix = "QRTZ_"

Field Value

string

ParameterPageSkip

The name of the parameter carrying how many rows a page skips.

public const string ParameterPageSkip = "pageSkip"

Field Value

string

Remarks

ApplyPaging(string, bool) splices these two names into the statement and AddPagingParameters(DbCommand, int, int, bool) binds them, and a delegate that overrides one of those members has to spell the same names in the other — so they are a contract between two assemblies, not one delegate's private detail. They are here rather than only on the internal list Quartz's own statements use, because this class is where the names a delegate must agree with already live.

The value is the bare name; the statement carries it prefixed, as "@" + ParameterPageSkip.

ParameterPageTake

The name of the parameter carrying how many rows a page reads.

public const string ParameterPageTake = "pageTake"

Field Value

string

Remarks

The other half of the pair ParameterPageSkip describes. It is absent from the statement altogether when the caller asked for an unbounded page.

StateAcquired

The stored state of a trigger acquired by a node, which will fire it.

public const string StateAcquired = "ACQUIRED"

Field Value

string

StateAwaiting

The stored state of a trigger waiting for another trigger's firing to end.

public const string StateAwaiting = "AWAITING"

Field Value

string

Remarks

No statement of the acquisition, misfire or cluster-recovery paths names it, which is what makes an awaiting row invisible to a 4.1 node in a mixed cluster: those paths select WAITING, and recovery touches ACQUIRED and BLOCKED. An unrecognised state string reads as Waiting on such a node, so it merely reports the trigger as normal. What it cannot do is settle one.

StateBlocked

The stored state of a trigger held back because another firing of its non-concurrent job is running.

public const string StateBlocked = "BLOCKED"

Field Value

string

StateComplete

The stored state of a trigger finished and will not fire again.

public const string StateComplete = "COMPLETE"

Field Value

string

StateDeleted

The stored state of a trigger deleted, which is a transient marker rather than a resting state.

public const string StateDeleted = "DELETED"

Field Value

string

StateError

The stored state of a trigger in error, and will not fire until it is reset.

public const string StateError = "ERROR"

Field Value

string

StateExecuting

The stored state of a trigger firing now.

public const string StateExecuting = "EXECUTING"

Field Value

string

StatePaused

The stored state of a trigger paused.

public const string StatePaused = "PAUSED"

Field Value

string

StatePausedBlocked

The stored state of a trigger paused and blocked at once, so resuming it leaves it blocked.

public const string StatePausedBlocked = "PAUSED_BLOCKED"

Field Value

string

StateWaiting

The stored state of a trigger waiting for its next fire time.

public const string StateWaiting = "WAITING"

Field Value

string

TableBlobTriggers

The BLOB_TRIGGERS table, without the table prefix.

public const string TableBlobTriggers = "BLOB_TRIGGERS"

Field Value

string

TableCalendars

The CALENDARS table, without the table prefix.

public const string TableCalendars = "CALENDARS"

Field Value

string

TableCronTriggers

The CRON_TRIGGERS table, without the table prefix.

public const string TableCronTriggers = "CRON_TRIGGERS"

Field Value

string

TableExecutionHistory

The EXECUTION_HISTORY table, without the table prefix.

public const string TableExecutionHistory = "EXECUTION_HISTORY"

Field Value

string

TableFiredTriggers

The FIRED_TRIGGERS table, without the table prefix.

public const string TableFiredTriggers = "FIRED_TRIGGERS"

Field Value

string

TableJobDetails

The JOB_DETAILS table, without the table prefix.

public const string TableJobDetails = "JOB_DETAILS"

Field Value

string

TableJobStatus

The JOB_STATUS table, without the table prefix: one row per job, rolled up from TableExecutionHistory as each row is written.

public const string TableJobStatus = "JOB_STATUS"

Field Value

string

Remarks

Created by the optional 4.4 migration, and read and written only by a store keeping its execution history in the database.

TableLocks

The LOCKS table, without the table prefix.

public const string TableLocks = "LOCKS"

Field Value

string

TableMisfireHistory

The MISFIRE_HISTORY table, without the table prefix.

public const string TableMisfireHistory = "MISFIRE_HISTORY"

Field Value

string

TablePausedJobs

The PAUSED_JOB_GRPS table, without the table prefix.

public const string TablePausedJobs = "PAUSED_JOB_GRPS"

Field Value

string

TablePausedTriggers

The PAUSED_TRIGGER_GRPS table, without the table prefix.

public const string TablePausedTriggers = "PAUSED_TRIGGER_GRPS"

Field Value

string

TableSchedulerState

The SCHEDULER_STATE table, without the table prefix.

public const string TableSchedulerState = "SCHEDULER_STATE"

Field Value

string

TableSimplePropertiesTriggers

The SIMPROP_TRIGGERS table, without the table prefix.

public const string TableSimplePropertiesTriggers = "SIMPROP_TRIGGERS"

Field Value

string

TableSimpleTriggers

The SIMPLE_TRIGGERS table, without the table prefix.

public const string TableSimpleTriggers = "SIMPLE_TRIGGERS"

Field Value

string

TableTriggers

The TRIGGERS table, without the table prefix.

public const string TableTriggers = "TRIGGERS"

Field Value

string

TriggerTypeBlob

A general blob Trigger type.

public const string TriggerTypeBlob = "BLOB"

Field Value

string

TriggerTypeCalendarInterval

Calendar Interval Trigger type.

public const string TriggerTypeCalendarInterval = "CAL_INT"

Field Value

string

TriggerTypeCron

Cron Trigger type.

public const string TriggerTypeCron = "CRON"

Field Value

string

TriggerTypeDailyTimeInterval

Daily Time Interval Trigger type.

public const string TriggerTypeDailyTimeInterval = "DAILY_I"

Field Value

string

TriggerTypeRecurrence

Recurrence (RRULE) Trigger type.

public const string TriggerTypeRecurrence = "RECUR"

Field Value

string

TriggerTypeSimple

Simple Trigger type.

public const string TriggerTypeSimple = "SIMPLE"

Field Value

string
Edit this page