Difference between revisions of "Job Module"

From BaseX Documentation
Jump to navigation Jump to search
(4 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
All functions in this module are assigned to the <code><nowiki>http://basex.org/modules/jobs</nowiki></code> namespace, which is statically bound to the {{Code|jobs}} prefix. Errors will be bound to the same prefix.
 
All functions in this module are assigned to the <code><nowiki>http://basex.org/modules/jobs</nowiki></code> namespace, which is statically bound to the {{Code|jobs}} prefix. Errors will be bound to the same prefix.
  
=Functions=
+
=Services=
 +
 
 +
{{Mark|Introduced with Version 9.0:}}
 +
 
 +
Jobs can additionally be registered as persistent services. An additional {{Code|service}} option has been added to the options list of {{Function|Jobs|jobs:eval}} and {{Function|Jobs|jobs:invoke}}:
 +
 
 +
<pre class="brush:xquery">
 +
(: register job, which will be run every day at 1 am :)
 +
jobs:eval('db:drop("tmp")', (), map { 'id':'cleanup', 'start':'01:00:00', 'interval':'P1D', 'service': true() }),
 +
 
 +
(: list registered services :)
 +
jobs:services(),
 +
(: result: <job base-uri="..." id="cleanup" interval="P1D" start="01:00:00">db:drop("tmp")</job> :)
 +
 
 +
(: unregister job :)
 +
jobs:stop('cleanup', map { 'service': true() })
 +
</pre>
 +
 
 +
'''Some more notes:'''
 +
 
 +
* All registered jobs 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.
 +
* Job services can be updated: If a new job is registered, and if there is already a job with the same id, the old entry will be replaced.
 +
* The job definitions are stored in a {{Code|jobs.xml}} file in the database directory. It can also be edited manually.
 +
 
 +
=Basic Functions=
  
 
==jobs:current==
 
==jobs:current==
Line 56: Line 81:
 
</pre>
 
</pre>
 
|}
 
|}
 
==jobs:finished==
 
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|jobs:finished|$id as xs:string|xs:boolean}}
+
|{{Func|jobs:services||element(job)*}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Indicates if the evaluation of an already running job with the specified {{Code|$id}} has finished. As the ids of finished jobs will usually be discarded, unless caching is enabled, the function will also return <code>true</code> for unknown jobs.
+
|Returns a list of all jobs that have been persistently registered as [[#Services|Services]].
* <code>false</code> indicates that the job id is scheduled, queued, or currently running.
 
* <code>true</code> 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).
 
|}
 
 
 
==jobs:stop==
 
 
 
{| width='100%'
 
 
|-
 
|-
| width='120' | '''Signatures'''
+
| '''Errors'''
|{{Func|jobs:stop|$id as xs:string|empty-sequence()}}
+
|{{Error|services|#Errors}} Registered services cannot be parsed.<br/>
|-
 
| '''Summary'''
 
|Triggers the cancelation of a job with the specified {{Code|$id}}, drops the cached result of a query, or cancels a scheduled job. Unknown ids are ignored. All jobs are gracefully stopped; it is up to the process to decide when it is safe to shut down.
 
|-
 
| '''Examples'''
 
| <code>jobs:list()[. != jobs:current()] ! jobs:stop(.)</code> stops and discards all jobs except for the current one.
 
 
|}
 
|}
  
==jobs:wait==
+
==jobs:finished==
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Func|jobs:wait|$id as xs:string|empty-sequence()}}
+
|{{Func|jobs:finished|$id as xs:string|xs:boolean}}
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Waits for the completion of a job with the specified {{Code|$id}}:
+
|Indicates if the evaluation of an already running job with the specified {{Code|$id}} has finished. As the ids of finished jobs will usually be discarded, unless caching is enabled, the function will also return <code>true</code> for unknown jobs.
* 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.
+
* <code>false</code> indicates that the job id is scheduled, queued, or currently running.
* If the function is called with the id of a queued job, or repeatedly executed job, it may stall and never terminate.
+
* <code>true</code> 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).
|-
 
| '''Errors'''
 
|{{Error|self|#Errors}} The current job is addressed.<br/>
 
 
|}
 
|}
  
=Asynchronous Execution=
+
=Execution=
  
 
Asynchronous query execution is recommendable if a client does not, or cannot, wait until a request is fully processed. This is e. g. the case with web browsers, which will usually cancel a request after a specific timeout. In such cases, you can use asynchronous execution to trigger another server-side process, which will start the time-consuming process, and fetch the result later on as soon as it is available.
 
Asynchronous query execution is recommendable if a client does not, or cannot, wait until a request is fully processed. This is e. g. the case with web browsers, which will usually cancel a request after a specific timeout. In such cases, you can use asynchronous execution to trigger another server-side process, which will start the time-consuming process, and fetch the result later on as soon as it is available.
Line 112: Line 119:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Schedules the evaluation of the supplied {{Code|$query}} and returns a query id. The query will be queued, and the result will optionally be cached. Queries can be updating. Variables and context items can be declared via {{Code|$bindings}} (see [[XQuery Module#xquery:eval|xquery:eval]] for more details). The {{Code|$options}} parameter contains scheduling options:
+
|Schedules the evaluation of the supplied {{Code|$query}} and returns a query id. The query will be queued, and the result will optionally be cached. Queries can be updating. Variables and context items can be declared via {{Code|$bindings}} (see [[XQuery Module#xquery:eval|xquery:eval]] for more details). The following {{Code|$options}} can be supplied:
 
* {{Code|cache}}: indicates if the query result will be cached or ignored (default: <code>false</code>):
 
* {{Code|cache}}: indicates if the query result will be cached or ignored (default: <code>false</code>):
 
** The result will be cached in main-memory until it is fetched via [[#jobs:result|jobs:result]], or until {{Option|CACHETIMEOUT}} is exceeded.
 
** The result will be cached in main-memory until it is fetched via [[#jobs:result|jobs:result]], or until {{Option|CACHETIMEOUT}} is exceeded.
Line 124: Line 131:
 
* {{Code|base-uri}}: sets the [https://www.w3.org/TR/xquery-31/#dt-static-base-uri base-uri property] for the query. This URI will be used when resolving relative URIs, such as with {{Code|fn:doc}}.
 
* {{Code|base-uri}}: sets the [https://www.w3.org/TR/xquery-31/#dt-static-base-uri base-uri property] for the query. This URI will be used when resolving relative URIs, such as with {{Code|fn:doc}}.
 
* {{Code|id}}: sets a custom job id. The id must not start with the standard <code>job</code> prefix, and it can only be assigned if no job with the same name exists.
 
* {{Code|id}}: sets a custom job id. The id must not start with the standard <code>job</code> prefix, and it can only be assigned if no job with the same name exists.
 +
* {{Code|service}}: additionally registers the job as [[#Services|service]].
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
Line 172: Line 180:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Schedules the evaluation of the XQuery expression located at {{Code|$uri}} and returns a query id. The semantics and remaining arguments are identical to [[#jobs:eval|jobs:eval]].
+
|Schedules the evaluation of the XQuery expression located at {{Code|$uri}} and returns a query id. For further details, see [[#jobs:eval|jobs:eval]].
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
Line 216: Line 224:
 
</pre>
 
</pre>
 
Please note that queries of this kind can cause deadlocks. For example, if both the original query and the query to be executed asynchronously perform updates on the same database, the second query would only be run after the first one has been executed, and the first query will wait forever. This is why you should avoid this pattern in practice and resort to [[XQuery Module#xquery:fork-join|xquery:fork-join]] if you want to do things in parallel.
 
Please note that queries of this kind can cause deadlocks. For example, if both the original query and the query to be executed asynchronously perform updates on the same database, the second query would only be run after the first one has been executed, and the first query will wait forever. This is why you should avoid this pattern in practice and resort to [[XQuery Module#xquery:fork-join|xquery:fork-join]] if you want to do things in parallel.
 +
|}
 +
 +
==jobs:stop==
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|jobs:stop|$id as xs:string|empty-sequence()}}
 +
|-
 +
| '''Summary'''
 +
|Triggers the cancelation of a job with the specified {{Code|$id}}, drops the cached result of a query, or cancels a scheduled job. 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 {{Code|$options}} can be supplied:
 +
* {{Code|service}}: additionally removes the job from the [[#Services|job services]] list.
 +
|-
 +
| '''Examples'''
 +
| <code>jobs:list()[. != jobs:current()] ! jobs:stop(.)</code> stops and discards all jobs except for the current one.
 +
|}
 +
 +
==jobs:wait==
 +
 +
{| width='100%'
 +
|-
 +
| width='120' | '''Signatures'''
 +
|{{Func|jobs:wait|$id as xs:string|empty-sequence()}}
 +
|-
 +
| '''Summary'''
 +
|Waits for the completion of a job with the specified {{Code|$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'''
 +
|{{Error|self|#Errors}} The current job is addressed.<br/>
 
|}
 
|}
  
Line 241: Line 280:
 
|{{Code|self}}
 
|{{Code|self}}
 
| The current job cannot be addressed.
 
| The current job cannot be addressed.
 +
|-
 +
|{{Code|service}}
 +
| Registered services cannot be parsed, added or removed.
 
|-
 
|-
 
|{{Code|unknown}}
 
|{{Code|unknown}}
Line 250: Line 292:
 
;Version 9.0
 
;Version 9.0
  
* Added: [[#jobs:invoke|jobs:invoke]]
+
* Added: {{Function|Jobs|jobs:invoke}}, [[#Services|Services]]
  
 
;Version 8.6
 
;Version 8.6

Revision as of 14:49, 1 March 2018

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

Conventions

All functions in this module are assigned to the http://basex.org/modules/jobs namespace, which is statically bound to the jobs prefix. Errors will be bound to the same prefix.

Services

Template:Mark

Jobs can additionally be registered as persistent services. An additional service option has been added to the options list of jobs:eval and jobs:invoke:

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

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

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

Some more notes:

  • All registered jobs 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.
  • Job services can be updated: If a new job is registered, and if there is already a job with the same id, the old entry will be replaced.
  • The job definitions are stored in a jobs.xml file in the database directory. It can also be edited manually.

Basic Functions

jobs:current

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

jobs:list

Signatures jobs: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 jobs:list() returns the same job id as jobs:current if no other job is registered.

jobs:list-details

Signatures jobs:list-details() as element(job)*
jobs: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 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, or cached)
  • user: the user who started the job
  • duration: evaluation time (for running and cached jobs)
  • start: dateTime string with next start (for jobs that will be executed repeatedly)
Examples jobs: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 jobs:list-details()
</job>
Signatures jobs: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.

jobs:finished

Signatures jobs: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).

Execution

Asynchronous query execution is recommendable if a client does not, or cannot, wait until a request is fully processed. This is e. g. the case with web browsers, which will usually cancel a request after a specific timeout. In such cases, you can use asynchronous execution to trigger another server-side process, which will start the time-consuming process, and fetch the result later on as soon as it is available.

jobs:eval

Signatures jobs:eval($query as xs:string) as xs:string
jobs:eval($query as xs:string, $bindings as map(*)?) as xs:string
jobs:eval($query as xs:string, $bindings as map(*)?, $options as map(*)?) as xs:string
Summary Schedules the evaluation of the supplied $query and returns a query id. The query will be queued, and the result will optionally be cached. Queries can be updating. Variables and context items 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 jobs:result, or until CACHETIMEOUT is exceeded.
    • If the query raises an error, it will be cached and returned instead.
  • start: a dayTimeDuration, time or dateTime 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 for 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 time is specified, the query will be executed at this time of the day. Examples for 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.
    • 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.
  • 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.
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.
Examples
  • Cache query result. The returned id can be used to pick up the result with jobs:result:
jobs:eval("1+3", (), map { 'cache': true() })
  • A happy birthday mail will be sent at the given date:
jobs: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) {
  jobs:eval($query, (), map { 'start': '02:00:00', 'interval': 'P1D' })
};
declare %rest:path('/stop-scheduling/{$id}') function local:stop($id) {
  jobs: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:
jobs:eval("prof:sleep(1500)", (), map { 'interval': 'PT1S', 'end': 'PT10S' })
  • The following expression, if stored as a file, calls and evaluates itself every 5 seconds:
jobs:eval(
  file:read-text(static-base-uri()),
  map { },
  map { 'start': 'PT5S' }
)

jobs:invoke

Template:Mark

Signatures jobs:invoke($uri as xs:string) as xs:string
jobs:invoke($uri as xs:string, $bindings as map(*)?) as xs:string
jobs:invoke($uri as xs:string, $bindings as map(*)?, $options as map(*)?) as xs:string
Summary Schedules the evaluation of the XQuery expression located at $uri and returns a query id. For further details, see jobs:eval.
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.
Examples Run XQuery expression that may perform some cleanups:
jobs:invoke("cleanup.xq", (), ())

jobs:result

Signatures jobs:result($id as xs:string) as item()*
Summary Returns the cached result of a job with the specified job $id:
  • Results can only be retrieved once. After retrieval, the cached result will be dropped.
  • If the original job has raised an error, the cached error will be raised instead.
Errors running: the job is still running.
unknown: the supplied id is unknown: The id is unknown, or the result has already been retrieved.
Examples
  • 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) {
  jobs:result($id)
};
  • The following query demonstrates how the results of an asynchronously executed query can be returned within the same query:
let $query := jobs:eval('(1 to 10000000)[. = 1]', map{}, map{ 'cache': true() })
return (
  jobs:wait($query),
  jobs:result($query)
)

Please note that queries of this kind can cause deadlocks. For example, if both the original query and the query to be executed asynchronously perform updates on the same database, the second query would only be run after the first one has been executed, and the first query will wait forever. This is why you should avoid this pattern in practice and resort to xquery:fork-join if you want to do things in parallel.

jobs:stop

Signatures jobs:stop($id as xs:string) as empty-sequence()
Summary Triggers the cancelation of a job with the specified $id, drops the cached result of a query, or cancels a scheduled job. 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.
Examples jobs:list()[. != jobs:current()] ! jobs:stop(.) stops and discards all jobs except for the current one.

jobs:wait

Signatures jobs: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.

Errors

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.
unknown The supplied query id is unknown or not available anymore.

Changelog

Version 9.0
Version 8.6

The module was introduced with Version 8.5.