View source for Manual:$wgWANObjectCaches/de-formal

<languages />
{{SettingSummary
|name = WANObjectCaches
|version_min = 1.26.0
|rev_introduced =
|sha_introduced = 3a1f8b111132f5b21d60e9c83ca2cd7d0bb79bd0
|change_introduced = 187074
|version_max = 1.40.0
|sha_removed = 39ead04e984c
|change_removed = 889244
|newvarname = $wgWANObjectCache
|section = Cache
|range = (<span lang="en" dir="ltr" class="mw-content-ltr">array</span>)
|default = ''<span lang="en" dir="ltr" class="mw-content-ltr">see below</span>''
|summary = <span lang="en" dir="ltr" class="mw-content-ltr">Advanced Wide-Area-Network cache configuration.</span>
}}
== Details ==
<span lang="en" dir="ltr" class="mw-content-ltr">Each WAN cache wraps a registered object cache (for the local cluster) and it must also be configured to point to a PubSub instance via a EventRelayer subclass.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Subscribers to that instance must be configured to relay purges to the actual cache servers.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">For typical setups where there is only one cache server, a no-op PubSub instance can be used (EventRelayerNull).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This can also be done if there is only one datacenter, assuming either (a) cache network problems are rare enough, or (b) client side cache server fail-over is disabled, or (c) the caching store automatically shards, replicates, and moves data around as nodes fail.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
The format is an associative array where the key is a cache identifier, and the value is an associative array of parameters.
</div>

* <code>cacheId</code> - <span lang="en" dir="ltr" class="mw-content-ltr">a cache identifier from <code>$wgObjectCaches</code>.</span>
* <code>relayerConfig</code> - <span lang="en" dir="ltr" class="mw-content-ltr">an array used to construct an EventRelayer object.</span>
* <code>pool</code> - <span lang="en" dir="ltr" class="mw-content-ltr">a string that is used as a PubSub channel prefix.</span>
* <code>loggroup</code> - <span lang="en" dir="ltr" class="mw-content-ltr">controls where log events are sent.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Default value ==
</div>
{{MW 1.35|+}}{{-}}
<syntaxhighlight lang="php">
$wgWANObjectCaches = [
	CACHE_NONE => [
		'class' => WANObjectCache::class,
		'cacheId' => CACHE_NONE,
	]
];
</syntaxhighlight>

{{MW version|version=1.33|version2=1.34}}{{-}}
<syntaxhighlight lang="php">
$wgWANObjectCaches = [
	CACHE_NONE => [
		'class'    => WANObjectCache::class,
		'cacheId'  => CACHE_NONE
	]
	/* Example of a simple single data-center cache:
	'memcached-php' => [
		'class'    => WANObjectCache::class,
		'cacheId'  => 'memcached-php'
	]
	*/
];
</syntaxhighlight>

{{MW version|version=1.31|version2=1.32}}{{-}}
<syntaxhighlight lang="php">
$wgWANObjectCaches = [
	CACHE_NONE => [
		'class'    => WANObjectCache::class,
		'cacheId'  => CACHE_NONE,
		'channels' => []
	]
	/* Example of a simple single data-center cache:
	'memcached-php' => [
		'class'    => WANObjectCache::class,
		'cacheId'  => 'memcached-php',
		'channels' => [ 'purge' => 'wancache-main-memcached-purge' ]
	]
	*/
];
</syntaxhighlight>

{{MW version|version=1.27|version2=1.30}}{{-}}
<syntaxhighlight lang="php">
$wgWANObjectCaches = [
	CACHE_NONE => [
		'class'    => 'WANObjectCache',
		'cacheId'  => CACHE_NONE,
		'channels' => []
	]
	/* Example of a simple single data-center cache:
	'memcached-php' => [
		'class'    => 'WANObjectCache',
		'cacheId'  => 'memcached-php',
		'channels' => [ 'purge' => 'wancache-main-memcached-purge' ]
	]
	*/
];
</syntaxhighlight>

{{MW 1.26}}{{-}}
<syntaxhighlight lang="php">
$wgWANObjectCaches = array(
	CACHE_NONE => array(
		'class'         => 'WANObjectCache',
		'cacheId'       => CACHE_NONE,
		'pool'          => 'mediawiki-main-none',
		'relayerConfig' => array( 'class' => 'EventRelayerNull' )
	)
	/* Example of a simple single data-center cache:
	'memcached-php' => array(
		'class'         => 'WANObjectCache',
		'cacheId'       => 'memcached-php',
		'pool'          => 'mediawiki-main-memcached',
		'relayerConfig' => array( 'class' => 'EventRelayerNull' )
	)
	*/
);
</syntaxhighlight>