MediaWiki master
|
Store data in Redis. More...
Inherits Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Public Member Functions | |
__construct ( $params) | |
Construct a RedisBagOStuff object. | |
doChangeTTLMulti (array $keys, $exptime, $flags=0) | |
logRequest ( $op, $keys, $server, $e=null) | |
Send information about a single request to the debug log. | |
Public Member Functions inherited from Wikimedia\ObjectCache\MediumSpecificBagOStuff | |
__construct (array $params=[]) | |
add ( $key, $value, $exptime=0, $flags=0) | |
Insert an item if it does not already exist. | |
changeTTL ( $key, $exptime=0, $flags=0) | |
Change the expiration on a key if it exists. | |
changeTTLMulti (array $keys, $exptime, $flags=0) | |
Change the expiration of multiple keys that exist. | |
delete ( $key, $flags=0) | |
Delete an item if it exists. | |
deleteMulti (array $keys, $flags=0) | |
Delete a batch of items. | |
deleteObjectsExpiringBefore ( $timestamp, ?callable $progress=null, $limit=INF, ?string $tag=null) | |
Delete all objects expiring before a certain date. | |
get ( $key, $flags=0) | |
Get an item with the given key. | |
getMulti (array $keys, $flags=0) | |
Get an associative array containing the item for each of the keys that have items. | |
getQoS ( $flag) | |
getSegmentationSize () | |
getSegmentedValueMaxSize () | |
incrWithInit ( $key, $exptime, $step=1, $init=null, $flags=0) | |
Increase the value of the given key (no TTL change) if it exists or create it otherwise. | |
lock ( $key, $timeout=6, $exptime=6, $rclass='') | |
merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0) | |
Merge changes into the existing cache value (possibly creating a new one) | |
set ( $key, $value, $exptime=0, $flags=0) | |
Set an item. | |
setMulti (array $valueByKey, $exptime=0, $flags=0) | |
Batch insertion/replace. | |
unlock ( $key) | |
Release an advisory lock on a key string. | |
Public Member Functions inherited from Wikimedia\ObjectCache\BagOStuff | |
clearLastError () | |
Clear the "last error" registry. | |
getCurrentTime () | |
getLastError ( $watchPoint=0) | |
Get the "last error" registry. | |
getLogger () | |
getScopedLock ( $key, $timeout=6, $exptime=30, $rclass='') | |
Get a lightweight exclusive self-unlocking lock. | |
getWithSetCallback ( $key, $exptime, $callback, $flags=0) | |
Get an item, regenerating and setting it if not found. | |
isKeyGlobal ( $key) | |
Check whether a cache key is in the global keyspace. | |
makeGlobalKey ( $keygroup,... $components) | |
Make a cache key from the given components, in the "global" keyspace. | |
makeKey ( $keygroup,... $components) | |
Make a cache key from the given components, in the default keyspace. | |
setLogger (LoggerInterface $logger) | |
setMockTime (&$time) | |
watchErrors () | |
Get a "watch point" token that can be used to get the "last error" to occur after now. | |
Protected Member Functions | |
doAdd ( $key, $value, $exptime=0, $flags=0) | |
Insert an item if it does not already exist. | |
doChangeTTL ( $key, $exptime, $flags) | |
doDelete ( $key, $flags=0) | |
Delete an item. | |
doDeleteMulti (array $keys, $flags=0) | |
doGet ( $key, $flags=0, &$casToken=null) | |
Get an item. | |
doGetMulti (array $keys, $flags=0) | |
Get an associative array containing the item for each of the keys that have items. | |
doIncrWithInit ( $key, $exptime, $step, $init, $flags) | |
doSet ( $key, $value, $exptime=0, $flags=0) | |
Set an item. | |
doSetMulti (array $data, $exptime=0, $flags=0) | |
getConnection ( $key) | |
getConnectionsForKeys (array $keys) | |
handleException (RedisConnRef $conn, RedisException $e) | |
The redis extension throws an exception in response to various read, write and protocol errors. | |
logError ( $msg) | |
Log a fatal error. | |
Protected Member Functions inherited from Wikimedia\ObjectCache\MediumSpecificBagOStuff | |
cas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
Set an item if the current CAS token matches the provided CAS token. | |
debug ( $text) | |
doCas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
Set an item if the current CAS token matches the provided CAS token. | |
doLock ( $key, $timeout, $exptime) | |
doUnlock ( $key) | |
getExpirationAsTimestamp ( $exptime) | |
Convert an optionally relative timestamp to an absolute time. | |
getExpirationAsTTL ( $exptime) | |
Convert an optionally absolute expiry time to a relative time. | |
getSerialized ( $value, $key) | |
Get the serialized form a value, logging a warning if it involves custom classes. | |
isInteger ( $value) | |
Check if a value is an integer. | |
isRelativeExpiration ( $exptime) | |
makeLockKey ( $key) | |
makeValueOrSegmentList ( $key, $value, $exptime, $flags, &$ok) | |
Make the entry to store at a key (inline or segment list), storing any segments. | |
mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags) | |
resolveSegments ( $key, $mainValue) | |
Get and reassemble the chunks of blob at the given key. | |
serialize ( $value) | |
tokensMatch ( $value, $otherValue) | |
unserialize ( $value) | |
updateOpStats (string $op, array $keyInfo) | |
Protected Member Functions inherited from Wikimedia\ObjectCache\BagOStuff | |
fieldHasFlags ( $field, $flags) | |
makeKeyInternal ( $keyspace, $components) | |
Make a cache key for the given keyspace and components. | |
mergeFlagMaps (array $bags) | |
Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. | |
proxyCall (string $method, int $arg0Sig, int $resSig, array $genericArgs, BagOStuff $wrapper) | |
Call a method on behalf of wrapper BagOStuff instance. | |
requireConvertGenericKey () | |
Whether ::proxyCall() must re-encode cache keys before calling read/write methods. | |
setLastError ( $error) | |
Set the "last error" registry due to a problem encountered during an attempted operation. | |
Protected Attributes | |
bool | $automaticFailover |
RedisConnectionPool | $redisPool |
array | $servers |
List of server names. | |
array | $serverTagMap |
Map of (tag => server name) | |
Protected Attributes inherited from Wikimedia\ObjectCache\MediumSpecificBagOStuff | |
array< string, array > | $locks = [] |
Map of (key => (class LOCK_* constant => value) | |
float | $maxLockSendDelay = 0.05 |
Seconds; maximum expected seconds for a lock ping to reach the backend. | |
int | $segmentationSize |
Bytes; chunk size of segmented cache values. | |
int | $segmentedValueMaxSize |
Bytes; maximum total size of a segmented cache value. | |
const | LOCK_DEPTH = 1 |
const | LOCK_EXPIRY = 3 |
const | LOCK_RCLASS = 0 |
const | LOCK_TIME = 2 |
const | METRIC_OP_ADD = 'add' |
const | METRIC_OP_CAS = 'cas' |
const | METRIC_OP_CHANGE_TTL = 'change_ttl' |
const | METRIC_OP_DECR = 'decr' |
const | METRIC_OP_DELETE = 'delete' |
const | METRIC_OP_GET = 'get' |
const | METRIC_OP_INCR = 'incr' |
const | METRIC_OP_SET = 'set' |
const | PASS_BY_REF = -1 |
Idiom for doGet() to return extra information by reference. | |
Protected Attributes inherited from Wikimedia\ObjectCache\BagOStuff | |
callable null | $asyncHandler |
int[] | $attrMap = [] |
Map of (BagOStuff:ATTR_* constant => BagOStuff:QOS_* constant) | |
string | $keyspace |
Default keyspace; used by makeKey() | |
int | $lastError = self::ERR_NONE |
BagOStuff:ERR_* constant of the last error that occurred. | |
int | $lastErrorId = 0 |
Error event sequence number of the last error that occurred. | |
LoggerInterface | $logger |
StatsFactory | $stats |
Additional Inherited Members | |
Public Attributes inherited from Wikimedia\ObjectCache\BagOStuff | |
const | MAX_CONFLICTS_ONE = 1 |
Abort after the first merge conflict. | |
const | READ_LATEST = 1 |
Bitfield constants for get()/getMulti(); these are only advisory. | |
const | READ_VERIFIED = 2 |
Promise that the caller handles detection of staleness. | |
const | WRITE_ALLOW_SEGMENTS = 16 |
Allow partitioning of the value if it is a large string. | |
const | WRITE_BACKGROUND = 64 |
If supported, do not block on write operation completion; instead, treat writes as succesful based on whether they could be buffered. | |
const | WRITE_CACHE_ONLY = 8 |
Bitfield constants for set()/merge(); these are only advisory. | |
const | WRITE_PRUNE_SEGMENTS = self::WRITE_ALLOW_SEGMENTS |
Delete all the segments if the value is partitioned. | |
Public Attributes inherited from Wikimedia\LightweightObjectStore\StorageAwareness | |
const | ATTR_DURABILITY = 2 |
Durability of writes; see QOS_DURABILITY_* (higher means stronger) | |
const | ATTR_EMULATION = 1 |
const | ERR_NO_RESPONSE = 1 |
Storage medium failed to yield a complete response to an operation. | |
const | ERR_NONE = 0 |
No storage medium error. | |
const | ERR_UNEXPECTED = 3 |
Storage medium operation failed due to usage limitations or an I/O error. | |
const | ERR_UNREACHABLE = 2 |
Storage medium could not be reached to establish a connection. | |
const | QOS_DURABILITY_DISK = 4 |
Data is saved to disk and writes do not usually block on fsync() | |
const | QOS_DURABILITY_NONE = 1 |
Data is never saved to begin with (blackhole store) | |
const | QOS_DURABILITY_RDBMS = 5 |
Data is saved to disk and writes usually block on fsync(), like a standard RDBMS. | |
const | QOS_DURABILITY_SCRIPT = 2 |
Data is lost at the end of the current web request or CLI script. | |
const | QOS_DURABILITY_SERVICE = 3 |
Data is lost once the service storing the data restarts. | |
const | QOS_UNKNOWN = INF |
Generic "unknown" value; useful for comparisons (always "good enough") | |
Static Protected Attributes inherited from Wikimedia\ObjectCache\BagOStuff | |
static int | $nextErrorMonitorId = 1 |
Next sequence number to use for watch/error events. | |
Store data in Redis.
This requires the php-redis PECL extension (2.2.4 or later) and a Redis server (2.6.12 or later).
Definition at line 42 of file RedisBagOStuff.php.
Wikimedia\ObjectCache\RedisBagOStuff::__construct | ( | $params | ) |
Construct a RedisBagOStuff object.
Parameters are:
array | $params |
Definition at line 81 of file RedisBagOStuff.php.
References $params, Wikimedia\LightweightObjectStore\StorageAwareness\ATTR_DURABILITY, Wikimedia\LightweightObjectStore\StorageAwareness\QOS_DURABILITY_DISK, and Wikimedia\ObjectCache\RedisConnectionPool\singleton().
|
protected |
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 from Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Definition at line 362 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnection(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getExpirationAsTTL(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getSerialized(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), Wikimedia\ObjectCache\RedisBagOStuff\logRequest(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().
|
protected |
string | $key | |
int | $exptime | |
int | $flags |
Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Definition at line 423 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnection(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getExpirationAsTimestamp(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getExpirationAsTTL(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\isRelativeExpiration(), Wikimedia\ObjectCache\RedisBagOStuff\logRequest(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().
Wikimedia\ObjectCache\RedisBagOStuff::doChangeTTLMulti | ( | array | $keys, |
$exptime, | |||
$flags = 0 ) |
string[] | $keys | List of keys |
int | $exptime | TTL or UNIX timestamp |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Definition at line 320 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnectionsForKeys(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getExpirationAsTimestamp(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getExpirationAsTTL(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\isRelativeExpiration(), Wikimedia\ObjectCache\RedisBagOStuff\logRequest(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().
|
protected |
Delete an item.
string | $key | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Definition at line 166 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnection(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), Wikimedia\ObjectCache\RedisBagOStuff\logRequest(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().
|
protected |
string[] | $keys | List of keys |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Definition at line 287 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnectionsForKeys(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), Wikimedia\ObjectCache\RedisBagOStuff\logRequest(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().
|
protected |
Get an item.
The CAS token should be null if the key does not exist or the value is corrupt
string | $key | |
int | $flags | Bitfield of BagOStuff::READ_* constants [optional] |
mixed | &$casToken | CAS token if MediumSpecificBagOStuff::PASS_BY_REF [returned] |
Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Definition at line 102 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnection(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), Wikimedia\ObjectCache\RedisBagOStuff\logRequest(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\PASS_BY_REF, Wikimedia\ObjectCache\MediumSpecificBagOStuff\unserialize(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().
|
protected |
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 from Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Definition at line 188 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnectionsForKeys(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), Wikimedia\ObjectCache\RedisBagOStuff\logRequest(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\unserialize(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().
|
protected |
string | $key | |
int | $exptime | |
int | $step | |
int | $init | |
int | $flags |
Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Definition at line 390 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnection(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getExpirationAsTTL(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), and Wikimedia\ObjectCache\RedisBagOStuff\logRequest().
|
protected |
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 from Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Definition at line 137 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnection(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getExpirationAsTTL(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getSerialized(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), Wikimedia\ObjectCache\RedisBagOStuff\logRequest(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().
|
protected |
mixed[] | $data | Map of (key => value) |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.
Definition at line 242 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnectionsForKeys(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getExpirationAsTTL(), Wikimedia\ObjectCache\MediumSpecificBagOStuff\getSerialized(), Wikimedia\ObjectCache\RedisBagOStuff\handleException(), Wikimedia\ObjectCache\RedisBagOStuff\logRequest(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().
|
protected |
string | $key |
Definition at line 522 of file RedisBagOStuff.php.
References Wikimedia\ObjectCache\RedisBagOStuff\getConnectionsForKeys().
Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doAdd(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTL(), Wikimedia\ObjectCache\RedisBagOStuff\doDelete(), Wikimedia\ObjectCache\RedisBagOStuff\doGet(), Wikimedia\ObjectCache\RedisBagOStuff\doIncrWithInit(), and Wikimedia\ObjectCache\RedisBagOStuff\doSet().
|
protected |
string[] | $keys |
Definition at line 457 of file RedisBagOStuff.php.
References $success, Wikimedia\LightweightObjectStore\StorageAwareness\ERR_UNREACHABLE, and Wikimedia\ObjectCache\BagOStuff\setLastError().
Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTLMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doDeleteMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doGetMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doSetMulti(), and Wikimedia\ObjectCache\RedisBagOStuff\getConnection().
|
protected |
The redis extension throws an exception in response to various read, write and protocol errors.
Sometimes it also closes the connection, sometimes not. The safest response for us is to explicitly destroy the connection object and let it be reopened during the next request.
RedisConnRef | $conn | |
RedisException | $e |
Definition at line 559 of file RedisBagOStuff.php.
References Wikimedia\LightweightObjectStore\StorageAwareness\ERR_UNEXPECTED, and setLastError().
Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doAdd(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTL(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTLMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doDelete(), Wikimedia\ObjectCache\RedisBagOStuff\doDeleteMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doGet(), Wikimedia\ObjectCache\RedisBagOStuff\doGetMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doIncrWithInit(), Wikimedia\ObjectCache\RedisBagOStuff\doSet(), and Wikimedia\ObjectCache\RedisBagOStuff\doSetMulti().
|
protected |
Wikimedia\ObjectCache\RedisBagOStuff::logRequest | ( | $op, | |
$keys, | |||
$server, | |||
$e = null ) |
Send information about a single request to the debug log.
string | $op | |
string | $keys | |
string | $server | |
Exception | bool | null | $e |
Definition at line 572 of file RedisBagOStuff.php.
Referenced by Wikimedia\ObjectCache\RedisBagOStuff\doAdd(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTL(), Wikimedia\ObjectCache\RedisBagOStuff\doChangeTTLMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doDelete(), Wikimedia\ObjectCache\RedisBagOStuff\doDeleteMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doGet(), Wikimedia\ObjectCache\RedisBagOStuff\doGetMulti(), Wikimedia\ObjectCache\RedisBagOStuff\doIncrWithInit(), Wikimedia\ObjectCache\RedisBagOStuff\doSet(), and Wikimedia\ObjectCache\RedisBagOStuff\doSetMulti().
|
protected |
Definition at line 50 of file RedisBagOStuff.php.
|
protected |
Definition at line 44 of file RedisBagOStuff.php.
|
protected |
List of server names.
Definition at line 46 of file RedisBagOStuff.php.
|
protected |
Map of (tag => server name)
Definition at line 48 of file RedisBagOStuff.php.