MediaWiki  REL1_31
SqlBagOStuff Class Reference

Class to store objects in the database. More...

Inheritance diagram for SqlBagOStuff:
Collaboration diagram for SqlBagOStuff:

Public Member Functions

 __construct ( $params)
 Constructor. More...
 
 changeTTL ( $key, $expiry=0)
 Reset the TTL on a key if it exists. More...
 
 createTables ()
 Create shard tables. More...
 
 delete ( $key)
 Delete an item. More...
 
 deleteAll ()
 Delete content of shard tables in every server. More...
 
 deleteObjectsExpiringBefore ( $timestamp, $progressCallback=false)
 Delete objects from the database which expire before a certain date. More...
 
 expireAll ()
 
 getMulti (array $keys, $flags=0)
 Get an associative array containing the item for each of the keys that have items. More...
 
 incr ( $key, $step=1)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
 Merge changes into the existing cache value (possibly creating a new one) More...
 
 set ( $key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
 setMulti (array $data, $expiry=0)
 Batch insertion. More...
 
- Public Member Functions inherited from BagOStuff
 __construct (array $params=[])
 $params include: More...
 
 add ( $key, $value, $exptime=0)
 
 addBusyCallback (callable $workCallback)
 Let a callback be run to avoid wasting time on special blocking calls. More...
 
 clearLastError ()
 Clear the "last error" registry. More...
 
 decr ( $key, $value=1)
 Decrease stored value of $key by $value while preserving its TTL. More...
 
 get ( $key, $flags=0, $oldFlags=null)
 Get an item with the given key. More...
 
 getLastError ()
 Get the "last error" registered; clearLastError() should be called manually. More...
 
 getQoS ( $flag)
 
 getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
 Get a lightweight exclusive self-unlocking lock. More...
 
 getWithSetCallback ( $key, $ttl, $callback, $flags=0)
 Get an item with the given key, regenerating and setting it if not found. More...
 
 incrWithInit ( $key, $ttl, $value=1, $init=1)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 lock ( $key, $timeout=6, $expiry=6, $rclass='')
 Acquire an advisory lock on a key string. More...
 
 makeGlobalKey ( $class, $component=null)
 Make a global cache key. More...
 
 makeKey ( $class, $component=null)
 Make a cache key, scoped to this instance's keyspace. More...
 
 makeKeyInternal ( $keyspace, $args)
 Construct a cache key. More...
 
 modifySimpleRelayEvent (array $event)
 Modify a cache update operation array for EventRelayer::notify() More...
 
 setDebug ( $bool)
 
 setLogger (LoggerInterface $logger)
 
 setMockTime (&$time)
 
 unlock ( $key)
 Release an advisory lock on a key string. More...
 

Protected Member Functions

 cas ( $casToken, $key, $value, $exptime=0)
 Check and set an item. More...
 
 doGet ( $key, $flags=0)
 
 garbageCollect ()
 
 getDB ( $serverIndex)
 Get a connection to the specified database. More...
 
 getMaxDateTime ( $db)
 
 getTableByKey ( $key)
 Get the server index and table name for a given key. More...
 
 getTableNameByShard ( $index)
 Get the table name for a given shard index. More...
 
 getWithToken ( $key, &$casToken, $flags=0)
 
 handleReadError (DBError $exception, $serverIndex)
 Handle a DBError which occurred during a read operation. More...
 
 handleWriteError (DBError $exception, IDatabase $db=null, $serverIndex)
 Handle a DBQueryError which occurred during a write operation. More...
 
 isExpired ( $db, $exptime)
 
 markServerDown (DBError $exception, $serverIndex)
 Mark a server down due to a DBConnectionError exception. More...
 
 serialize (&$data)
 Serialize an object and, if possible, compress the representation. More...
 
 unserialize ( $serial)
 Unserialize and, if necessary, decompress an object. More...
 
 usesMainDB ()
 
 waitForReplication ()
 
- Protected Member Functions inherited from BagOStuff
 convertExpiry ( $exptime)
 Convert an optionally relative time to an absolute time. More...
 
 convertToRelative ( $exptime)
 Convert an optionally absolute expiry time to a relative time. More...
 
 debug ( $text)
 
 getCurrentTime ()
 
 isInteger ( $value)
 Check if a value is an integer. More...
 
 mergeFlagMaps (array $bags)
 Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More...
 
 mergeViaCas ( $key, $callback, $exptime=0, $attempts=10)
 
 mergeViaLock ( $key, $callback, $exptime=0, $attempts=10, $flags=0)
 
 setLastError ( $err)
 Set the "last error" registry. More...
 

Protected Attributes

array $connFailureErrors = []
 Exceptions. More...
 
array $connFailureTimes = []
 UNIX timestamps. More...
 
array $conns
 
int $lastExpireAll = 0
 
int $numServers
 
int $purgePeriod = 100
 
bool $replicaOnly = false
 
LoadBalancer null $separateMainLB
 
array[] $serverInfos
 (server index => server config) More...
 
string[] $serverTags
 (server index => tag/host name) More...
 
int $shards = 1
 
int $syncTimeout = 3
 
string $tableName = 'objectcache'
 
- Protected Attributes inherited from BagOStuff
callback null $asyncHandler
 
int[] $attrMap = []
 Map of (ATTR_* class constant => QOS_* class constant) More...
 
callable[] $busyCallbacks = []
 
string $keyspace = 'local'
 
int $lastError = self::ERR_NONE
 ERR_* class constant. More...
 
array[] $locks = []
 Lock tracking. More...
 
LoggerInterface $logger
 
int $syncTimeout
 Seconds. More...
 

Additional Inherited Members

- Public Attributes inherited from BagOStuff
const ERR_NO_RESPONSE = 1
 
const ERR_NONE = 0
 Possible values for getLastError() More...
 
const ERR_UNEXPECTED = 3
 
const ERR_UNREACHABLE = 2
 
const READ_LATEST = 1
 Bitfield constants for get()/getMulti() More...
 
const READ_VERIFIED = 2
 
const WRITE_CACHE_ONLY = 2
 
const WRITE_SYNC = 1
 Bitfield constants for set()/merge() More...
 
- Public Attributes inherited from IExpiringStore
const ATTR_EMULATION = 1
 
const ATTR_SYNCWRITES = 2
 
const QOS_EMULATION_SQL = 1
 
const QOS_SYNCWRITES_BE = 2
 
const QOS_SYNCWRITES_NONE = 1
 
const QOS_SYNCWRITES_QC = 3
 
const QOS_SYNCWRITES_SS = 4
 
const QOS_UNKNOWN = INF
 
const TTL_DAY = 86400
 
const TTL_HOUR = 3600
 
const TTL_INDEFINITE = 0
 
const TTL_MINUTE = 60
 
const TTL_MONTH = 2592000
 
const TTL_PROC_LONG = 30
 
const TTL_PROC_SHORT = 3
 
const TTL_SECOND = 1
 
const TTL_WEEK = 604800
 
const TTL_YEAR = 31536000
 

Detailed Description

Class to store objects in the database.

Definition at line 39 of file SqlBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

SqlBagOStuff::__construct (   $params)

Constructor.

Parameters are:

  • server: A server info structure in the format required by each element in $wgDBServers.
  • servers: An array of server info structures describing a set of database servers to distribute keys to. If this is specified, the "server" option will be ignored. If string keys are used, then they will be used for consistent hashing instead of the host name (from the server config). This is useful when a cluster is replicated to another site (with different host names) but each server has a corresponding replica in the other cluster.
  • purgePeriod: The average number of object cache requests in between garbage collection operations, where expired entries are removed from the database. Or in other words, the reciprocal of the probability of purging on any given request. If this is set to zero, purging will never be done.
  • tableName: The table name to use, default is "objectcache".
  • shards: The number of tables to use for data storage on each server. If this is more than 1, table names will be formed in the style objectcacheNNN where NNN is the shard index, between 0 and shards-1. The number of digits will be the minimum number required to hold the largest shard index. Data will be distributed across all tables by key hash. This is for MySQL bugs 61735 and 61736.
  • slaveOnly: Whether to only use replica DBs and avoid triggering garbage collection logic of expired items. This only makes sense if the primary DB is used and only if get() calls will be used. This is used by ReplicatedBagOStuff.
  • syncTimeout: Max seconds to wait for replica DBs to catch up for WRITE_SYNC.
Parameters
array$params

Definition at line 104 of file SqlBagOStuff.php.

References $params, as, IExpiringStore\ATTR_EMULATION, IExpiringStore\ATTR_SYNCWRITES, IExpiringStore\QOS_EMULATION_SQL, IExpiringStore\QOS_SYNCWRITES_BE, IExpiringStore\QOS_SYNCWRITES_NONE, and tableName().

Member Function Documentation

◆ cas()

SqlBagOStuff::cas (   $casToken,
  $key,
  $value,
  $exptime = 0 
)
protected

Check and set an item.

Parameters
mixed$casToken
string$key
mixed$value
int$exptimeEither an interval in seconds or a unix timestamp for expiry
Returns
bool Success
Exceptions
Exception

Reimplemented from BagOStuff.

Definition at line 384 of file SqlBagOStuff.php.

References $e, $tableName, $value, BagOStuff\convertExpiry(), getDB(), getMaxDateTime(), getTableByKey(), handleWriteError(), and list.

◆ changeTTL()

SqlBagOStuff::changeTTL (   $key,
  $expiry = 0 
)

Reset the TTL on a key if it exists.

Parameters
string$key
int$expiry
Returns
bool Success Returns false if there is no key
Since
1.28

Reimplemented from BagOStuff.

Definition at line 496 of file SqlBagOStuff.php.

References $e, $tableName, getDB(), getTableByKey(), handleWriteError(), and list.

◆ createTables()

SqlBagOStuff::createTables ( )

Create shard tables.

For use from eval.php.

Definition at line 775 of file SqlBagOStuff.php.

References $numServers, $shards, and getDB().

◆ delete()

SqlBagOStuff::delete (   $key)

Delete an item.

Parameters
string$key
Returns
bool True if the item was deleted or not found, false on failure

Reimplemented from BagOStuff.

Definition at line 425 of file SqlBagOStuff.php.

References $e, $tableName, getDB(), getTableByKey(), handleWriteError(), and list.

◆ deleteAll()

SqlBagOStuff::deleteAll ( )

Delete content of shard tables in every server.

Return true if the operation is successful, false otherwise.

Returns
bool

Definition at line 643 of file SqlBagOStuff.php.

References $e, $numServers, $shards, getDB(), getTableNameByShard(), and handleWriteError().

◆ deleteObjectsExpiringBefore()

SqlBagOStuff::deleteObjectsExpiringBefore (   $timestamp,
  $progressCallback = false 
)

Delete objects from the database which expire before a certain date.

Parameters
string$timestamp
bool | callable$progressCallback
Returns
bool

Reimplemented from BagOStuff.

Definition at line 566 of file SqlBagOStuff.php.

References $e, $keys, $numServers, $rows, $shards, as, getDB(), getTableNameByShard(), handleWriteError(), and wfTimestamp().

Referenced by expireAll().

◆ doGet()

SqlBagOStuff::doGet (   $key,
  $flags = 0 
)
protected
Parameters
string$key
int$flagsBitfield of BagOStuff::READ_* constants [optional]
Returns
mixed Returns false on failure and if the item does not exist

Reimplemented from BagOStuff.

Definition at line 238 of file SqlBagOStuff.php.

References getWithToken().

◆ expireAll()

SqlBagOStuff::expireAll ( )

Definition at line 556 of file SqlBagOStuff.php.

References deleteObjectsExpiringBefore(), and wfTimestampNow().

Referenced by garbageCollect().

◆ garbageCollect()

SqlBagOStuff::garbageCollect ( )
protected

Definition at line 539 of file SqlBagOStuff.php.

References expireAll().

Referenced by getMulti(), and setMulti().

◆ getDB()

SqlBagOStuff::getDB (   $serverIndex)
protected

Get a connection to the specified database.

Parameters
int$serverIndex
Returns
Database
Exceptions
MWException

Definition at line 155 of file SqlBagOStuff.php.

References $type, DB_MASTER, DB_REPLICA, and DBO_TRX.

Referenced by cas(), changeTTL(), createTables(), delete(), deleteAll(), deleteObjectsExpiringBefore(), getMulti(), incr(), and setMulti().

◆ getMaxDateTime()

SqlBagOStuff::getMaxDateTime (   $db)
protected
Parameters
IDatabase$db
Returns
string

Definition at line 531 of file SqlBagOStuff.php.

Referenced by cas(), isExpired(), and setMulti().

◆ getMulti()

SqlBagOStuff::getMulti ( array  $keys,
  $flags = 0 
)

Get an associative array containing the item for each of the keys that have items.

Parameters
array$keysList of strings
int$flagsBitfield; supports READ_LATEST [optional]
Returns
array

Reimplemented from BagOStuff.

Definition at line 253 of file SqlBagOStuff.php.

References $e, $keys, $res, $tableName, as, BagOStuff\debug(), garbageCollect(), getDB(), getTableByKey(), handleReadError(), handleWriteError(), isExpired(), list, and unserialize().

Referenced by getWithToken().

◆ getTableByKey()

SqlBagOStuff::getTableByKey (   $key)
protected

Get the server index and table name for a given key.

Parameters
string$key
Returns
array Server index and table name

Definition at line 205 of file SqlBagOStuff.php.

References $serverTags, $shards, ArrayUtils\consistentHashSort(), getTableNameByShard(), and key.

Referenced by cas(), changeTTL(), delete(), getMulti(), incr(), and setMulti().

◆ getTableNameByShard()

SqlBagOStuff::getTableNameByShard (   $index)
protected

Get the table name for a given shard index.

Parameters
int$index
Returns
string

Definition at line 228 of file SqlBagOStuff.php.

References $tableName, and tableName().

Referenced by deleteAll(), deleteObjectsExpiringBefore(), and getTableByKey().

◆ getWithToken()

SqlBagOStuff::getWithToken (   $key,
$casToken,
  $flags = 0 
)
protected
Note
: This method is only needed if merge() uses mergeViaCas()
Parameters
string$key
mixed&$casToken
int$flagsBitfield of BagOStuff::READ_* constants [optional]
Returns
mixed Returns false on failure and if the item does not exist
Exceptions
Exception

Reimplemented from BagOStuff.

Definition at line 244 of file SqlBagOStuff.php.

References getMulti().

Referenced by doGet().

◆ handleReadError()

SqlBagOStuff::handleReadError ( DBError  $exception,
  $serverIndex 
)
protected

Handle a DBError which occurred during a read operation.

Parameters
DBError$exception
int$serverIndex

Definition at line 704 of file SqlBagOStuff.php.

References BagOStuff\ERR_UNEXPECTED, BagOStuff\ERR_UNREACHABLE, markServerDown(), and BagOStuff\setLastError().

Referenced by getMulti().

◆ handleWriteError()

SqlBagOStuff::handleWriteError ( DBError  $exception,
IDatabase  $db = null,
  $serverIndex 
)
protected

Handle a DBQueryError which occurred during a write operation.

Parameters
DBError$exception
IDatabase | null$dbDB handle or null if connection failed
int$serverIndex
Exceptions
Exception

Definition at line 726 of file SqlBagOStuff.php.

References BagOStuff\ERR_UNEXPECTED, BagOStuff\ERR_UNREACHABLE, markServerDown(), and BagOStuff\setLastError().

Referenced by cas(), changeTTL(), delete(), deleteAll(), deleteObjectsExpiringBefore(), getMulti(), incr(), and setMulti().

◆ incr()

SqlBagOStuff::incr (   $key,
  $value = 1 
)

Increase stored value of $key by $value while preserving its TTL.

Parameters
string$keyKey to increase
int$valueValue to add to $key (Default 1)
Returns
int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 442 of file SqlBagOStuff.php.

References $e, $tableName, getDB(), getTableByKey(), handleWriteError(), isExpired(), list, and unserialize().

◆ isExpired()

SqlBagOStuff::isExpired (   $db,
  $exptime 
)
protected
Parameters
IDatabase$db
string$exptime
Returns
bool

Definition at line 523 of file SqlBagOStuff.php.

References getMaxDateTime(), and wfTimestamp().

Referenced by getMulti(), and incr().

◆ markServerDown()

SqlBagOStuff::markServerDown ( DBError  $exception,
  $serverIndex 
)
protected

Mark a server down due to a DBConnectionError exception.

Parameters
DBError$exception
int$serverIndex

Definition at line 754 of file SqlBagOStuff.php.

Referenced by handleReadError(), and handleWriteError().

◆ merge()

SqlBagOStuff::merge (   $key,
callable  $callback,
  $exptime = 0,
  $attempts = 10,
  $flags = 0 
)

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.

Parameters
string$key
callable$callbackCallback method to be executed
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$attemptsThe amount of times to attempt a merge in case of failure
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success
Exceptions
InvalidArgumentException

Reimplemented from BagOStuff.

Definition at line 487 of file SqlBagOStuff.php.

References BagOStuff\mergeViaCas(), and waitForReplication().

◆ serialize()

SqlBagOStuff::serialize ( $data)
protected

Serialize an object and, if possible, compress the representation.

On typical message and page data, this can provide a 3X decrease in storage requirements.

Parameters
mixed&$data
Returns
string

Definition at line 667 of file SqlBagOStuff.php.

Referenced by setMulti().

◆ set()

SqlBagOStuff::set (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)

Set an item.

Parameters
string$key
mixed$value
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Reimplemented from BagOStuff.

Definition at line 375 of file SqlBagOStuff.php.

References $value, setMulti(), and waitForReplication().

◆ setMulti()

SqlBagOStuff::setMulti ( array  $data,
  $exptime = 0 
)

Batch insertion.

Parameters
array$data$key => $value assoc array
int$exptimeEither an interval in seconds or a unix timestamp for expiry
Returns
bool Success
Since
1.24

Reimplemented from BagOStuff.

Definition at line 315 of file SqlBagOStuff.php.

References $e, $rows, $tableName, $value, as, BagOStuff\convertExpiry(), garbageCollect(), getDB(), getMaxDateTime(), getTableByKey(), handleWriteError(), list, and serialize().

Referenced by set().

◆ unserialize()

SqlBagOStuff::unserialize (   $serial)
protected

Unserialize and, if necessary, decompress an object.

Parameters
string$serial
Returns
mixed

Definition at line 682 of file SqlBagOStuff.php.

References $ret.

Referenced by getMulti(), and incr().

◆ usesMainDB()

SqlBagOStuff::usesMainDB ( )
protected
Returns
bool Whether the main DB is used, e.g. wfGetDB( DB_MASTER )

Definition at line 794 of file SqlBagOStuff.php.

References $serverInfos.

Referenced by waitForReplication().

◆ waitForReplication()

SqlBagOStuff::waitForReplication ( )
protected

Definition at line 798 of file SqlBagOStuff.php.

References BagOStuff\$busyCallbacks, $syncTimeout, use, and usesMainDB().

Referenced by merge(), and set().

Member Data Documentation

◆ $connFailureErrors

array SqlBagOStuff::$connFailureErrors = []
protected

Exceptions.

Definition at line 66 of file SqlBagOStuff.php.

◆ $connFailureTimes

array SqlBagOStuff::$connFailureTimes = []
protected

UNIX timestamps.

Definition at line 64 of file SqlBagOStuff.php.

◆ $conns

array SqlBagOStuff::$conns
protected

Definition at line 62 of file SqlBagOStuff.php.

◆ $lastExpireAll

int SqlBagOStuff::$lastExpireAll = 0
protected

Definition at line 47 of file SqlBagOStuff.php.

◆ $numServers

int SqlBagOStuff::$numServers
protected

Definition at line 45 of file SqlBagOStuff.php.

Referenced by createTables(), deleteAll(), and deleteObjectsExpiringBefore().

◆ $purgePeriod

int SqlBagOStuff::$purgePeriod = 100
protected

Definition at line 49 of file SqlBagOStuff.php.

◆ $replicaOnly

bool SqlBagOStuff::$replicaOnly = false
protected

Definition at line 55 of file SqlBagOStuff.php.

◆ $separateMainLB

LoadBalancer null SqlBagOStuff::$separateMainLB
protected

Definition at line 60 of file SqlBagOStuff.php.

◆ $serverInfos

array [] SqlBagOStuff::$serverInfos
protected

(server index => server config)

Definition at line 41 of file SqlBagOStuff.php.

Referenced by usesMainDB().

◆ $serverTags

string [] SqlBagOStuff::$serverTags
protected

(server index => tag/host name)

Definition at line 43 of file SqlBagOStuff.php.

Referenced by getTableByKey().

◆ $shards

int SqlBagOStuff::$shards = 1
protected

◆ $syncTimeout

int SqlBagOStuff::$syncTimeout = 3
protected

Definition at line 57 of file SqlBagOStuff.php.

Referenced by waitForReplication().

◆ $tableName

string SqlBagOStuff::$tableName = 'objectcache'
protected

Definition at line 53 of file SqlBagOStuff.php.

Referenced by cas(), changeTTL(), delete(), getMulti(), getTableNameByShard(), incr(), and setMulti().


The documentation for this class was generated from the following file: