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

Inheritance diagram for SqlBagOStuff:

[legend]

Collaboration diagram for SqlBagOStuff:

[legend]

Public Member Functions
	__construct ( $params)
	Constructor.

	changeTTLMulti (array $keys, $exptime, $flags=0)
	Change the expiration of multiple keys that exist.

	createTables ()
	Create the shard tables on all databases (e.g.

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

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

	deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF)
	Delete all objects expiring before a certain date.

	expireAll ()

	incr ( $key, $step=1, $flags=0)
	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.

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

Public Member Functions inherited from MediumSpecificBagOStuff
	__construct (array $params=[])

	add ( $key, $value, $exptime=0, $flags=0)
	Insert an item if it does not already exist.

	addBusyCallback (callable $workCallback)
	Let a callback be run to avoid wasting time on special blocking calls.

	changeTTL ( $key, $exptime=0, $flags=0)
	Change the expiration on a key if it exists.

	clearLastError ()
	Clear the "last error" registry.

	delete ( $key, $flags=0)
	Delete an item.

	deleteMulti (array $keys, $flags=0)
	Batch deletion.

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

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

	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, $value=1, $init=null, $flags=0)
	Increase the value of the given key (no TTL change) if it exists or create it otherwise.

	makeGlobalKey ( $class,... $components)
	Make a global cache key.

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

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

	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 $data, $exptime=0, $flags=0)
	Batch insertion/replace.

Public Member Functions inherited from BagOStuff
	getCurrentTime ()

	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.

	setDebug ( $enabled)

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

Protected Member Functions
	doAdd ( $key, $value, $exptime=0, $flags=0)
	Insert an item if it does not already exist.

	doCas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Check and set an item.

	doChangeTTL ( $key, $exptime, $flags)

	doDelete ( $key, $flags=0)
	Delete an item.

	doDeleteMulti (array $keys, $flags=0)

	doGet ( $key, $flags=0, &$casToken=null)

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

	doSet ( $key, $value, $exptime=0, $flags=0)
	Set an item.

	doSetMulti (array $data, $exptime=0, $flags=0)

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

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

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

	debug ( $text)

	getExpirationAsTimestamp ( $exptime)
	Convert an optionally relative timestamp to an absolute time.

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

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

	isRelativeExpiration ( $exptime)

	makeValueOrSegmentList ( $key, $value, $exptime, $flags)
	Determine the entry (inline or segment list) to store under a key to save the value.

	mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags)

	resolveSegments ( $key, $mainValue)
	Get and reassemble the chunks of blob at the given key.

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

Protected Member Functions inherited from BagOStuff
	fieldHasFlags ( $field, $flags)

	mergeFlagMaps (array $bags)
	Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.

Protected Attributes
array	$connFailureErrors = []
	Exceptions.

array	$connFailureTimes = []
	UNIX timestamps.

array	$conns

int	$lastGarbageCollect = 0
	UNIX timestamp.

int	$numServerShards

int	$numTableShards = 1

int	$purgeLimit = 100

int	$purgePeriod = 10

bool	$replicaOnly = false

LoadBalancer null	$separateMainLB

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

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

string	$tableName = 'objectcache'

Protected Attributes inherited from MediumSpecificBagOStuff
callable[]	$busyCallbacks = []

string	$keyspace = 'local'

int	$lastError = self::ERR_NONE
	ERR_* class constant.

array[]	$locks = []
	Lock tracking.

int	$segmentationSize
	Bytes; chunk size of segmented cache values.

int	$segmentedValueMaxSize
	Bytes; maximum total size of a segmented cache value.

int	$syncTimeout
	Seconds.

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

int[]	$attrMap = []
	Map of (ATTR_* class constant => QOS_* class constant)

bool	$debugMode = false

LoggerInterface	$logger

Private Member Functions
	deleteServerObjectsExpiringBefore (IDatabase $db, $timestamp, $progressCallback, $limit, $serversDoneCount=0, &$keysDeletedCount=0)

	fetchBlobMulti (array $keys, $flags=0)

	getConnection ( $shardIndex)
	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.

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

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

	initSqliteDatabase (IMaintainableDatabase $db)

	isExpired (IDatabase $db, $exptime)

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

	modifyMulti (array $data, $exptime, $flags, $op)

	occasionallyGarbageCollect (IDatabase $db)

	setAndLogDBError (DBError $exception)

	silenceTransactionProfiler ()
	Silence the transaction profiler until the return value falls out of scope.

	updateTableKeys ( $op, $db, $table, $tableKeys, $data, $dbExpiry)

	usesMainDB ()

	waitForReplication ()

Static Private Attributes
static int	$GC_DELAY_SEC = 1

static string	$OP_ADD = 'add'

static string	$OP_DELETE = 'delete'

static string	$OP_SET = 'set'

static string	$OP_TOUCH = 'touch'

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	READ_LATEST = 1
	Bitfield constants for get()/getMulti(); these are only advisory.

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.

Public Attributes inherited from IExpiringStore
const	ATTR_EMULATION = 1

const	ATTR_SYNCWRITES = 2

const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 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 42 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 writes 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 write. If this is set to zero, purging will never be done.
purgeLimit: Maximum number of rows to purge at once.
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 https://bugs.mysql.com/bug.php?id=61735 and 61736 https://bugs.mysql.com/bug.php?id=61736.
replicaOnly: 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 122 of file SqlBagOStuff.php.

References IExpiringStore\ATTR_EMULATION, IExpiringStore\ATTR_SYNCWRITES, IExpiringStore\QOS_EMULATION_SQL, IExpiringStore\QOS_SYNCWRITES_BE, and IExpiringStore\QOS_SYNCWRITES_NONE.

Member Function Documentation

◆ changeTTLMulti()

SqlBagOStuff::changeTTLMulti	(	array	$keys,
			$exptime,
			$flags = 0 )

Change the expiration of multiple keys that exist.

Parameters

string[]	$keys	List of keys
int	$exptime	TTL or UNIX timestamp
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success

See also: BagOStuff::changeTTL()

Since: 1.34

Reimplemented from MediumSpecificBagOStuff.

Definition at line 570 of file SqlBagOStuff.php.

References $keys, and modifyMulti().

◆ createTables()

SqlBagOStuff::createTables ( )

Create the shard tables on all databases (e.g.

via eval.php/shell.php)

Definition at line 988 of file SqlBagOStuff.php.

References $numServerShards, $numTableShards, getConnection(), and getTableNameByShard().

◆ decr()

SqlBagOStuff::decr	(	$key,
		$value = 1,
		$flags = 0 )

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

Parameters

string	$key
int	$value	Value to subtract from $key (default: 1) [optional]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 566 of file SqlBagOStuff.php.

References incr().

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

References $numServerShards, $numTableShards, getConnection(), getTableNameByShard(), handleWriteError(), and silenceTransactionProfiler().

◆ deleteObjectsExpiringBefore()

SqlBagOStuff::deleteObjectsExpiringBefore	(		$timestamp,
		callable	$progress = null,
			$limit = INF )

Delete all objects expiring before a certain date.

Parameters

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]

Returns: bool Success; false if unimplemented

Reimplemented from MediumSpecificBagOStuff.

Definition at line 641 of file SqlBagOStuff.php.

References deleteServerObjectsExpiringBefore(), getConnection(), handleWriteError(), and silenceTransactionProfiler().

Referenced by expireAll().

◆ deleteServerObjectsExpiringBefore()

SqlBagOStuff::deleteServerObjectsExpiringBefore	(	IDatabase	$db,
			$timestamp,
			$progressCallback,
			$limit,
			$serversDoneCount = 0,
		&	$keysDeletedCount = 0 )

private

Parameters

IDatabase	$db
string \| int	$timestamp
callable \| null	$progressCallback
int	$limit
int	$serversDoneCount
int	&$keysDeletedCount

Exceptions

DBError

Definition at line 685 of file SqlBagOStuff.php.

References $keys, $numServerShards, $res, Wikimedia\Rdbms\IDatabase\addQuotes(), Wikimedia\Rdbms\IDatabase\affectedRows(), Wikimedia\Rdbms\IDatabase\delete(), getTableNameByShard(), Wikimedia\Rdbms\IDatabase\select(), and Wikimedia\Rdbms\IDatabase\timestamp().

Referenced by deleteObjectsExpiringBefore(), and occasionallyGarbageCollect().

◆ doAdd()

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

protected

Insert an item if it does not already exist.

Parameters

string	$key
mixed	$value
int	$exptime
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 474 of file SqlBagOStuff.php.

References modifyMulti().

◆ doCas()

SqlBagOStuff::doCas	(	$casToken,
		$key,
		$value,
		$exptime = 0,
		$flags = 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
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 478 of file SqlBagOStuff.php.

References $success, $tableName, BagOStuff\fieldHasFlags(), getConnection(), MediumSpecificBagOStuff\getExpirationAsTimestamp(), getMaxDateTime(), getTableByKey(), handleWriteError(), silenceTransactionProfiler(), and waitForReplication().

◆ doChangeTTL()

SqlBagOStuff::doChangeTTL	(	$key,
		$exptime,
		$flags )

protected

Parameters

string	$key
int	$exptime
int	$flags

Returns: bool

Reimplemented from MediumSpecificBagOStuff.

Definition at line 579 of file SqlBagOStuff.php.

References modifyMulti().

◆ doDelete()

SqlBagOStuff::doDelete	(		$key,
			$flags = 0 )

protected

Delete an item.

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool True if the item was deleted or not found, false on failure

Reimplemented from MediumSpecificBagOStuff.

Definition at line 528 of file SqlBagOStuff.php.

References modifyMulti().

◆ doDeleteMulti()

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

protected

Parameters

string[]	$keys	List of keys
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 519 of file SqlBagOStuff.php.

References $keys, and modifyMulti().

◆ doGet()

SqlBagOStuff::doGet	(		$key,
			$flags = 0,
		&	$casToken = null )

protected

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
mixed \| null	&$casToken	Token to use for check-and-set comparisons

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

Reimplemented from MediumSpecificBagOStuff.

Definition at line 258 of file SqlBagOStuff.php.

References $blob, fetchBlobMulti(), and unserialize().

◆ doGetMulti()

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

protected

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

Parameters

string[]	$keys	List of keys
int	$flags	Bitfield; supports READ_LATEST [optional]

Returns: array Map of (key => value) for existing keys

Reimplemented from MediumSpecificBagOStuff.

Definition at line 274 of file SqlBagOStuff.php.

References $blob, fetchBlobMulti(), and unserialize().

◆ doSet()

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

protected

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 MediumSpecificBagOStuff.

Definition at line 470 of file SqlBagOStuff.php.

References modifyMulti().

◆ doSetMulti()

SqlBagOStuff::doSetMulti	(	array	$data,
			$exptime = 0,
			$flags = 0 )

protected

Parameters

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

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 345 of file SqlBagOStuff.php.

References modifyMulti().

◆ expireAll()

SqlBagOStuff::expireAll ( )

Definition at line 637 of file SqlBagOStuff.php.

References deleteObjectsExpiringBefore(), and BagOStuff\getCurrentTime().

◆ fetchBlobMulti()

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

private

Definition at line 285 of file SqlBagOStuff.php.

References $keys, $res, $tableName, MediumSpecificBagOStuff\debug(), getConnection(), getTableByKey(), handleReadError(), handleWriteError(), and isExpired().

Referenced by doGet(), and doGetMulti().

◆ getConnection()

SqlBagOStuff::getConnection ( $shardIndex )

private

Get a connection to the specified database.

Parameters

int $shardIndex

Returns: IMaintainableDatabase

Exceptions

MWException

Definition at line 174 of file SqlBagOStuff.php.

References $type, DB_MASTER, DB_REPLICA, DBO_TRX, BagOStuff\getCurrentTime(), and initSqliteDatabase().

Referenced by createTables(), deleteAll(), deleteObjectsExpiringBefore(), doCas(), fetchBlobMulti(), incr(), lock(), modifyMulti(), and unlock().

◆ getMaxDateTime()

SqlBagOStuff::getMaxDateTime ( $db )

private

Parameters

IDatabase $db

Returns: string

Definition at line 599 of file SqlBagOStuff.php.

References BagOStuff\getCurrentTime().

Referenced by doCas(), isExpired(), and modifyMulti().

◆ getTableByKey()

SqlBagOStuff::getTableByKey ( $key )

private

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

Parameters

string $key

Returns: array Server index and table name

Definition at line 225 of file SqlBagOStuff.php.

References $numTableShards, $serverTags, and getTableNameByShard().

Referenced by doCas(), fetchBlobMulti(), incr(), lock(), modifyMulti(), and unlock().

◆ getTableNameByShard()

SqlBagOStuff::getTableNameByShard ( $index )

private

Get the table name for a given shard index.

Parameters

int $index

Returns: string

Definition at line 248 of file SqlBagOStuff.php.

References $tableName.

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

◆ handleReadError()

SqlBagOStuff::handleReadError	(	DBError	$exception,
			$shardIndex )

private

Handle a DBError which occurred during a read operation.

Parameters

DBError	$exception
int	$shardIndex

Definition at line 893 of file SqlBagOStuff.php.

References markServerDown(), and setAndLogDBError().

Referenced by fetchBlobMulti().

◆ handleWriteError()

SqlBagOStuff::handleWriteError	(	DBError	$exception,
			$db,
			$shardIndex )

private

Handle a DBQueryError which occurred during a write operation.

Parameters

DBError	$exception
IDatabase \| null	$db	DB handle or null if connection failed
int	$shardIndex

Exceptions

Exception

Definition at line 909 of file SqlBagOStuff.php.

References markServerDown(), and setAndLogDBError().

Referenced by deleteAll(), deleteObjectsExpiringBefore(), doCas(), fetchBlobMulti(), incr(), lock(), modifyMulti(), and unlock().

◆ incr()

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

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) [optional]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 532 of file SqlBagOStuff.php.

References $tableName, getConnection(), getTableByKey(), handleWriteError(), MediumSpecificBagOStuff\isInteger(), and silenceTransactionProfiler().

Referenced by decr().

◆ initSqliteDatabase()

SqlBagOStuff::initSqliteDatabase ( IMaintainableDatabase $db )

private

Parameters

IMaintainableDatabase $db

Exceptions

DBError

Definition at line 959 of file SqlBagOStuff.php.

References Wikimedia\Rdbms\IDatabase\addIdentifierQuotes(), Wikimedia\Rdbms\IDatabase\endAtomic(), Wikimedia\Rdbms\IDatabase\query(), Wikimedia\Rdbms\IDatabase\rollback(), Wikimedia\Rdbms\IDatabase\startAtomic(), Wikimedia\Rdbms\IDatabase\tableExists(), Wikimedia\Rdbms\IMaintainableDatabase\tableName(), and Wikimedia\Rdbms\IDatabase\tablePrefix().

Referenced by getConnection().

◆ isExpired()

SqlBagOStuff::isExpired	(	IDatabase	$db,
			$exptime )

private

Parameters

IDatabase	$db
string	$exptime

Returns: bool

Definition at line 588 of file SqlBagOStuff.php.

References BagOStuff\getCurrentTime(), and getMaxDateTime().

Referenced by fetchBlobMulti().

◆ lock()

SqlBagOStuff::lock	(	$key,
		$timeout = 6,
		$expiry = 6,
		$rclass = '' )

Acquire an advisory lock on a key string.

Note that if reentry is enabled, duplicate calls ignore $expiry

Parameters

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

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 777 of file SqlBagOStuff.php.

References getConnection(), getTableByKey(), and handleWriteError().

◆ markServerDown()

SqlBagOStuff::markServerDown	(	DBError	$exception,
			$shardIndex )

private

Mark a server down due to a DBConnectionError exception.

Parameters

DBError	$exception
int	$shardIndex

Definition at line 937 of file SqlBagOStuff.php.

References BagOStuff\getCurrentTime().

Referenced by handleReadError(), and handleWriteError().

◆ modifyMulti()

SqlBagOStuff::modifyMulti	(	array	$data,
			$exptime,
			$flags,
			$op )

private

Parameters

mixed[] \| null[]	$data	Map of (key => new value or null)
int	$exptime	UNIX timestamp, TTL in seconds, or 0 (no expiration)
int	$flags	Bitfield of BagOStuff::WRITE_* constants
string	$op	Cache operation

Returns: bool

Definition at line 356 of file SqlBagOStuff.php.

References $tableName, BagOStuff\fieldHasFlags(), getConnection(), MediumSpecificBagOStuff\getExpirationAsTimestamp(), getMaxDateTime(), getTableByKey(), handleWriteError(), occasionallyGarbageCollect(), silenceTransactionProfiler(), updateTableKeys(), and waitForReplication().

Referenced by changeTTLMulti(), doAdd(), doChangeTTL(), doDelete(), doDeleteMulti(), doSet(), and doSetMulti().

◆ occasionallyGarbageCollect()

SqlBagOStuff::occasionallyGarbageCollect ( IDatabase $db )

private

Parameters

IDatabase $db

Exceptions

DBError

Definition at line 611 of file SqlBagOStuff.php.

References BagOStuff\$asyncHandler, deleteServerObjectsExpiringBefore(), and BagOStuff\getCurrentTime().

Referenced by modifyMulti().

◆ 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|int

Reimplemented from MediumSpecificBagOStuff.

Definition at line 851 of file SqlBagOStuff.php.

References serialize().

◆ setAndLogDBError()

SqlBagOStuff::setAndLogDBError ( DBError $exception )

private

Parameters

DBError $exception

Definition at line 920 of file SqlBagOStuff.php.

References IExpiringStore\ERR_UNEXPECTED, IExpiringStore\ERR_UNREACHABLE, and MediumSpecificBagOStuff\setLastError().

Referenced by handleReadError(), handleWriteError(), and waitForReplication().

◆ silenceTransactionProfiler()

SqlBagOStuff::silenceTransactionProfiler ( )

private

Silence the transaction profiler until the return value falls out of scope.

Returns: ScopedCallback|null

Definition at line 1047 of file SqlBagOStuff.php.

References usesMainDB().

Referenced by deleteAll(), deleteObjectsExpiringBefore(), doCas(), incr(), and modifyMulti().

◆ unlock()

SqlBagOStuff::unlock ( $key )

Release an advisory lock on a key string.

Parameters

string $key

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 812 of file SqlBagOStuff.php.

References getConnection(), getTableByKey(), and handleWriteError().

◆ unserialize()

SqlBagOStuff::unserialize ( $serial )

protected

Unserialize and, if necessary, decompress an object.

Parameters

string $serial

Returns: mixed

Reimplemented from MediumSpecificBagOStuff.

Definition at line 869 of file SqlBagOStuff.php.

References MediumSpecificBagOStuff\isInteger(), and unserialize().

Referenced by doGet(), doGetMulti(), and unserialize().

◆ updateTableKeys()

SqlBagOStuff::updateTableKeys	(	$op,
		$db,
		$table,
		$tableKeys,
		$data,
		$dbExpiry )

private

Parameters

string	$op
IDatabase	$db
string	$table
string[]	$tableKeys	Keys in $data to update
mixed[] \| null[]	$data	Map of (key => new value or null)
string	$dbExpiry	DB-encoded expiry

Returns: bool

Exceptions

DBError
InvalidArgumentException

Definition at line 416 of file SqlBagOStuff.php.

References $success, and serialize().

Referenced by modifyMulti().

◆ usesMainDB()

SqlBagOStuff::usesMainDB ( )

private

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

Definition at line 1004 of file SqlBagOStuff.php.

References $serverInfos.

Referenced by silenceTransactionProfiler(), and waitForReplication().

◆ waitForReplication()

SqlBagOStuff::waitForReplication ( )

private

Definition at line 1008 of file SqlBagOStuff.php.

References MediumSpecificBagOStuff\$busyCallbacks, MediumSpecificBagOStuff\$syncTimeout, setAndLogDBError(), and usesMainDB().

Referenced by doCas(), and modifyMulti().

Member Data Documentation

◆ $connFailureErrors

array SqlBagOStuff::$connFailureErrors = []

protected

Exceptions.

Definition at line 69 of file SqlBagOStuff.php.

◆ $connFailureTimes

array SqlBagOStuff::$connFailureTimes = []

protected

UNIX timestamps.

Definition at line 67 of file SqlBagOStuff.php.

◆ $conns

array SqlBagOStuff::$conns

protected

Definition at line 65 of file SqlBagOStuff.php.

◆ $GC_DELAY_SEC

int SqlBagOStuff::$GC_DELAY_SEC = 1

staticprivate

Definition at line 72 of file SqlBagOStuff.php.

◆ $lastGarbageCollect

int SqlBagOStuff::$lastGarbageCollect = 0

protected

UNIX timestamp.

Definition at line 50 of file SqlBagOStuff.php.

◆ $numServerShards

int SqlBagOStuff::$numServerShards

protected

Definition at line 48 of file SqlBagOStuff.php.

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

◆ $numTableShards

int SqlBagOStuff::$numTableShards = 1

Referenced by usesMainDB().

◆ $serverTags

string [] SqlBagOStuff::$serverTags

protected

(server index => tag/host name)

Definition at line 46 of file SqlBagOStuff.php.

Referenced by getTableByKey().

◆ $tableName

string SqlBagOStuff::$tableName = 'objectcache'

protected

Definition at line 58 of file SqlBagOStuff.php.

Referenced by doCas(), fetchBlobMulti(), getTableNameByShard(), incr(), and modifyMulti().

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

includes/objectcache/SqlBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ changeTTLMulti()

◆ createTables()

◆ decr()

◆ deleteAll()

◆ deleteObjectsExpiringBefore()

◆ deleteServerObjectsExpiringBefore()

◆ doAdd()

◆ doCas()

◆ doChangeTTL()

◆ doDelete()

◆ doDeleteMulti()

◆ doGet()

◆ doGetMulti()

◆ doSet()

◆ doSetMulti()

◆ expireAll()

◆ fetchBlobMulti()

◆ getConnection()

◆ getMaxDateTime()

◆ getTableByKey()

◆ getTableNameByShard()

◆ handleReadError()

◆ handleWriteError()

◆ incr()

◆ initSqliteDatabase()

◆ isExpired()

◆ lock()

◆ markServerDown()

◆ modifyMulti()

◆ occasionallyGarbageCollect()

◆ serialize()

◆ setAndLogDBError()

◆ silenceTransactionProfiler()

◆ unlock()

◆ unserialize()

◆ updateTableKeys()

◆ usesMainDB()

◆ waitForReplication()

Member Data Documentation

◆ $connFailureErrors

◆ $connFailureTimes

◆ $conns

◆ $GC_DELAY_SEC

◆ $lastGarbageCollect

◆ $numServerShards

◆ $numTableShards

◆ $OP_ADD

◆ $OP_DELETE

◆ $OP_SET

◆ $OP_TOUCH

◆ $purgeLimit

◆ $purgePeriod

◆ $replicaOnly

◆ $separateMainLB

◆ $serverInfos

◆ $serverTags

◆ $tableName