Safe Haskell	None
Language	GHC2024

Arbiter.Core.CronSchedule

Contents

Types
Effective values
DDL

Description

Internal to the arbiter packages. Not covered by the PVP.

Types and DDL for the cron_schedules table.

Code-defined defaults and user overrides sit in separate columns. Worker pool startup upserts the defaults. An override survives every deploy.

Synopsis

data CronScheduleRow = CronScheduleRow {
- name :: Text
- queueName :: Text
- defaultExpression :: Text
- defaultOverlap :: Text
- defaultTimezone :: Maybe Text
- overrideExpression :: Maybe Text
- overrideOverlap :: Maybe Text
- overrideTimezone :: Maybe Text
- enabled :: Bool
- lastFiredAt :: Maybe UTCTime
- lastCheckedAt :: Maybe UTCTime
- runRequestedAt :: Maybe UTCTime
- lastManualRunAt :: Maybe UTCTime
- createdAt :: UTCTime
- updatedAt :: UTCTime
}
data CronScheduleUpdate = CronScheduleUpdate {
- overrideExpression :: Maybe (Maybe Text)
- overrideOverlap :: Maybe (Maybe Text)
- overrideTimezone :: Maybe (Maybe Text)
- enabled :: Maybe Bool
}
effectiveExpression :: CronScheduleRow -> Text
effectiveOverlap :: CronScheduleRow -> Text
effectiveTimezone :: CronScheduleRow -> Maybe Text
cronSchedulesTable :: SchemaName -> Text
cronSchedulesTableName :: Text
createCronSchedulesTableSQL :: SchemaName -> Text
addTimezoneColumnSQL :: SchemaName -> Text
addQueueNameColumnSQL :: SchemaName -> Text
addRunRequestedColumnSQL :: SchemaName -> Text
addLastManualRunColumnSQL :: SchemaName -> Text

Types

data CronScheduleRowSource #

A row from the cron_schedules table.

Constructors

CronScheduleRow

Fields

name :: Text
Schedule name.
queueName :: Text
The queue the schedule inserts into.
defaultExpression :: Text
Code-defined cron expression.
defaultOverlap :: Text
Code-defined overlap policy: SkipOverlap or AllowOverlap.
defaultTimezone :: Maybe Text
Code-defined IANA tz name. Nothing means UTC.
overrideExpression :: Maybe Text
User override. Nothing uses the default.
overrideOverlap :: Maybe Text
User override: SkipOverlap or AllowOverlap. Nothing uses the default.
overrideTimezone :: Maybe Text
User override. Nothing uses the default. To force UTC when the default is not UTC, set to "UTC".
enabled :: Bool
A disabled schedule fires no jobs.
lastFiredAt :: Maybe UTCTime
The minute of the last tick that fired. Nothing when it never fired.
lastCheckedAt :: Maybe UTCTime
How far the scheduler has checked for ticks. Nothing when it never checked.
runRequestedAt :: Maybe UTCTime
Manual run awaiting a worker pool. Nothing when none is pending.
lastManualRunAt :: Maybe UTCTime
When a manual run last fired a job. Nothing when it never fired.
createdAt :: UTCTime
When the row was created.
updatedAt :: UTCTime
When the row last changed.

Instances

Instances details

FromJSON CronScheduleRow Source #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

parseJSON :: Value -> Parser CronScheduleRow#

parseJSONList :: Value -> Parser [CronScheduleRow]#

omittedField :: Maybe CronScheduleRow#

ToJSON CronScheduleRow Source #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

toJSON :: CronScheduleRow -> Value#

toEncoding :: CronScheduleRow -> Encoding#

toJSONList :: [CronScheduleRow] -> Value#

toEncodingList :: [CronScheduleRow] -> Encoding#

omitField :: CronScheduleRow -> Bool#

Eq CronScheduleRow Source #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

(==) :: CronScheduleRow -> CronScheduleRow -> Bool#

(/=) :: CronScheduleRow -> CronScheduleRow -> Bool#

Generic CronScheduleRow Source #

Instance details

Defined in Arbiter.Core.CronSchedule

Associated Types

type Rep CronScheduleRow

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

from :: CronScheduleRow -> Rep CronScheduleRow x#

to :: Rep CronScheduleRow x -> CronScheduleRow#

Show CronScheduleRow Source #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

showsPrec :: Int -> CronScheduleRow -> ShowS#

show :: CronScheduleRow -> String#

showList :: [CronScheduleRow] -> ShowS#

type Rep CronScheduleRow Source #

Instance details

Defined in Arbiter.Core.CronSchedule

data CronScheduleUpdateSource #

A patch over a cron schedule's overrides. Nothing leaves a field unchanged, Just Nothing clears the override back to the default, Just (Just v) sets it.

Constructors

CronScheduleUpdate
Fields overrideExpression :: Maybe (Maybe Text) The cron expression override. overrideOverlap :: Maybe (Maybe Text) The overlap policy override. overrideTimezone :: Maybe (Maybe Text) The timezone override. enabled :: Maybe Bool The enabled flag. `Just` sets it.