3 namespace Wikimedia\Rdbms
;
5 use InvalidArgumentException
;
8 * Helper class to handle automatically marking connections as reusable (via RAII pattern)
9 * as well handling deferring the actual network connection until the handle is used
11 * @note: proxy methods are defined explicitly to avoid interface errors
15 class DBConnRef
implements IDatabase
{
16 /** @var ILoadBalancer */
18 /** @var Database|null Live connection handle */
20 /** @var array|null N-tuple of (server index, group, DatabaseDomain|string) */
29 * @param ILoadBalancer $lb Connection manager for $conn
30 * @param Database|array $conn Database handle or (server index, query groups, domain, flags)
32 public function __construct( ILoadBalancer
$lb, $conn ) {
34 if ( $conn instanceof Database
) {
35 $this->conn
= $conn; // live handle
36 } elseif ( is_array( $conn ) && count( $conn ) >= 4 && $conn[self
::FLD_DOMAIN
] !== false ) {
37 $this->params
= $conn;
39 throw new InvalidArgumentException( "Missing lazy connection arguments." );
43 function __call( $name, array $arguments ) {
44 if ( $this->conn
=== null ) {
45 list( $db, $groups, $wiki, $flags ) = $this->params
;
46 $this->conn
= $this->lb
->getConnection( $db, $groups, $wiki, $flags );
49 return $this->conn
->$name( ...$arguments );
52 public function getServerInfo() {
53 return $this->__call( __FUNCTION__
, func_get_args() );
56 public function bufferResults( $buffer = null ) {
57 return $this->__call( __FUNCTION__
, func_get_args() );
60 public function trxLevel() {
61 return $this->__call( __FUNCTION__
, func_get_args() );
64 public function trxTimestamp() {
65 return $this->__call( __FUNCTION__
, func_get_args() );
68 public function explicitTrxActive() {
69 return $this->__call( __FUNCTION__
, func_get_args() );
72 public function tablePrefix( $prefix = null ) {
73 return $this->__call( __FUNCTION__
, func_get_args() );
76 public function dbSchema( $schema = null ) {
77 return $this->__call( __FUNCTION__
, func_get_args() );
80 public function getLBInfo( $name = null ) {
81 return $this->__call( __FUNCTION__
, func_get_args() );
84 public function setLBInfo( $name, $value = null ) {
85 return $this->__call( __FUNCTION__
, func_get_args() );
88 public function setLazyMasterHandle( IDatabase
$conn ) {
89 return $this->__call( __FUNCTION__
, func_get_args() );
92 public function implicitGroupby() {
93 return $this->__call( __FUNCTION__
, func_get_args() );
96 public function implicitOrderby() {
97 return $this->__call( __FUNCTION__
, func_get_args() );
100 public function lastQuery() {
101 return $this->__call( __FUNCTION__
, func_get_args() );
104 public function doneWrites() {
105 return $this->__call( __FUNCTION__
, func_get_args() );
108 public function lastDoneWrites() {
109 return $this->__call( __FUNCTION__
, func_get_args() );
112 public function writesPending() {
113 return $this->__call( __FUNCTION__
, func_get_args() );
116 public function preCommitCallbacksPending() {
117 return $this->__call( __FUNCTION__
, func_get_args() );
120 public function writesOrCallbacksPending() {
121 return $this->__call( __FUNCTION__
, func_get_args() );
124 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
) {
125 return $this->__call( __FUNCTION__
, func_get_args() );
128 public function pendingWriteCallers() {
129 return $this->__call( __FUNCTION__
, func_get_args() );
132 public function pendingWriteRowsAffected() {
133 return $this->__call( __FUNCTION__
, func_get_args() );
136 public function isOpen() {
137 return $this->__call( __FUNCTION__
, func_get_args() );
140 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
141 return $this->__call( __FUNCTION__
, func_get_args() );
144 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
145 return $this->__call( __FUNCTION__
, func_get_args() );
148 public function restoreFlags( $state = self
::RESTORE_PRIOR
) {
149 return $this->__call( __FUNCTION__
, func_get_args() );
152 public function getFlag( $flag ) {
153 return $this->__call( __FUNCTION__
, func_get_args() );
156 public function getProperty( $name ) {
157 return $this->__call( __FUNCTION__
, func_get_args() );
160 public function getDomainID() {
161 if ( $this->conn
=== null ) {
162 $domain = $this->params
[self
::FLD_DOMAIN
];
163 // Avoid triggering a database connection
164 return $domain instanceof DatabaseDomain ?
$domain->getId() : $domain;
167 return $this->__call( __FUNCTION__
, func_get_args() );
171 * @codeCoverageIgnore
173 public function getWikiID() {
174 return $this->getDomainID();
177 public function getType() {
178 return $this->__call( __FUNCTION__
, func_get_args() );
181 public function fetchObject( $res ) {
182 return $this->__call( __FUNCTION__
, func_get_args() );
185 public function fetchRow( $res ) {
186 return $this->__call( __FUNCTION__
, func_get_args() );
189 public function numRows( $res ) {
190 return $this->__call( __FUNCTION__
, func_get_args() );
193 public function numFields( $res ) {
194 return $this->__call( __FUNCTION__
, func_get_args() );
197 public function fieldName( $res, $n ) {
198 return $this->__call( __FUNCTION__
, func_get_args() );
201 public function insertId() {
202 return $this->__call( __FUNCTION__
, func_get_args() );
205 public function dataSeek( $res, $row ) {
206 return $this->__call( __FUNCTION__
, func_get_args() );
209 public function lastErrno() {
210 return $this->__call( __FUNCTION__
, func_get_args() );
213 public function lastError() {
214 return $this->__call( __FUNCTION__
, func_get_args() );
217 public function affectedRows() {
218 return $this->__call( __FUNCTION__
, func_get_args() );
221 public function getSoftwareLink() {
222 return $this->__call( __FUNCTION__
, func_get_args() );
225 public function getServerVersion() {
226 return $this->__call( __FUNCTION__
, func_get_args() );
229 public function close() {
230 return $this->__call( __FUNCTION__
, func_get_args() );
233 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false ) {
234 return $this->__call( __FUNCTION__
, func_get_args() );
237 public function freeResult( $res ) {
238 return $this->__call( __FUNCTION__
, func_get_args() );
241 public function selectField(
242 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
244 return $this->__call( __FUNCTION__
, func_get_args() );
247 public function selectFieldValues(
248 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
250 return $this->__call( __FUNCTION__
, func_get_args() );
253 public function select(
254 $table, $vars, $conds = '', $fname = __METHOD__
,
255 $options = [], $join_conds = []
257 return $this->__call( __FUNCTION__
, func_get_args() );
260 public function selectSQLText(
261 $table, $vars, $conds = '', $fname = __METHOD__
,
262 $options = [], $join_conds = []
264 return $this->__call( __FUNCTION__
, func_get_args() );
267 public function selectRow(
268 $table, $vars, $conds, $fname = __METHOD__
,
269 $options = [], $join_conds = []
271 return $this->__call( __FUNCTION__
, func_get_args() );
274 public function estimateRowCount(
275 $table, $vars = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
277 return $this->__call( __FUNCTION__
, func_get_args() );
280 public function selectRowCount(
281 $tables, $vars = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
283 return $this->__call( __FUNCTION__
, func_get_args() );
286 public function lockForUpdate(
287 $table, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
289 return $this->__call( __FUNCTION__
, func_get_args() );
292 public function fieldExists( $table, $field, $fname = __METHOD__
) {
293 return $this->__call( __FUNCTION__
, func_get_args() );
296 public function indexExists( $table, $index, $fname = __METHOD__
) {
297 return $this->__call( __FUNCTION__
, func_get_args() );
300 public function tableExists( $table, $fname = __METHOD__
) {
301 return $this->__call( __FUNCTION__
, func_get_args() );
304 public function insert( $table, $a, $fname = __METHOD__
, $options = [] ) {
305 return $this->__call( __FUNCTION__
, func_get_args() );
308 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] ) {
309 return $this->__call( __FUNCTION__
, func_get_args() );
312 public function makeList( $a, $mode = self
::LIST_COMMA
) {
313 return $this->__call( __FUNCTION__
, func_get_args() );
316 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
317 return $this->__call( __FUNCTION__
, func_get_args() );
320 public function aggregateValue( $valuedata, $valuename = 'value' ) {
321 return $this->__call( __FUNCTION__
, func_get_args() );
324 public function bitNot( $field ) {
325 return $this->__call( __FUNCTION__
, func_get_args() );
328 public function bitAnd( $fieldLeft, $fieldRight ) {
329 return $this->__call( __FUNCTION__
, func_get_args() );
332 public function bitOr( $fieldLeft, $fieldRight ) {
333 return $this->__call( __FUNCTION__
, func_get_args() );
336 public function buildConcat( $stringList ) {
337 return $this->__call( __FUNCTION__
, func_get_args() );
340 public function buildGroupConcatField(
341 $delim, $table, $field, $conds = '', $join_conds = []
343 return $this->__call( __FUNCTION__
, func_get_args() );
346 public function buildSubstring( $input, $startPosition, $length = null ) {
347 return $this->__call( __FUNCTION__
, func_get_args() );
350 public function buildStringCast( $field ) {
351 return $this->__call( __FUNCTION__
, func_get_args() );
354 public function buildIntegerCast( $field ) {
355 return $this->__call( __FUNCTION__
, func_get_args() );
358 public function buildSelectSubquery(
359 $table, $vars, $conds = '', $fname = __METHOD__
,
360 $options = [], $join_conds = []
362 return $this->__call( __FUNCTION__
, func_get_args() );
365 public function databasesAreIndependent() {
366 return $this->__call( __FUNCTION__
, func_get_args() );
369 public function selectDB( $db ) {
370 // Disallow things that might confuse the LoadBalancer tracking
371 throw new DBUnexpectedError( $this, "Database selection is disallowed to enable reuse." );
374 public function getDBname() {
375 return $this->__call( __FUNCTION__
, func_get_args() );
378 public function getServer() {
379 return $this->__call( __FUNCTION__
, func_get_args() );
382 public function addQuotes( $s ) {
383 return $this->__call( __FUNCTION__
, func_get_args() );
386 public function buildLike() {
387 return $this->__call( __FUNCTION__
, func_get_args() );
390 public function anyChar() {
391 return $this->__call( __FUNCTION__
, func_get_args() );
394 public function anyString() {
395 return $this->__call( __FUNCTION__
, func_get_args() );
398 public function nextSequenceValue( $seqName ) {
399 return $this->__call( __FUNCTION__
, func_get_args() );
402 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
403 return $this->__call( __FUNCTION__
, func_get_args() );
406 public function upsert(
407 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
409 return $this->__call( __FUNCTION__
, func_get_args() );
412 public function deleteJoin(
413 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
415 return $this->__call( __FUNCTION__
, func_get_args() );
418 public function delete( $table, $conds, $fname = __METHOD__
) {
419 return $this->__call( __FUNCTION__
, func_get_args() );
422 public function insertSelect(
423 $destTable, $srcTable, $varMap, $conds,
424 $fname = __METHOD__
, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
426 return $this->__call( __FUNCTION__
, func_get_args() );
429 public function unionSupportsOrderAndLimit() {
430 return $this->__call( __FUNCTION__
, func_get_args() );
433 public function unionQueries( $sqls, $all ) {
434 return $this->__call( __FUNCTION__
, func_get_args() );
437 public function unionConditionPermutations(
438 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
439 $options = [], $join_conds = []
441 return $this->__call( __FUNCTION__
, func_get_args() );
444 public function conditional( $cond, $trueVal, $falseVal ) {
445 return $this->__call( __FUNCTION__
, func_get_args() );
448 public function strreplace( $orig, $old, $new ) {
449 return $this->__call( __FUNCTION__
, func_get_args() );
452 public function getServerUptime() {
453 return $this->__call( __FUNCTION__
, func_get_args() );
456 public function wasDeadlock() {
457 return $this->__call( __FUNCTION__
, func_get_args() );
460 public function wasLockTimeout() {
461 return $this->__call( __FUNCTION__
, func_get_args() );
464 public function wasConnectionLoss() {
465 return $this->__call( __FUNCTION__
, func_get_args() );
468 public function wasReadOnlyError() {
469 return $this->__call( __FUNCTION__
, func_get_args() );
472 public function wasErrorReissuable() {
473 return $this->__call( __FUNCTION__
, func_get_args() );
476 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
477 return $this->__call( __FUNCTION__
, func_get_args() );
480 public function getReplicaPos() {
481 return $this->__call( __FUNCTION__
, func_get_args() );
484 public function getMasterPos() {
485 return $this->__call( __FUNCTION__
, func_get_args() );
488 public function serverIsReadOnly() {
489 return $this->__call( __FUNCTION__
, func_get_args() );
492 public function onTransactionResolution( callable
$callback, $fname = __METHOD__
) {
493 return $this->__call( __FUNCTION__
, func_get_args() );
496 public function onTransactionCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
497 return $this->__call( __FUNCTION__
, func_get_args() );
500 public function onTransactionIdle( callable
$callback, $fname = __METHOD__
) {
501 return $this->__call( __FUNCTION__
, func_get_args() );
504 public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
505 return $this->__call( __FUNCTION__
, func_get_args() );
508 public function setTransactionListener( $name, callable
$callback = null ) {
509 return $this->__call( __FUNCTION__
, func_get_args() );
512 public function startAtomic(
513 $fname = __METHOD__
, $cancelable = IDatabase
::ATOMIC_NOT_CANCELABLE
515 return $this->__call( __FUNCTION__
, func_get_args() );
518 public function endAtomic( $fname = __METHOD__
) {
519 return $this->__call( __FUNCTION__
, func_get_args() );
522 public function cancelAtomic( $fname = __METHOD__
, AtomicSectionIdentifier
$sectionId = null ) {
523 return $this->__call( __FUNCTION__
, func_get_args() );
526 public function doAtomicSection(
527 $fname, callable
$callback, $cancelable = self
::ATOMIC_NOT_CANCELABLE
529 return $this->__call( __FUNCTION__
, func_get_args() );
532 public function begin( $fname = __METHOD__
, $mode = IDatabase
::TRANSACTION_EXPLICIT
) {
533 return $this->__call( __FUNCTION__
, func_get_args() );
536 public function commit( $fname = __METHOD__
, $flush = '' ) {
537 return $this->__call( __FUNCTION__
, func_get_args() );
540 public function rollback( $fname = __METHOD__
, $flush = '' ) {
541 return $this->__call( __FUNCTION__
, func_get_args() );
544 public function flushSnapshot( $fname = __METHOD__
) {
545 return $this->__call( __FUNCTION__
, func_get_args() );
548 public function timestamp( $ts = 0 ) {
549 return $this->__call( __FUNCTION__
, func_get_args() );
552 public function timestampOrNull( $ts = null ) {
553 return $this->__call( __FUNCTION__
, func_get_args() );
556 public function ping( &$rtt = null ) {
557 return func_num_args()
558 ?
$this->__call( __FUNCTION__
, [ &$rtt ] )
559 : $this->__call( __FUNCTION__
, [] ); // method cares about null vs missing
562 public function getLag() {
563 return $this->__call( __FUNCTION__
, func_get_args() );
566 public function getSessionLagStatus() {
567 return $this->__call( __FUNCTION__
, func_get_args() );
570 public function maxListLen() {
571 return $this->__call( __FUNCTION__
, func_get_args() );
574 public function encodeBlob( $b ) {
575 return $this->__call( __FUNCTION__
, func_get_args() );
578 public function decodeBlob( $b ) {
579 return $this->__call( __FUNCTION__
, func_get_args() );
582 public function setSessionOptions( array $options ) {
583 return $this->__call( __FUNCTION__
, func_get_args() );
586 public function setSchemaVars( $vars ) {
587 return $this->__call( __FUNCTION__
, func_get_args() );
590 public function lockIsFree( $lockName, $method ) {
591 return $this->__call( __FUNCTION__
, func_get_args() );
594 public function lock( $lockName, $method, $timeout = 5 ) {
595 return $this->__call( __FUNCTION__
, func_get_args() );
598 public function unlock( $lockName, $method ) {
599 return $this->__call( __FUNCTION__
, func_get_args() );
602 public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
603 return $this->__call( __FUNCTION__
, func_get_args() );
606 public function namedLocksEnqueue() {
607 return $this->__call( __FUNCTION__
, func_get_args() );
610 public function getInfinity() {
611 return $this->__call( __FUNCTION__
, func_get_args() );
614 public function encodeExpiry( $expiry ) {
615 return $this->__call( __FUNCTION__
, func_get_args() );
618 public function decodeExpiry( $expiry, $format = TS_MW
) {
619 return $this->__call( __FUNCTION__
, func_get_args() );
622 public function setBigSelects( $value = true ) {
623 return $this->__call( __FUNCTION__
, func_get_args() );
626 public function isReadOnly() {
627 return $this->__call( __FUNCTION__
, func_get_args() );
630 public function setTableAliases( array $aliases ) {
631 return $this->__call( __FUNCTION__
, func_get_args() );
634 public function setIndexAliases( array $aliases ) {
635 return $this->__call( __FUNCTION__
, func_get_args() );
639 * Clean up the connection when out of scope
641 function __destruct() {
643 $this->lb
->reuseConnection( $this->conn
);
650 * @deprecated since 1.29
652 class_alias( DBConnRef
::class, 'DBConnRef' );