RDBMS-based caching module. More...

Inherits Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Collaboration diagram for SqlBagOStuff:

[legend]

Public Member Functions

__construct ( $params)

Create a new backend instance from parameters injected by ObjectCache::newFromParams()

createTables ()

Create the shard tables on all databases.

deleteObjectsExpiringBefore ( $timestamp, ?callable $progress=null, $limit=INF, ?string $tag=null)

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 \| float	$limit	Maximum number of keys to delete [default: INF]
string \| null	$tag	Tag to purge a single shard only. This is only supported when server tags are used in configuration.

Returns: bool Success; false if unimplemented

doChangeTTLMulti (array $keys, $exptime, $flags=0)

Parameters

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

Returns: bool Success

doLock ( $key, $timeout=6, $exptime=6)

See also: MediumSpecificBagOStuff::lock()

Parameters

string	$key
int	$timeout	Lock wait timeout; 0 for non-blocking [optional]
int	$exptime	Lock time-to-live 1 day maximum [optional]

Returns: float|null UNIX timestamp of acquisition; null on failure

doUnlock ( $key)

See also: MediumSpecificBagOStuff::unlock()

Parameters

string $key

Returns: bool Success

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.

Parameters

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

Returns: bool Success (item created)

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.For large values set with WRITE_ALLOW_SEGMENTS, this only deletes the placeholder key with the segment list. To delete the underlying blobs, include WRITE_ALLOW_SEGMENTS in the flags for delete() as well. While deleting the segment list key has the effect of functionally deleting the key, it leaves unused blobs in storage.The reason that this is not done automatically, is that to delete underlying blobs, requires first fetching the current segment list. Given that 99% of keys don't use WRITE_ALLOW_SEGMENTS, this would be wasteful.

Parameters

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

Returns: bool Success (item deleted or not found)

deleteMulti (array $keys, $flags=0)

Delete a batch of items.This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/OWRITE_BACKGROUND can be used for bulk deletion where the response is not vital

Parameters

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

Returns: bool Success (items deleted and/or not found)

Since: 1.33

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)

Parameters

int $flag BagOStuff::ATTR_* constant

Returns: int BagOStuff:QOS_* constant

Since: 1.28

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.This will create the key with the value $init and TTL $exptime instead if not present. Callers should make sure that both ($init - $step) and $exptime are invariants for all operations to any given key. The value of $init should be at least that of $step.The new value is returned, except if the WRITE_BACKGROUND flag is given, in which case the handler may choose to return true to indicate that the operation has been dispatched.

Parameters

string	$key	Key built via makeKey() or makeGlobalKey()
int	$exptime	Time-to-live (in seconds) or a UNIX timestamp expiration
int	$step	Amount to increase the key value by [default: 1]
int \| null	$init	Value to initialize the key to if it does not exist [default: $step]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value (or true if asynchronous) on success; false on failure

Since: 1.24

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.

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 If setting WRITE_ALLOW_SEGMENTS, remember to also set it in any delete() calls.

Returns: bool Success

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

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.

Parameters

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

Returns: bool Success

doCas ( $casToken, $key, $value, $exptime=0, $flags=0)

Set an item if the current CAS token matches the provided CAS token.

Parameters

mixed	$casToken	CAS token from an existing version of the key
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

doChangeTTL ( $key, $exptime, $flags)

Parameters

string	$key
int	$exptime
int	$flags

Returns: bool

doDelete ( $key, $flags=0)

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

doDeleteMulti (array $keys, $flags=0)

Parameters

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

Returns: bool Success

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

Get an item.The CAS token should be null if the key does not exist or the value is corrupt

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
mixed	&$casToken	CAS token if MediumSpecificBagOStuff::PASS_BY_REF [returned]

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

doGetMulti (array $keys, $flags=0)

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; preserves the order of $keys

doIncrWithInit ( $key, $exptime, $step, $init, $flags)

Parameters

string	$key
int	$exptime
int	$step
int	$init
int	$flags

Returns: int|bool New value or false on failure

doSet ( $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

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

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

makeKeyInternal ( $keyspace, $components)

Make a cache key for the given keyspace and components.Subclasses may override this method to apply different escaping, or to deal with size constraints (such as MemcachedBagOStuff). For example, by converting long components into hashes.If you override this method, you MUST override requireConvertGenericKey() to return true. This ensures that wrapping classes (e.g. MultiWriteBagOStuff) know to re-encode keys before calling read/write methods. See also proxyCall().

See also: BagOStuff::proxyCall

Since: 1.27

Parameters

string	$keyspace
string[] \| int[] \| null[]	$components	Key group and other components

Returns: string

requireConvertGenericKey ()

Whether ::proxyCall() must re-encode cache keys before calling read/write methods.

serialize ( $value)

Parameters

mixed $value

Returns: string|int|false String/integer representation

Note: Special handling is usually needed for integers so incr()/decr() work

unserialize ( $value)

Parameters

string | int | false $value

Returns: mixed Original value or false on error

Note: Special handling is usually needed for integers so incr()/decr() work

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)

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.

tokensMatch ( $value, $otherValue)

updateOpStats (string $op, array $keyInfo)

Protected Member Functions inherited from Wikimedia\ObjectCache\BagOStuff

fieldHasFlags ( $field, $flags)

makeFallbackKey (string $key, int $maxLength)

Re-format a cache key that is too long.

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.

setLastError ( $error)

Set the "last error" registry due to a problem encountered during an attempted operation.

Protected Attributes
DBConnectionError[]	$connFailureErrors = []
	Map of (shard index => Exception)

float[]	$connFailureTimes = []
	Map of (shard index => UNIX timestamps)

IMaintainableDatabase[]	$conns
	Map of (shard index => DB handle)

string false null	$dbDomain
	DB name used for keys using the LoadBalancer.

float	$lastGarbageCollect = 0
	UNIX timestamp.

ILoadBalancer null	$loadBalancer

callable null	$loadBalancerCallback
	Injected function which returns a LoadBalancer.

int	$numTableShards = 1
	Number of table shards to use on each server.

int	$purgeLimit = 100
	Max expired rows to purge during randomized garbage collection.

int	$purgePeriod = 10
	Average number of writes required to trigger garbage collection.

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

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

string	$tableName = 'objectcache'

bool	$useLB = false
	Whether to use the LoadBalancer.

int	$writeBatchSize = 100

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	ATTR_DURABILITY = 2
	Key in getQoS() for durability of storage writes.

const	ERR_NO_RESPONSE = 1
	Storage operation failed to yield a complete response.

const	ERR_NONE = 0
	Storage operation succeeded, or no operation was performed.

const	ERR_UNEXPECTED = 3
	Storage operation failed due to usage limitations or an I/O error.

const	ERR_UNREACHABLE = 2
	Storage operation could not establish a connection.

const	MAX_CONFLICTS_ONE = 1
	Abort after the first merge conflict.

const	QOS_DURABILITY_DISK = 4
	Storage survives on disk on a best-effort basis (e.g.

const	QOS_DURABILITY_NONE = 1
	Storage is disabled or never saves data, not even temporarily (EmptyBagOStuff).

const	QOS_DURABILITY_RDBMS = 5
	Storage survives on disk with high availability (SqlBagOStuff).

const	QOS_DURABILITY_SCRIPT = 2
	Storage survives in memory until the end of the current request or CLI process (HashBagOStuff).

const	QOS_DURABILITY_SERVICE = 3
	Storage survives in memory until a shared service is restarted (e.g.

const	QOS_UNKNOWN = INF
	Generic "unknown" value; useful for comparisons (always "good enough")

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.

Static Protected Attributes inherited from Wikimedia\ObjectCache\BagOStuff
static int	$nextErrorMonitorId = 1
	Next sequence number to use for watch/error events.

Detailed Description

RDBMS-based caching module.

The following database sharding schemes are supported:

None; all keys map to the same shard
Hash; keys map to shards via consistent hashing

The following database replication topologies are supported:

A primary database server for each shard, all within one datacenter
A co-primary database server for each shard within each datacenter

Definition at line 41 of file SqlBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

SqlBagOStuff::__construct ( $params )

Create a new backend instance from parameters injected by ObjectCache::newFromParams()

The database servers must be provided by either the "server" parameter, the "servers" parameter or the "loadBalancer" parameter.

The parameters are as described at \\MediaWiki\\MainConfigSchema::ObjectCaches except that:

the configured "cluster" and main LB fallback modes are implemented by the wiring by passing "loadBalancerCallback".
"dbDomain" is required if "loadBalancerCallback" is set, whereas in config it may be absent.

Access: internal

Parameters

array

$params

server: string
servers: string[]
loadBalancerCallback: A closure which provides a LoadBalancer object
- dbDomain: string|false
purgePeriod: int|float
purgeLimit: int
tableName: string
shards: int
writeBatchSize: int

Definition at line 131 of file SqlBagOStuff.php.

Member Function Documentation

◆ createTables()

SqlBagOStuff::createTables ( )

Create the shard tables on all databases.

Note: This method is typically called manually by a sysadmin via eval.php, e.g. for ParserCache:

$objectCacheFactory = MW::srv()->getObjectCacheFactory();

$objectCacheFactory->getInstance( 'myparsercache' )->createTables();

This is different from $services->getParserCache()->getCacheStorage()->createTables(), which would use the backend set via $wgParserCacheType, which shouldn't be set yet for the backend you are creating shard tables on. The expectation is to first add the new backend to $wgObjectCaches, run the above, and then enable it for live ParserCache traffic by setting $wgParserCacheType.

Definition at line 1671 of file SqlBagOStuff.php.

References Wikimedia\Rdbms\IReadableDatabase\getType(), Wikimedia\Rdbms\IDatabase\query(), and Wikimedia\Rdbms\Platform\ISQLPlatform\tableName().

◆ deleteObjectsExpiringBefore()

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

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 \| float	$limit	Maximum number of keys to delete [default: INF]
string \| null	$tag	Tag to purge a single shard only. This is only supported when server tags are used in configuration.

Returns: bool Success; false if unimplemented

Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 1266 of file SqlBagOStuff.php.

References Wikimedia\Rdbms\IDatabase\lock(), and Wikimedia\Rdbms\IDatabase\unlock().

◆ 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 Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 216 of file SqlBagOStuff.php.

◆ doCas()

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

protected

Set an item if the current CAS token matches the provided CAS token.

Parameters

mixed	$casToken	CAS token from an existing version of the key
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 Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 231 of file SqlBagOStuff.php.

◆ doChangeTTL()

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

protected

Parameters

string	$key
int	$exptime
int	$flags

Returns: bool

Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 246 of file SqlBagOStuff.php.

References Wikimedia\ObjectCache\BagOStuff\getCurrentTime().

◆ doChangeTTLMulti()

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

Parameters

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

Returns: bool Success

Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 330 of file SqlBagOStuff.php.

References Wikimedia\ObjectCache\BagOStuff\getCurrentTime().

◆ 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 Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 205 of file SqlBagOStuff.php.

References Wikimedia\ObjectCache\BagOStuff\getCurrentTime().

◆ 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 Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 319 of file SqlBagOStuff.php.

References Wikimedia\ObjectCache\BagOStuff\getCurrentTime().

◆ doGet()

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

protected

Get an item.The CAS token should be null if the key does not exist or the value is corrupt

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
mixed	&$casToken	CAS token if MediumSpecificBagOStuff::PASS_BY_REF [returned]

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

Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 172 of file SqlBagOStuff.php.

References unserialize(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().

◆ 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; preserves the order of $keys

Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 277 of file SqlBagOStuff.php.

References unserialize(), and Wikimedia\ObjectCache\MediumSpecificBagOStuff\updateOpStats().

◆ doIncrWithInit()

SqlBagOStuff::doIncrWithInit	(	$key,
		$exptime,
		$step,
		$init,
		$flags )

protected

Parameters

string	$key
int	$exptime
int	$step
int	$init
int	$flags

Returns: int|bool New value or false on failure

Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 257 of file SqlBagOStuff.php.

References Wikimedia\ObjectCache\BagOStuff\getCurrentTime().

◆ doLock()

SqlBagOStuff::doLock	(	$key,
		$timeout = 6,
		$exptime = 6 )

See also: MediumSpecificBagOStuff::lock()

Parameters

string	$key
int	$timeout	Lock wait timeout; 0 for non-blocking [optional]
int	$exptime	Lock time-to-live 1 day maximum [optional]

Returns: float|null UNIX timestamp of acquisition; null on failure

Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 1428 of file SqlBagOStuff.php.

References Wikimedia\Rdbms\IDatabase\lock().

◆ 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 Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 194 of file SqlBagOStuff.php.

References Wikimedia\ObjectCache\BagOStuff\getCurrentTime().

◆ 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 Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 303 of file SqlBagOStuff.php.

References Wikimedia\ObjectCache\BagOStuff\getCurrentTime().

◆ doUnlock()

SqlBagOStuff::doUnlock ( $key )

See also: MediumSpecificBagOStuff::unlock()

Parameters

string $key

Returns: bool Success

Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 1452 of file SqlBagOStuff.php.

References Wikimedia\Rdbms\IDatabase\unlock().

◆ makeKeyInternal()

SqlBagOStuff::makeKeyInternal	(		$keyspace,
			$components )

protected

Make a cache key for the given keyspace and components.Subclasses may override this method to apply different escaping, or to deal with size constraints (such as MemcachedBagOStuff). For example, by converting long components into hashes.If you override this method, you MUST override requireConvertGenericKey() to return true. This ensures that wrapping classes (e.g. MultiWriteBagOStuff) know to re-encode keys before calling read/write methods. See also proxyCall().

See also: BagOStuff::proxyCall

Since: 1.27

Parameters

string	$keyspace
string[] \| int[] \| null[]	$components	Key group and other components

Returns: string

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 1472 of file SqlBagOStuff.php.

References Wikimedia\ObjectCache\BagOStuff\$keyspace, and Wikimedia\ObjectCache\BagOStuff\makeFallbackKey().

◆ requireConvertGenericKey()

SqlBagOStuff::requireConvertGenericKey ( )

protected

Whether ::proxyCall() must re-encode cache keys before calling read/write methods.

Stability: stable: to override

See also: BagOStuff::makeKeyInternal; BagOStuff::proxyCall

Since: 1.41

Returns: bool

Reimplemented from Wikimedia\ObjectCache\BagOStuff.

Definition at line 1487 of file SqlBagOStuff.php.

◆ serialize()

SqlBagOStuff::serialize ( $value )

protected

Parameters

mixed $value

Returns: string|int|false String/integer representation

Note: Special handling is usually needed for integers so incr()/decr() work

Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 1492 of file SqlBagOStuff.php.

◆ unserialize()

SqlBagOStuff::unserialize ( $value )

protected

Parameters

string | int | false $value

Returns: mixed Original value or false on error

Note: Special handling is usually needed for integers so incr()/decr() work

Reimplemented from Wikimedia\ObjectCache\MediumSpecificBagOStuff.

Definition at line 1507 of file SqlBagOStuff.php.

Referenced by doGet(), and doGetMulti().

Member Data Documentation

◆ $connFailureErrors

DBConnectionError [] SqlBagOStuff::$connFailureErrors = []

protected

Map of (shard index => Exception)

Definition at line 73 of file SqlBagOStuff.php.

◆ $connFailureTimes

float [] SqlBagOStuff::$connFailureTimes = []

protected

Map of (shard index => UNIX timestamps)

Definition at line 71 of file SqlBagOStuff.php.

◆ $conns

IMaintainableDatabase [] SqlBagOStuff::$conns

protected

Map of (shard index => DB handle)

Definition at line 69 of file SqlBagOStuff.php.

◆ $dbDomain

string false null SqlBagOStuff::$dbDomain

protected

DB name used for keys using the LoadBalancer.

Definition at line 47 of file SqlBagOStuff.php.

◆ $lastGarbageCollect

float SqlBagOStuff::$lastGarbageCollect = 0

protected

UNIX timestamp.

Definition at line 56 of file SqlBagOStuff.php.

◆ $loadBalancer

ILoadBalancer null SqlBagOStuff::$loadBalancer

protected

Definition at line 45 of file SqlBagOStuff.php.

◆ $loadBalancerCallback

callable null SqlBagOStuff::$loadBalancerCallback

protected

Injected function which returns a LoadBalancer.

Definition at line 43 of file SqlBagOStuff.php.

◆ $numTableShards

int SqlBagOStuff::$numTableShards = 1

protected

Number of table shards to use on each server.

Definition at line 62 of file SqlBagOStuff.php.

◆ $purgeLimit

int SqlBagOStuff::$purgeLimit = 100

protected

Max expired rows to purge during randomized garbage collection.

Definition at line 60 of file SqlBagOStuff.php.

◆ $purgePeriod

int SqlBagOStuff::$purgePeriod = 10

protected

Average number of writes required to trigger garbage collection.

Definition at line 58 of file SqlBagOStuff.php.

◆ $serverInfos

array [] SqlBagOStuff::$serverInfos = []

protected

(server index => server config)

Definition at line 52 of file SqlBagOStuff.php.

◆ $serverTags

string [] SqlBagOStuff::$serverTags = []

protected

(server index => tag/host name)

Definition at line 54 of file SqlBagOStuff.php.

◆ $tableName

string SqlBagOStuff::$tableName = 'objectcache'

protected

Definition at line 66 of file SqlBagOStuff.php.

◆ $useLB

bool SqlBagOStuff::$useLB = false

protected

Whether to use the LoadBalancer.

Definition at line 49 of file SqlBagOStuff.php.

◆ $writeBatchSize

int SqlBagOStuff::$writeBatchSize = 100

protected

Definition at line 64 of file SqlBagOStuff.php.

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

◆ createTables()

◆ deleteObjectsExpiringBefore()

◆ doAdd()

◆ doCas()

◆ doChangeTTL()

◆ doChangeTTLMulti()

◆ doDelete()

◆ doDeleteMulti()

◆ doGet()

◆ doGetMulti()

◆ doIncrWithInit()

◆ doLock()

◆ doSet()

◆ doSetMulti()

◆ doUnlock()

◆ makeKeyInternal()

◆ requireConvertGenericKey()

◆ serialize()

◆ unserialize()

Member Data Documentation

◆ $connFailureErrors

◆ $connFailureTimes

◆ $conns

◆ $dbDomain

◆ $lastGarbageCollect

◆ $loadBalancer

◆ $loadBalancerCallback

◆ $numTableShards

◆ $purgeLimit

◆ $purgePeriod

◆ $serverInfos

◆ $serverTags

◆ $tableName

◆ $useLB

◆ $writeBatchSize