Help:Configuration parameter "$smwgEnabledHttpDeferredJobRequest"

From semantic-mediawiki.org
Jump to: navigation, search
edit with form (experimental)


Title $smwgEnabledHttpDeferredJobRequest
Description Sets whether selected jobs can be executed asynchronously to the initial transaction triggering the job
Default setting
true
(Other) available settings
false

Allows to change updates to be done with the initial transaction and parked as jobs, waiting on job scheduler to initiate the update

SMW_HTTP_DEFERRED_SYNC_JOB

Allows to change updates to be done synchronously with the update transaction, i.e. jobs are executed immediately

SMW_HTTP_DEFERRED_LAZY_JOB

Allows to change updates to be buffered, i.e. job are executed after MediaWiki has done all its transactions

Software Semantic MediaWiki
First version supported 2.3.0
Last version supported still available
Configuration Installation
Keyword Query · Performance

Sketch detailing the technical process involving the "Deferred­Request­Dispatch­Manager"

$smwgEnabledHttpDeferredJobRequest is a configuration parameter to control the behaviour of "DeferredRequestDispatchManager" to manage and execute selected jobs asynchronously, i.e. in a deferred processing mode to the initial transaction triggering the job. If enabled which is the default setting for this configuration parameter those jobs are send as request to a dispatcher in order for them to be decoupled from the initial transaction. The setting was introduced in Semantic MediaWiki 2.3.0.1

Semantic MediaWiki 2.5.0 added the SMW_HTTP_DEFERRED_SYNC_JOB option to this configuration parameter to control updates to be executed synchronously to a change propagation transaction.2 This option helps to mitigate a situation where for some reason the "DeferredRequestDispatchManager" is unable to complete the request and waiting on the job scheduler is not a choice.3

Semantic MediaWiki 2.5.1 added the SMW_HTTP_DEFERRED_LAZY_JOB option to this configuration parameter to buffer updates to be executed after MediaWiki has done all its transactions.4. This option helps to mitigate a situation where for some reason the "DeferredRequestDispatchManager" lets users seeing the enqueue latency in case several calls are mode on the same queue.

NoteNote: This setting only takes effect if the embedded query update feature was enabled.

Default setting

$smwgEnabledHttpDeferredJobRequest = true;

Changing the default setting

To modify this configuration setting, add one of the following lines to your "LocalSettings.php" file after the enableSemantics() call:

Change updates to be done synchronously with the update transaction (jobs are executed immediately)
$smwgEnabledHttpDeferredJobRequest = SMW_HTTP_DEFERRED_SYNC_JOB;
Change updates to be done synchronously with the update transaction (jobs are batched and executed later on idle)
$smwgEnabledHttpDeferredJobRequest = SMW_HTTP_DEFERRED_LAZY_JOB;
Change updates to be done with the initial transaction and parked as jobs, waiting on job scheduler to initiate the update
$smwgEnabledHttpDeferredJobRequest = false;

See also