proletarian.job — msolli/proletarian 1.0.65-alpha

enqueue! clj

(enqueue! conn
          job-type
          payload
          &
          {:keys [process-at process-in]
           :proletarian/keys [queue job-table serializer uuid-fn clock]
           :or {queue db/DEFAULT_QUEUE
                job-table db/DEFAULT_JOB_TABLE
                serializer (transit/create-serializer)
                uuid-fn (fn [] (UUID/randomUUID))
                clock (Clock/systemUTC)}})

Enqueue a job in the Proletarian job queue.

Returns the job-id (a UUID) of the enqueued job.

Arguments

• conn – a [[java.sql.Connection]] database connection.
• job-type – a keyword that identifies the job type. The job type will be passed to your handler function (see second argument to proletarian.worker/create-queue-worker) as the first argument. Optionally implement the [[retry-strategy]] multimethod for this keyword to describe the retry strategy for this job type.
• payload – the data that the job needs. It will be encoded and decoded using the serializer (see Options, below). The payload will be passed to your handler function as the second argument.
• options – (optional) keyword arguments or a map describing configuration options, see below.

Options

The following two keys control when a job is processed:

• :process-at - a [[java.time.Instant]] for when the job should be processed.
• :process-in - a [[java.time.Duration]] for when the job should be processed. The value is added to the current time to get the actual time for processing.

If both keys are provided, :process-at takes precedence.

The following keys are configuration options, all optional with default values:

• :proletarian/queue – a keyword with the name of the queue. The default value is :proletarian/default.
• :proletarian/job-table – which PostgreSQL table to write the job to. The default is proletarian.job. You should only have to override this if you changed the default table name during installation.
• :proletarian/serializer – an implementation of the proletarian.protocols/Serializer protocol. The default is a Transit serializer (see proletarian.transit/create-serializer). If you override this, you should use the same serializer for proletarian.worker/create-queue-worker.
• :proletarian/uuid-fn – a function for generating UUIDs. Used in testing. The default is [[java.util.UUID/randomUUID]].
• :proletarian/clock – the [[java.time.Clock]] to use for getting the current time. Used in testing. The default is [[java.time.Clock/systemUTC]].