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

Inheritance diagram for SqlBagOStuff:

Collaboration diagram for SqlBagOStuff:

Public Member Functions
	__construct ($params)
	Constructor. More...

	createTables ()
	Create shard tables. More...

	delete ($key)

	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)

	incr ($key, $step=1)

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

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

	setMulti (array $data, $expiry=0)

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

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

	clearLastError ()
	Clear the "last error" registry. More...

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

	delete ($key)
	Delete an item. More...

	deleteObjectsExpiringBefore ($date, $progressCallback=false)
	Delete all objects expiring before a certain date. 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...

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

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

	incr ($key, $value=1)
	Increase stored value of $key by $value while preserving its TTL. 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 ()
	Make a global cache key. More...

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

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

	merge ($key, callable $callback, $exptime=0, $attempts=10, $flags=0)
	Merge changes into the existing cache value (possibly creating a new one) More...

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

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

	setDebug ($bool)

	setLogger (LoggerInterface $logger)

	setMulti (array $data, $exptime=0)
	Batch insertion. More...

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

Protected Member Functions
	cas ($casToken, $key, $value, $exptime=0)

	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, $serverIndex)
	Handle a DBQueryError which occurred during a write operation. More...

	isExpired ($db, $exptime)

	markServerDown ($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...

	waitForSlaves ()

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

	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)

	doGet ($key, $flags=0)

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

	isInteger ($value)
	Check if a value is an integer. 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

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

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

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

LoggerInterface	$logger

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	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_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

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().