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

Inheritance diagram for SqlBagOStuff:

[legend]

Collaboration diagram for SqlBagOStuff:

[legend]

Public Member Functions
	__construct ( $params)
	Constructor.

	createTables ()
	Create shard tables.

	delete ( $key)
	Delete an item.

	deleteAll ()
	Delete content of shard tables in every server.

	deleteObjectsExpiringBefore ( $timestamp, $progressCallback=false)
	Delete objects from the database which expire before a certain date.

	expireAll ()

	getMulti (array $keys, $flags=0)
	Get an associative array containing the item for each of the keys that have items.

	incr ( $key, $step=1)
	Increase stored value of $key by $value while preserving its TTL.

	merge ( $key, $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 $data, $expiry=0)
	Batch insertion.

Public Member Functions inherited from BagOStuff
	__construct (array $params=[])
	$params include:

	add ( $key, $value, $exptime=0)

	clearLastError ()
	Clear the "last error" registry.

	decr ( $key, $value=1)
	Decrease stored value of $key by $value while preserving its TTL.

	get ( $key, $flags=0, $oldFlags=null)
	Get an item with the given key.

	getLastError ()
	Get the "last error" registered; clearLastError() should be called manually.

	getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
	Get a lightweight exclusive self-unlocking lock.

	getWithSetCallback ( $key, $ttl, $callback, $flags=0)
	Get an item with the given key, regenerating and setting it if not found.

	incrWithInit ( $key, $ttl, $value=1, $init=1)
	Increase stored value of $key by $value while preserving its TTL.

	lock ( $key, $timeout=6, $expiry=6, $rclass='')
	Acquire an advisory lock on a key string.

	makeGlobalKey ()
	Make a global cache key.

	makeKey ()
	Make a cache key, scoped to this instance's keyspace.

	makeKeyInternal ( $keyspace, $args)
	Construct a cache key.

	modifySimpleRelayEvent (array $event)
	Modify a cache update operation array for EventRelayer::notify()

	setDebug ( $bool)

	setLogger (LoggerInterface $logger)

	unlock ( $key)
	Release an advisory lock on a key string.

Protected Member Functions
	cas ( $casToken, $key, $value, $exptime=0)
	Check and set an item.

	doGet ( $key, $flags=0)

	garbageCollect ()

	getDB ( $serverIndex)
	Get a connection to the specified database.

	getMaxDateTime ( $db)

	getTableByKey ( $key)
	Get the server index and table name for a given key.

	getTableNameByShard ( $index)
	Get the table name for a given shard index.

	getWithToken ( $key, &$casToken, $flags=0)

	handleReadError (DBError $exception, $serverIndex)
	Handle a DBError which occurred during a read operation.

	handleWriteError (DBError $exception, $serverIndex)
	Handle a DBQueryError which occurred during a write operation.

	isExpired ( $db, $exptime)

	markServerDown ( $exception, $serverIndex)
	Mark a server down due to a DBConnectionError exception.

	serialize (&$data)
	Serialize an object and, if possible, compress the representation.

	unserialize ( $serial)
	Unserialize and, if necessary, decompress an object.

	waitForSlaves ()

Protected Member Functions inherited from BagOStuff
	convertExpiry ( $exptime)
	Convert an optionally relative time to an absolute time.

	convertToRelative ( $exptime)
	Convert an optionally absolute expiry time to a relative time.

	debug ( $text)

	isInteger ( $value)
	Check if a value is an integer.

	mergeViaCas ( $key, $callback, $exptime=0, $attempts=10)

	mergeViaLock ( $key, $callback, $exptime=0, $attempts=10, $flags=0)

	setLastError ( $err)
	Set the "last error" registry.

Protected Attributes
array	$connFailureErrors = []
	Exceptions.

array	$connFailureTimes = []
	UNIX timestamps.

array	$conns

int	$lastExpireAll = 0

int	$numServers

int	$purgePeriod = 100

array[]	$serverInfos
	(server index => server config)

string[]	$serverTags
	(server index => tag/host name)

int	$shards = 1

bool	$slaveOnly = false

int	$syncTimeout = 3

string	$tableName = 'objectcache'

Protected Attributes inherited from BagOStuff
callback null	$asyncHandler

string	$keyspace = 'local'

integer	$lastError = self::ERR_NONE

array[]	$locks = []
	Lock tracking.

LoggerInterface	$logger

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0
	Possible values for getLastError()

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 2

const	READ_LATEST = 1
	Bitfield constants for get()/getMulti()

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 2

const	WRITE_SYNC = 1
	Bitfield constants for set()/merge()

Public Attributes inherited from IExpiringStore
const	TTL_DAY = 86400

const	TTL_HOUR = 3600

const	TTL_INDEFINITE = 0

const	TTL_MINUTE = 60

const	TTL_MONTH = 2592000

const	TTL_WEEK = 604800

const	TTL_YEAR = 31536000

Detailed Description

Class to store objects in the database.

Definition at line 29 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 slave 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 slaves to catch up for WRITE_SYNC.

Parameters

array $params

Definition at line 92 of file SqlBagOStuff.php.

References $params, $tag, as, 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	$exptime	Either an interval in seconds or a unix timestamp for expiry

Returns: bool Success

Exceptions

Exception

Reimplemented from BagOStuff.

Definition at line 362 of file SqlBagOStuff.php.

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

◆ createTables()

SqlBagOStuff::createTables ( )

Create shard tables.

For use from eval.php.

Definition at line 729 of file SqlBagOStuff.php.

References $i, $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 402 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 599 of file SqlBagOStuff.php.

References $e, $i, $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 523 of file SqlBagOStuff.php.

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

Referenced by expireAll().

◆ doGet()

SqlBagOStuff::doGet	(	$key,
		$flags = `0`
	)

protected

Parameters

string	$key
integer	$flags	Bitfield of BagOStuff::READ_* constants [optional]

Returns: mixed Returns false on failure and if the item does not exist

Reimplemented from BagOStuff.

Definition at line 218 of file SqlBagOStuff.php.

References $flags, and getWithToken().

◆ expireAll()

SqlBagOStuff::expireAll ( )

Definition at line 513 of file SqlBagOStuff.php.

References deleteObjectsExpiringBefore(), and wfTimestampNow().

Referenced by garbageCollect().

◆ garbageCollect()

SqlBagOStuff::garbageCollect ( )

protected

Definition at line 496 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: IDatabase

Exceptions

MWException

Definition at line 137 of file SqlBagOStuff.php.

References $type, DB_MASTER, DB_SLAVE, DBO_TRX, DatabaseBase\factory(), wfGetDB(), and wfGetLBFactory().

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

◆ getMaxDateTime()

SqlBagOStuff::getMaxDateTime ( $db )

protected

Parameters

IDatabase $db

Returns: string

Definition at line 488 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	$keys	List of strings
integer	$flags	Bitfield; supports READ_LATEST [optional]

Returns: array

Reimplemented from BagOStuff.

Definition at line 233 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 185 of file SqlBagOStuff.php.

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

Referenced by cas(), 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 208 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
integer	$flags	Bitfield 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 224 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 659 of file SqlBagOStuff.php.

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

Referenced by getMulti().

◆ handleWriteError()

SqlBagOStuff::handleWriteError	(	DBError	$exception,
			$serverIndex
	)

protected

Handle a DBQueryError which occurred during a write operation.

Parameters

DBError	$exception
int	$serverIndex

Definition at line 679 of file SqlBagOStuff.php.

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

Referenced by cas(), 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	$key	Key to increase
int	$value	Value to add to $key (Default 1)

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 418 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 480 of file SqlBagOStuff.php.

References getMaxDateTime(), TS_UNIX, and wfTimestamp().

Referenced by getMulti(), and incr().

◆ markServerDown()

SqlBagOStuff::markServerDown	(	$exception,
		$serverIndex
	)

protected

Mark a server down due to a DBConnectionError exception.

Parameters

DBError	$exception
int	$serverIndex

Definition at line 708 of file SqlBagOStuff.php.

Referenced by handleReadError(), and handleWriteError().

◆ merge()

SqlBagOStuff::merge	(	$key,
		$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).

Parameters

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

Returns: bool Success

Exceptions

InvalidArgumentException

Reimplemented from BagOStuff.

Definition at line 462 of file SqlBagOStuff.php.

References $flags, BagOStuff\mergeViaCas(), and waitForSlaves().

◆ 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 622 of file SqlBagOStuff.php.

References serialize().

◆ set()

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

Set an item.

Parameters

string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented from BagOStuff.

Definition at line 353 of file SqlBagOStuff.php.

References $flags, $value, setMulti(), and waitForSlaves().

◆ setMulti()

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

Batch insertion.

Parameters

array	$data	$key => $value assoc array
int	$exptime	Either an interval in seconds or a unix timestamp for expiry

Returns: bool Success

Since: 1.24

Reimplemented from BagOStuff.

Definition at line 294 of file SqlBagOStuff.php.

References $e, $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 637 of file SqlBagOStuff.php.

References $ret, and unserialize().

Referenced by getMulti(), incr(), and unserialize().

◆ waitForSlaves()

SqlBagOStuff::waitForSlaves ( )

protected

Definition at line 745 of file SqlBagOStuff.php.

References $e, wfGetLBFactory(), and wfWikiID().

Referenced by merge(), and set().

Member Data Documentation

◆ $connFailureErrors

array SqlBagOStuff::$connFailureErrors = []

protected

Exceptions.

Definition at line 54 of file SqlBagOStuff.php.

◆ $connFailureTimes

array SqlBagOStuff::$connFailureTimes = []

protected

UNIX timestamps.

Definition at line 52 of file SqlBagOStuff.php.

◆ $conns

array SqlBagOStuff::$conns

protected

Definition at line 50 of file SqlBagOStuff.php.

◆ $lastExpireAll

int SqlBagOStuff::$lastExpireAll = 0

protected

Definition at line 37 of file SqlBagOStuff.php.

◆ $numServers

int SqlBagOStuff::$numServers

protected

Definition at line 35 of file SqlBagOStuff.php.

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

◆ $purgePeriod

int SqlBagOStuff::$purgePeriod = 100

protected

Definition at line 39 of file SqlBagOStuff.php.

◆ $serverInfos

array [] SqlBagOStuff::$serverInfos

protected

(server index => server config)

Definition at line 31 of file SqlBagOStuff.php.

◆ $serverTags

string [] SqlBagOStuff::$serverTags

protected

(server index => tag/host name)

Definition at line 33 of file SqlBagOStuff.php.

Referenced by getTableByKey().

◆ $shards

int SqlBagOStuff::$shards = 1

protected

Definition at line 41 of file SqlBagOStuff.php.

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

◆ $slaveOnly

bool SqlBagOStuff::$slaveOnly = false

protected

Definition at line 45 of file SqlBagOStuff.php.

◆ $syncTimeout

int SqlBagOStuff::$syncTimeout = 3

protected

Definition at line 47 of file SqlBagOStuff.php.

◆ $tableName

string SqlBagOStuff::$tableName = 'objectcache'

protected

Definition at line 43 of file SqlBagOStuff.php.

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

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

includes/objectcache/SqlBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cas()

◆ createTables()

◆ delete()

◆ deleteAll()

◆ deleteObjectsExpiringBefore()

◆ doGet()

◆ expireAll()

◆ garbageCollect()

◆ getDB()

◆ getMaxDateTime()

◆ getMulti()

◆ getTableByKey()

◆ getTableNameByShard()

◆ getWithToken()

◆ handleReadError()

◆ handleWriteError()

◆ incr()

◆ isExpired()

◆ markServerDown()

◆ merge()

◆ serialize()

◆ set()

◆ setMulti()

◆ unserialize()

◆ waitForSlaves()

Member Data Documentation

◆ $connFailureErrors

◆ $connFailureTimes

◆ $conns

◆ $lastExpireAll

◆ $numServers

◆ $purgePeriod

◆ $serverInfos

◆ $serverTags

◆ $shards

◆ $slaveOnly

◆ $syncTimeout

◆ $tableName