MediaWiki
master
|
Class representing a cache/ephemeral data store. More...
Public Member Functions | |
__construct (array $params=[]) | |
Parameters include: More... | |
add ( $key, $value, $exptime=0, $flags=0) | |
Insert an item if it does not already exist. More... | |
addBusyCallback (callable $workCallback) | |
Let a callback be run to avoid wasting time on special blocking calls. More... | |
changeTTL ( $key, $exptime=0, $flags=0) | |
Change the expiration on a key if it exists. More... | |
changeTTLMulti (array $keys, $exptime, $flags=0) | |
Change the expiration of multiple keys that exist. More... | |
clearLastError () | |
Clear the "last error" registry. More... | |
decr ( $key, $value=1, $flags=0) | |
Decrease stored value of $key by $value while preserving its TTL. More... | |
delete ( $key, $flags=0) | |
Delete an item. More... | |
deleteMulti (array $keys, $flags=0) | |
Batch deletion. More... | |
deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF) | |
Delete all objects expiring before a certain date. More... | |
get ( $key, $flags=0) | |
Get an item with the given key. More... | |
getCurrentTime () | |
getLastError () | |
Get the "last error" registered; clearLastError() should be called manually. More... | |
getLogger () | |
getMulti (array $keys, $flags=0) | |
Get an associative array containing the item for each of the keys that have items. More... | |
getQoS ( $flag) | |
getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='') | |
Get a lightweight exclusive self-unlocking lock. More... | |
getSegmentationSize () | |
getSegmentedValueMaxSize () | |
getWithSetCallback ( $key, $exptime, $callback, $flags=0) | |
Get an item with the given key, regenerating and setting it if not found. More... | |
incr ( $key, $value=1, $flags=0) | |
Increase stored value of $key by $value while preserving its TTL. More... | |
incrWithInit ( $key, $exptime, $value=1, $init=null, $flags=0) | |
Increase the value of the given key (no TTL change) if it exists or create it otherwise. More... | |
isKeyGlobal ( $key) | |
Check whether a cache key is in the global keyspace. More... | |
lock ( $key, $timeout=6, $expiry=6, $rclass='') | |
Acquire an advisory lock on a key string. More... | |
makeGlobalKey ( $collection,... $components) | |
Make a cache key for the default keyspace and given components. More... | |
makeKey ( $collection,... $components) | |
Make a cache key for the global keyspace and given components. More... | |
makeKeyInternal ( $keyspace, $components) | |
Make a cache key for the given keyspace and components. More... | |
merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0) | |
Merge changes into the existing cache value (possibly creating a new one) More... | |
registerWrapperInfoForStats (string $prefixComponent, string $statsGroup, callable $collectionCallback) | |
Register info about a caching layer class that uses BagOStuff as a backing store. More... | |
set ( $key, $value, $exptime=0, $flags=0) | |
Set an item. More... | |
setDebug ( $enabled) | |
setLogger (LoggerInterface $logger) | |
setMockTime (&$time) | |
setMulti (array $valueByKey, $exptime=0, $flags=0) | |
Batch insertion/replace. More... | |
setNewPreparedValues (array $valueByKey) | |
Make a "generic" reversible cache key from the given components. More... | |
unlock ( $key) | |
Release an advisory lock on a key string. More... | |
Public Attributes | |
const | READ_LATEST = 1 |
Bitfield constants for get()/getMulti(); these are only advisory. More... | |
const | READ_VERIFIED = 2 |
const | WRITE_ALLOW_SEGMENTS = 16 |
const | WRITE_BACKGROUND = 64 |
const | WRITE_CACHE_ONLY = 8 |
const | WRITE_PRUNE_SEGMENTS = 32 |
const | WRITE_SYNC = 4 |
Bitfield constants for set()/merge(); these are only advisory. More... | |
Protected Member Functions | |
componentsFromGenericKey ( $key) | |
Extract the components from a "generic" reversible cache key. More... | |
convertGenericKey ( $key) | |
Convert a "generic" reversible cache key into one for this cache. More... | |
determineKeyPrefixForStats ( $key) | |
fieldHasFlags ( $field, $flags) | |
genericKeyFromComponents (... $components) | |
At a minimum, there must be a keyspace and collection name component. More... | |
mergeFlagMaps (array $bags) | |
Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More... | |
proxyCall ( $method, $arg0Sig, $resSig, array $genericArgs) | |
Call a method on behalf of wrapper BagOStuff instance that uses "generic" keys. More... | |
Protected Attributes | |
callable null | $asyncHandler |
int[] | $attrMap = [] |
Map of (ATTR_* class constant => QOS_* class constant) More... | |
bool | $debugMode = true |
Whether to send debug log entries to the SPI logger instance. More... | |
string | $keyspace |
Default keyspace; used by makeKey() More... | |
LoggerInterface | $logger |
StatsdDataFactoryInterface | $stats |
array< string, array > | $wrapperInfoByPrefix = [] |
Cache key processing callbacks and info for metrics -var array<string,array{0:string,1:callable}> More... | |
Private Attributes | |
float null | $wallClockOverride |
const | WRAPPER_COLLECTION_CALLBACK = 1 |
Key to the callback that extracts collection names from cache wrapper keys. More... | |
const | WRAPPER_STATS_GROUP = 0 |
Key to the metric group to use for the relevant cache wrapper. More... | |
Class representing a cache/ephemeral data store.
This interface is intended to be more or less compatible with the PHP memcached client.
Instances of this class should be created with an intended access scope, such as:
Callers should use the proper factory methods that yield BagOStuff instances. Site admins should make sure the configuration for those factory methods matches their access scope. BagOStuff subclasses have widely varying levels of support for replication features.
For any given instance, methods like lock(), unlock(), merge(), and set() with WRITE_SYNC should semantically operate over its entire access scope; any nodes/threads in that scope should serialize appropriately when using them. Likewise, a call to get() with READ_LATEST from one node in its access scope should reflect the prior changes of any other node its access scope. Any get() should reflect the changes of any prior set() with WRITE_SYNC.
Subclasses should override the default "segmentationSize" field with an appropriate value. The value should not be larger than what the storage backend (by default) supports. It also should be roughly informed by common performance bottlenecks (e.g. values over a certain size having poor scalability). The same goes for the "segmentedValueMaxSize" member, which limits the maximum size and chunk count (indirectly) of values.
Stable to extend
Definition at line 67 of file BagOStuff.php.
BagOStuff::__construct | ( | array | $params = [] | ) |
Parameters include:
array | $params | -param array{keyspace?:string,logger?:Psr\Log\LoggerInterface,asyncHandler?:callable} $params |
Reimplemented in WinCacheBagOStuff, MediumSpecificBagOStuff, EmptyBagOStuff, APCUBagOStuff, and MemcachedBagOStuff.
Definition at line 148 of file BagOStuff.php.
References setLogger().
|
abstract |
Insert an item if it does not already exist.
string | $key | |
mixed | $value | |
int | $exptime | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
|
abstract |
Let a callback be run to avoid wasting time on special blocking calls.
The callbacks may or may not be called ever, in any particular order. They are likely to be invoked when something WRITE_SYNC is used used. They should follow a caching pattern as shown below, so that any code using the work will get it's result no matter what happens.
callable | $workCallback |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
Referenced by Wikimedia\Rdbms\ChronologyProtector\shutdown().
|
abstract |
Change the expiration on a key if it exists.
If an expiry in the past is given then the key will immediately be expired
For large values written using WRITE_ALLOW_SEGMENTS, this only changes the TTL of the main segment list key. While lowering the TTL of the segment list key has the effect of functionally lowering the TTL of the key, it might leave unused blobs in cache for longer. Raising the TTL of such keys is not effective, since the expiration of a single segment key effectively expires the entire value.
string | $key | |
int | $exptime | TTL or UNIX timestamp |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
|
abstract |
Change the expiration of multiple keys that exist.
string[] | $keys | List of keys |
int | $exptime | TTL or UNIX timestamp |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
|
abstract |
Clear the "last error" registry.
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
|
finalprotected |
Extract the components from a "generic" reversible cache key.
string | $key | Keyspace-prepended list of encoded components as a colon-separated value |
Definition at line 697 of file BagOStuff.php.
|
abstractprotected |
Convert a "generic" reversible cache key into one for this cache.
string | $key | Keyspace-prepended list of encoded components as a colon-separated value |
Reimplemented in RESTBagOStuff, ReplicatedBagOStuff, RedisBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, HashBagOStuff, EmptyBagOStuff, CachedBagOStuff, and APCUBagOStuff.
Referenced by proxyCall().
|
abstract |
Decrease stored value of $key by $value while preserving its TTL.
string | $key | |
int | $value | Value to subtract from $key (default: 1) [optional] |
int | $flags | Bit field of class WRITE_* constants [optional] |
Reimplemented in SqlBagOStuff, WinCacheBagOStuff, RESTBagOStuff, ReplicatedBagOStuff, RedisBagOStuff, MultiWriteBagOStuff, MemcachedPhpBagOStuff, MemcachedPeclBagOStuff, HashBagOStuff, EmptyBagOStuff, CachedBagOStuff, and APCUBagOStuff.
|
abstract |
Delete an item.
For large values written using WRITE_ALLOW_SEGMENTS, this only deletes the main segment list key unless WRITE_PRUNE_SEGMENTS is in the flags. While deleting the segment list key has the effect of functionally deleting the key, it leaves unused blobs in cache.
string | $key |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
|
abstract |
Batch deletion.
This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O
WRITE_BACKGROUND can be used for bulk deletion where the response is not vital
string[] | $keys | List of keys |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
|
abstract |
Delete all objects expiring before a certain date.
string | int | $timestamp | The reference date in MW or TS_UNIX format |
callable | null | $progress | Optional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter. [optional] |
int | $limit | Maximum number of keys to delete [default: INF] |
Reimplemented in SqlBagOStuff, ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
|
protected |
string | $key | Key generated by an IStoreKeyEncoder instance |
Definition at line 764 of file BagOStuff.php.
References WRAPPER_COLLECTION_CALLBACK, and WRAPPER_STATS_GROUP.
|
finalprotected |
int | $field | |
int | $flags |
Definition at line 579 of file BagOStuff.php.
Referenced by CachedBagOStuff\changeTTLMulti(), CachedBagOStuff\delete(), MediumSpecificBagOStuff\delete(), CachedBagOStuff\deleteMulti(), SqlBagOStuff\doCas(), MemcachedPeclBagOStuff\doDeleteMulti(), MemcachedPeclBagOStuff\doSetMulti(), MultiWriteBagOStuff\get(), ReplicatedBagOStuff\get(), ReplicatedBagOStuff\getMulti(), SqlBagOStuff\modifyMulti(), CachedBagOStuff\set(), CachedBagOStuff\setMulti(), and MultiWriteBagOStuff\useAsyncSecondaryWrites().
|
finalprotected |
At a minimum, there must be a keyspace and collection name component.
string|int | ...$components Key components for keyspace, collection name, and IDs |
Definition at line 671 of file BagOStuff.php.
Referenced by CachedBagOStuff\makeGlobalKey(), MultiWriteBagOStuff\makeGlobalKey(), ReplicatedBagOStuff\makeGlobalKey(), CachedBagOStuff\makeKey(), MultiWriteBagOStuff\makeKey(), ReplicatedBagOStuff\makeKey(), APCUBagOStuff\makeKeyInternal(), CachedBagOStuff\makeKeyInternal(), EmptyBagOStuff\makeKeyInternal(), HashBagOStuff\makeKeyInternal(), MultiWriteBagOStuff\makeKeyInternal(), RedisBagOStuff\makeKeyInternal(), ReplicatedBagOStuff\makeKeyInternal(), and RESTBagOStuff\makeKeyInternal().
|
abstract |
Get an item with the given key.
If the key includes a deterministic input hash (e.g. the key can only have the correct value) or complete staleness checks are handled by the caller (e.g. nothing relies on the TTL), then the READ_VERIFIED flag should be set. This lets tiered backends know they can safely upgrade a cached value to higher tiers using standard TTLs.
string | $key | |
int | $flags | Bitfield of BagOStuff::READ_* constants [optional] |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
Referenced by McTest\execute(), CachedBagOStuff\get(), and Wikimedia\Rdbms\ChronologyProtector\shutdown().
BagOStuff::getCurrentTime | ( | ) |
Definition at line 790 of file BagOStuff.php.
Referenced by HashBagOStuff\expire(), SqlBagOStuff\expireAll(), MemcachedBagOStuff\fixExpiry(), SqlBagOStuff\getConnection(), SqlBagOStuff\getMaxDateTime(), getScopedLock(), ReplicatedBagOStuff\hadRecentSessionWrite(), SqlBagOStuff\isExpired(), SqlBagOStuff\markServerDown(), SqlBagOStuff\occasionallyGarbageCollect(), and ReplicatedBagOStuff\remarkRecentSessionWrite().
|
abstract |
Get the "last error" registered; clearLastError() should be called manually.
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
BagOStuff::getLogger | ( | ) |
|
abstract |
Get an associative array containing the item for each of the keys that have items.
string[] | $keys | List of keys |
int | $flags | Bitfield; supports READ_LATEST [optional] |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
BagOStuff::getQoS | ( | $flag | ) |
int | $flag | ATTR_* class constant |
Reimplemented in MediumSpecificBagOStuff.
Definition at line 553 of file BagOStuff.php.
Referenced by Wikimedia\Rdbms\ChronologyProtector\shutdown().
|
final |
Get a lightweight exclusive self-unlocking lock.
Note that the same lock cannot be acquired twice.
This is useful for task de-duplication or to avoid obtrusive (though non-corrupting) DB errors like INSERT key conflicts or deadlocks when using LOCK IN SHARE MODE.
string | $key | |
int | $timeout | Lock wait timeout; 0 for non-blocking [optional] |
int | $expiry | Lock expiry [optional]; 1 day maximum |
string | $rclass | Allow reentry if set and the current lock used this value |
Definition at line 336 of file BagOStuff.php.
References getCurrentTime(), lock(), and unlock().
BagOStuff::getSegmentationSize | ( | ) |
Reimplemented in MediumSpecificBagOStuff.
Definition at line 561 of file BagOStuff.php.
BagOStuff::getSegmentedValueMaxSize | ( | ) |
Reimplemented in MediumSpecificBagOStuff.
Definition at line 569 of file BagOStuff.php.
|
final |
Get an item with the given key, regenerating and setting it if not found.
The callback can take $exptime as argument by reference and modify it. Nothing is stored nor deleted if the callback returns false.
string | $key | |
int | $exptime | Time-to-live (seconds) |
callable | $callback | Callback that derives the new value |
int | $flags | Bitfield of BagOStuff::READ_* or BagOStuff::WRITE_* constants [optional] |
Definition at line 192 of file BagOStuff.php.
|
abstract |
Increase stored value of $key by $value while preserving its TTL.
string | $key | Key to increase |
int | $value | Value to add to $key (default: 1) [optional] |
int | $flags | Bit field of class WRITE_* constants [optional] |
Reimplemented in WinCacheBagOStuff, RESTBagOStuff, ReplicatedBagOStuff, RedisBagOStuff, MultiWriteBagOStuff, MemcachedPhpBagOStuff, MemcachedPeclBagOStuff, HashBagOStuff, EmptyBagOStuff, CachedBagOStuff, APCUBagOStuff, and SqlBagOStuff.
|
abstract |
Increase the value of the given key (no TTL change) if it exists or create it otherwise.
This will create the key with the value $init and TTL $exptime instead if not present. Callers should make sure that both ($init - $value) and $exptime are invariants for all operations to any given key. The value of $init should be at least that of $value.
string | $key | Key built via makeKey() or makeGlobalKey() |
int | $exptime | Time-to-live (in seconds) or a UNIX timestamp expiration |
int | $value | Amount to increase the key value by [default: 1] |
int | null | $init | Value to initialize the key to if it does not exist [default: $value] |
int | $flags | Bit field of class WRITE_* constants [optional] |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, EmptyBagOStuff, CachedBagOStuff, and APCUBagOStuff.
BagOStuff::isKeyGlobal | ( | $key | ) |
Check whether a cache key is in the global keyspace.
string | $key |
Definition at line 544 of file BagOStuff.php.
|
abstract |
Acquire an advisory lock on a key string.
Note that if reentry is enabled, duplicate calls ignore $expiry
string | $key | |
int | $timeout | Lock wait timeout; 0 for non-blocking [optional] |
int | $expiry | Lock expiry [optional]; 1 day maximum |
string | $rclass | Allow reentry if set and the current lock used this value |
Reimplemented in SqlBagOStuff, ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
Referenced by getScopedLock(), and Wikimedia\Rdbms\ChronologyProtector\shutdown().
|
abstract |
Make a cache key for the default keyspace and given components.
string | $collection | Key collection name component |
string|int | ...$components Additional, ordered, key components for entity IDs |
Implements IStoreKeyEncoder.
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
Referenced by Wikimedia\Rdbms\ChronologyProtector\__construct(), Wikimedia\Rdbms\ChronologyProtector\getTouchedKey(), and ExtensionRegistry\makeCacheKey().
|
abstract |
Make a cache key for the global keyspace and given components.
string | $collection | Key collection name component |
string|int | ...$components Additional, ordered, key components for entity IDs |
Implements IStoreKeyEncoder.
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
Referenced by CryptHKDF\__construct(), and UploadBase\getUploadSessionKey().
|
abstract |
Make a cache key for the given keyspace and components.
Long components might be converted to respective hashes due to size constraints. In extreme cases, all of them might be combined into a single hash component.
Reimplemented in SqlBagOStuff, WinCacheBagOStuff, RESTBagOStuff, ReplicatedBagOStuff, RedisBagOStuff, MultiWriteBagOStuff, MemcachedBagOStuff, HashBagOStuff, EmptyBagOStuff, CachedBagOStuff, and APCUBagOStuff.
|
abstract |
Merge changes into the existing cache value (possibly creating a new one)
The callback function returns the new value given the current value (which will be false if not present), and takes the arguments: (this BagOStuff, cache key, current value, TTL). The TTL parameter is reference set to $exptime. It can be overriden in the callback. Nothing is stored nor deleted if the callback returns false.
string | $key | |
callable | $callback | Callback method to be executed |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $attempts | The amount of times to attempt a merge in case of failure |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
InvalidArgumentException |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, EmptyBagOStuff, and CachedBagOStuff.
|
finalprotected |
Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.
BagOStuff[] | $bags |
Definition at line 589 of file BagOStuff.php.
Referenced by MultiWriteBagOStuff\__construct(), and ReplicatedBagOStuff\__construct().
|
protected |
Call a method on behalf of wrapper BagOStuff instance that uses "generic" keys.
string | $method | Name of a non-final public method that reads/changes keys |
int | $arg0Sig | BagOStuff::ARG0_* constant describing argument 0 |
int | $resSig | BagOStuff::RES_* constant describing the return value |
array | $genericArgs | Method arguments passed to the wrapper instance |
Definition at line 721 of file BagOStuff.php.
References convertGenericKey().
BagOStuff::registerWrapperInfoForStats | ( | string | $prefixComponent, |
string | $statsGroup, | ||
callable | $collectionCallback | ||
) |
Register info about a caching layer class that uses BagOStuff as a backing store.
Object cache wrappers are classes that implement generic caching/storage functionality, use a BagOStuff instance as the backing store, and implement IStoreKeyEncoder with the same "generic" style key encoding as BagOStuff. Such wrappers transform keys before passing them to BagOStuff methods; a wrapper-specific prefix component will be prepended along with other possible additions. Transformed keys still use the "generic" BagOStuff encoding.
The provided callback takes a transformed key, having the specified prefix component, and extracts the key collection name. For sanity, the callback must be able to handle keys that bear the prefix (by coincidence) but do not originate from the wrapper class.
Calls to this method should be idempotent.
string | $prefixComponent | Key prefix component used by the wrapper |
string | $statsGroup | Stats group to use for metrics from this wrapper |
callable | $collectionCallback | Static callback that gets the key collection name |
Definition at line 653 of file BagOStuff.php.
|
abstract |
Set an item.
string | $key | |
mixed | $value | |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
Referenced by Wikimedia\Rdbms\ChronologyProtector\shutdown().
BagOStuff::setDebug | ( | $enabled | ) |
bool | $enabled |
Definition at line 175 of file BagOStuff.php.
References wfDeprecated().
BagOStuff::setLogger | ( | LoggerInterface | $logger | ) |
LoggerInterface | $logger |
Reimplemented in RESTBagOStuff.
Definition at line 159 of file BagOStuff.php.
References $logger.
Referenced by __construct().
BagOStuff::setMockTime | ( | & | $time | ) |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, and CachedBagOStuff.
Definition at line 799 of file BagOStuff.php.
|
abstract |
Batch insertion/replace.
This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O
WRITE_BACKGROUND can be used for bulk insertion where the response is not vital
mixed[] | $valueByKey | Map of (key => value) |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
|
abstract |
Make a "generic" reversible cache key from the given components.
All previously prepared values will be cleared. Each of the new prepared values will be individually cleared as they get used by write operations for that key. This is done to avoid unchecked growth in PHP memory usage.
Example usage:
This is only useful if the caller needs an estimate of the serialized object sizes. The caller cannot know the serialization format and even if it did, it could be expensive to serialize complex values twice just to get the size information before writing them to cache. This method solves both problems by making the cache instance do the serialization and having it reuse the result when the cache write happens.
array | $valueByKey | Map of (cache key => PHP variable value to serialize) |
Reimplemented in ReplicatedBagOStuff, MultiWriteBagOStuff, MemcachedPeclBagOStuff, MediumSpecificBagOStuff, HashBagOStuff, and CachedBagOStuff.
|
abstract |
Release an advisory lock on a key string.
string | $key |
Reimplemented in SqlBagOStuff, ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, and CachedBagOStuff.
Referenced by getScopedLock(), and Wikimedia\Rdbms\ChronologyProtector\shutdown().
|
protected |
Definition at line 78 of file BagOStuff.php.
Referenced by MultiWriteBagOStuff\callKeyWriteMethodOnTierCaches(), and SqlBagOStuff\occasionallyGarbageCollect().
|
protected |
Map of (ATTR_* class constant => QOS_* class constant)
Definition at line 86 of file BagOStuff.php.
|
protected |
Whether to send debug log entries to the SPI logger instance.
Definition at line 95 of file BagOStuff.php.
|
protected |
Default keyspace; used by makeKey()
Definition at line 89 of file BagOStuff.php.
Referenced by APCUBagOStuff\makeKeyInternal(), CachedBagOStuff\makeKeyInternal(), EmptyBagOStuff\makeKeyInternal(), HashBagOStuff\makeKeyInternal(), MemcachedBagOStuff\makeKeyInternal(), MultiWriteBagOStuff\makeKeyInternal(), RedisBagOStuff\makeKeyInternal(), ReplicatedBagOStuff\makeKeyInternal(), RESTBagOStuff\makeKeyInternal(), WinCacheBagOStuff\makeKeyInternal(), and SqlBagOStuff\makeKeyInternal().
|
protected |
Definition at line 76 of file BagOStuff.php.
Referenced by getLogger(), setLogger(), and RESTBagOStuff\setLogger().
|
protected |
Definition at line 74 of file BagOStuff.php.
|
private |
Definition at line 98 of file BagOStuff.php.
|
protected |
Cache key processing callbacks and info for metrics -var array<string,array{0:string,1:callable}>
Definition at line 83 of file BagOStuff.php.
const BagOStuff::READ_LATEST = 1 |
Bitfield constants for get()/getMulti(); these are only advisory.
Definition at line 101 of file BagOStuff.php.
Referenced by RESTBagOStuff\incr().
const BagOStuff::READ_VERIFIED = 2 |
Definition at line 102 of file BagOStuff.php.
Referenced by ParserCache\get(), and ParserCache\getMetadata().
|
private |
Key to the callback that extracts collection names from cache wrapper keys.
Definition at line 134 of file BagOStuff.php.
Referenced by determineKeyPrefixForStats().
|
private |
Key to the metric group to use for the relevant cache wrapper.
Definition at line 132 of file BagOStuff.php.
Referenced by determineKeyPrefixForStats().
const BagOStuff::WRITE_ALLOW_SEGMENTS = 16 |
Definition at line 106 of file BagOStuff.php.
Referenced by ParserCache\save(), MediaWiki\Storage\PageEditStash\stashInputText(), and MediaWiki\Storage\PageEditStash\storeStashValue().
const BagOStuff::WRITE_BACKGROUND = 64 |
Definition at line 108 of file BagOStuff.php.
Referenced by Wikimedia\DependencyStore\KeyValueDependencyStore\remove(), Wikimedia\DependencyStore\KeyValueDependencyStore\renew(), and Wikimedia\DependencyStore\KeyValueDependencyStore\storeMulti().
const BagOStuff::WRITE_CACHE_ONLY = 8 |
Definition at line 105 of file BagOStuff.php.
Referenced by CachedBagOStuff\get(), and MediaWiki\Session\SessionBackend\save().
const BagOStuff::WRITE_PRUNE_SEGMENTS = 32 |
Definition at line 107 of file BagOStuff.php.
Referenced by MediaWiki\Storage\PageEditStash\pruneExcessStashedEntries().
const BagOStuff::WRITE_SYNC = 4 |
Bitfield constants for set()/merge(); these are only advisory.
Definition at line 104 of file BagOStuff.php.
Referenced by MediaWiki\Session\SessionBackend\save().