Job Module

From BaseX Documentation
Revision as of 09:49, 28 July 2022 by CG (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Updated with Version 10: Renamed from Jobs Module to Job Module. The namespace URI has been updated as well.

This XQuery Module provides functions for organizing scheduled, queued, running and cached jobs. Jobs can be commands, queries, client, or HTTP requests.


All functions in this module are assigned to the namespace, which is statically bound to the job prefix. Errors will be bound to the same prefix.


A job can be registered as service by supplying the service option to job:eval:

(: register job as service; will be run every day at 1 am :)
job:eval('db:drop("tmp")', (), map { 'id':'cleanup', 'start':'01:00:00', 'interval':'P1D', 'service': true() }),

(: list registered services :)
(: result: <job base-uri="..." id="cleanup" interval="P1D" start="01:00:00">db:drop("tmp")</job> :)

(: unregister job :)
job:remove('cleanup', map { 'service': true() })

Some more notes:

  • All job services will be scheduled for evaluation when the BaseX server or BaseX HTTP server is started.
  • If a job service is outdated (e.g. because a supplied end time has been exceeded), it will be removed from the jobs file at startup time.
  • The job definitions are stored in a jobs.xml file in the database directory. It can also be edited manually.

Executing Jobs[edit]

There are cases in which a client does not, or cannot, wait until a request is fully processed. The client may be a browser, which sends an HTTP request to the server to start another time-consuming query job. The functions in this section allow you to register a new query job from a running query. Jobs can be executed immediately (i.e., as soon as the Concurrency Control allows it) or scheduled for repeated execution. Each registered job gets a job ID, and the ID can be used to retrieve a query result, stop a job, or wait for its termination.


Signatures job:eval($query as xs:anyAtomicType) as xs:string
job:eval($query as xs:anyAtomicType, $bindings as map(*)?) as xs:string
job:eval($query as xs:anyAtomicType, $bindings as map(*)?, $options as map(*)?) as xs:string
Summary Schedules the evaluation of the supplied $query (xs:string, or of type xs:anyURI, pointing to a resource), and returns a query ID. The query will be queued, and the result will optionally be cached. Queries can be updating. Variables and the context value can be declared via $bindings (see xquery:eval for more details). The following $options can be supplied:
  • cache: indicates if the query result will be cached or ignored (default: false):
    • The result will be cached in main-memory until it is fetched via job:result, or until CACHETIMEOUT is exceeded.
    • If the query raises an error, it will be cached and returned instead.
  • start: a dayTimeDuration, time, dateTime or integer can be specified to delay the execution of the query:
    • If a dayTimeDuration is specified, the query will be queued after the specified duration has passed. Examples of valid values are: P1D (1 day), PT5M (5 minutes), PT0.1S (100 ms). An error will be raised if a negative value is specified.
    • If a dateTime is specified, the query will be executed at this date. Examples for valid values are: 2018-12-31T23:59:59 (New Year's Eve 2018, close to midnight). An error will be raised if the specified time lies in the past.
    • If a time is specified, the query will be executed at this time of the day. Examples of valid times are: 02:00:00 (2am local time), 12:00:00Z (noon, UTC). If the time lies in the past, the query will be executed the next day.
    • An integer will be interpreted as minutes. If the specified number is greater than the elapsed minutes of the current hour, the query will be executed one hour later.
  • interval: a dayTimeDuration string can be specified to execute the query periodically. An error is raised if the specified interval is less than one second (PT1S). If the next scheduled call is due, and if a query with the same ID is still running, it will be skipped.
  • end: scheduling can be stopped after a given time or duration. The string format is the same as for start. An error is raised if the resulting end time is smaller than the start time.
  • base-uri: sets the base-uri property for the query. This URI will be used when resolving relative URIs, such as with fn:doc.
  • id: sets a custom job ID. The ID must not start with the standard job prefix, and it can only be assigned if no job with the same name exists.
  • service: additionally registers the job as service. Registered services must have no variable bindings.
  • log: writes the specified string to the database logs. Two log entries are stored, one at the beginning and another one after the execution of the job.
Errors overflow: Query execution is rejected because too many jobs are queued or being executed. CACHETIMEOUT can be decreased if the default setting is too restrictive.
range: A specified time or duration is out of range.
id: The specified ID is invalid or has already been assigned.
options: The specified options are conflicting.
  • Cache query result. The returned ID can be used to pick up the result with job:result:
job:eval("1+3", (), map { 'cache': true() })
  • A happy birthday mail will be sent at the given date:
job:eval("import module namespace mail='mail'; mail:send('Happy birthday!')",
  (), map { 'start': '2018-09-01T06:00:00' })}}
  • The following RESTXQ functions can be called to execute a query at 2 am every day. An ID will be returned by the first function, which can be used to stop the scheduler via the second function:
declare %rest:POST("{$query}") %rest:path('/start-scheduling') function local:start($query) {
  job:eval($query, (), map { 'start': '02:00:00', 'interval': 'P1D' })
declare %rest:path('/stop-scheduling/{$id}') function local:stop($id) {
  • Query execution is scheduled for every second, and for 10 seconds in total. As the query itself will take 1.5 seconds, it will only be executed every second time:
job:eval("prof:sleep(1500)", (), map { 'interval': 'PT1S', 'end': 'PT10S' })
  • The query in the specified file will be evaluated once:
  • The following expression, if stored in a file, will be evaluated every 5 seconds:
  map { },
  map { 'start': 'PT5S' }


Version 10: options argument added.

Signatures job:result($id as xs:string) as item()*
job:result($id as xs:string, $options as map(*)) as item()*
Summary Returns the cached result of a job with the specified job $id:
  • If the original job has raised an error, the cached error will be raised instead.
  • The cached result or error will be dropped after it has been retrieved.
  • If the result has not been cached or if it has been dropped, an empty sequence is returned.

The following $options can be supplied:

  • keep: Keep the cached result or error after retrieval.
  • The following RESTXQ function will either return the result of a previously started job or raise an error:
declare %rest:path('/result/{$id}') function local:result($id) {
  • The following query demonstrates how the results of an executed query can be returned within the same query (see below why you should avoid this pattern in practice):
let $query := job:eval('(1 to 10000000)[. = 1]', map { }, map { 'cache': true() })
return (

Queries of this kind can cause deadlocks! If the original query and the new query perform updates on the same database, the second query will only be run after the first one has been executed, and the first query will wait for the second query forever. You should resort to xquery:fork-join if you want to have full control on parallel query execution.


Updated with Version 10: Renamed from jobs:stop.

Signatures job:remove($id as xs:string) as empty-sequence()
job:remove($id as xs:string, $options as map(*)?) as empty-sequence()
Summary Triggers the cancelation of a job with the specified $id, cancels a scheduled job or removes a cached result. Unknown IDs are ignored. All jobs are gracefully stopped; it is up to the process to decide when it is safe to shut down. The following $options can be supplied:
  • service: additionally removes the job from the job services list.
  • job:list()[. != job:current()] ! job:remove(.) stops and discards all jobs except for the current one.
  • job:remove(job:current()) interrupts the current job.


Signatures job:wait($id as xs:string) as empty-sequence()
Summary Waits for the completion of a job with the specified $id:
  • The function will terminate immediately if the job ID is unknown. This is the case if a future job has not been queued yet, or if the ID has already been discarded after job evaluation.
  • If the function is called with the ID of a queued job, or repeatedly executed job, it may stall and never terminate.
Errors self: The current job is addressed.

Listing Jobs[edit]


Signatures job:current() as xs:string
Summary Returns the ID of the current job.


Signatures job:list() as xs:string*
Summary Returns the IDs of all jobs that are currently registered. The list includes scheduled, queued, running, stopped, and finished jobs with cached results.
Examples job:list() returns the same job ID as job:current if no other job is registered.


Signatures job:list-details() as element(job)*
job:list-details($id as xs:string) as element(job)*
Summary Returns information on all jobs that are currently registered, or on a job with the specified $id (or an empty sequence if this job is not found). The list includes scheduled, queued, running jobs, and cached jobs. A string representation of the job, or its URI, will be returned as a value. The returned elements have additional attributes:
  • id: job ID
  • type: type of the job (command, query, REST, RESTXQ, etc.)
  • state: current state of the job: scheduled, queued, running, cached
  • user: user who started the job
  • duration: evaluation time (included if a job is running or if the result was cached)
  • start: next start of job (included if a job will be executed repeatedly)
  • time: time when job was registered
Examples job:list-details() returns information on the currently running job and possibly others:
<job id="job1" type="XQuery" state="running" user="admin" duration="PT0.001S">
  XQUERY job:list-details()


Introduced with Version 10.

Signatures job:bindings($id as xs:string) as map(*)
Summary Returns the variable bindings of an existing job with the specified $id. If no variables have been bound to this job, an empty map is returned.


Signatures job:finished($id as xs:string) as xs:boolean
Summary Indicates if the evaluation of an already running job with the specified $id has finished. As the IDs of finished jobs will usually be discarded, unless caching is enabled, the function will also return true for unknown jobs.
  • false indicates that the job ID is scheduled, queued, or currently running.
  • true will be returned if the job has either finished, or if the ID is unknown (because the IDs of all finished jobs will not be cached).


Signatures job:services() as element(job)*
Summary Returns a list of all jobs that have been persistently registered as Services.
Errors services: Registered services cannot be parsed.


Code Description
options The specified options are conflicting.
id The specified ID is invalid or has already been assigned.
overflow Too many queries or query results are queued.
range A specified time or duration is out of range.
running A query is still running.
self The current job cannot be addressed.
service Registered services cannot be parsed, added or removed.


Version 10.0
  • Updated: Renamed from Jobs Module to Job Module. The namespace URI has been updated as well.
  • Updated: job:remove renamed from jobs:stop.
  • Updated: job:result: options argument added.
  • Added: job:bindings
Version 9.7
  • Updated: job:result: return empty sequence if no result is cached.
Version 9.5
  • Updated: job:eval: integers added as valid start and end times.
Version 9.4
Version 9.2
  • Deleted: job:invoke (merged with job:eval)
Version 9.1
Version 9.0
Version 8.6

The module was introduced with Version 8.5.