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 assertNoOpenTransactions() {
73 return $this->__call( __FUNCTION__
, func_get_args() );
76 public function tablePrefix( $prefix = null ) {
77 // Disallow things that might confuse the LoadBalancer tracking
78 throw new DBUnexpectedError( $this, "Database selection is disallowed to enable reuse." );
81 public function dbSchema( $schema = null ) {
82 // Disallow things that might confuse the LoadBalancer tracking
83 throw new DBUnexpectedError( $this, "Database selection is disallowed to enable reuse." );
86 public function getLBInfo( $name = null ) {
87 return $this->__call( __FUNCTION__
, func_get_args() );
90 public function setLBInfo( $name, $value = null ) {
91 // Disallow things that might confuse the LoadBalancer tracking
92 throw new DBUnexpectedError( $this, "Changing LB info is disallowed to enable reuse." );
95 public function setLazyMasterHandle( IDatabase
$conn ) {
96 // Disallow things that might confuse the LoadBalancer tracking
97 throw new DBUnexpectedError( $this, "Database injection is disallowed to enable reuse." );
100 public function implicitGroupby() {
101 return $this->__call( __FUNCTION__
, func_get_args() );
104 public function implicitOrderby() {
105 return $this->__call( __FUNCTION__
, func_get_args() );
108 public function lastQuery() {
109 return $this->__call( __FUNCTION__
, func_get_args() );
112 public function doneWrites() {
113 return $this->__call( __FUNCTION__
, func_get_args() );
116 public function lastDoneWrites() {
117 return $this->__call( __FUNCTION__
, func_get_args() );
120 public function writesPending() {
121 return $this->__call( __FUNCTION__
, func_get_args() );
124 public function preCommitCallbacksPending() {
125 return $this->__call( __FUNCTION__
, func_get_args() );
128 public function writesOrCallbacksPending() {
129 return $this->__call( __FUNCTION__
, func_get_args() );
132 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
) {
133 return $this->__call( __FUNCTION__
, func_get_args() );
136 public function pendingWriteCallers() {
137 return $this->__call( __FUNCTION__
, func_get_args() );
140 public function pendingWriteRowsAffected() {
141 return $this->__call( __FUNCTION__
, func_get_args() );
144 public function isOpen() {
145 return $this->__call( __FUNCTION__
, func_get_args() );
148 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
149 return $this->__call( __FUNCTION__
, func_get_args() );
152 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
153 return $this->__call( __FUNCTION__
, func_get_args() );
156 public function restoreFlags( $state = self
::RESTORE_PRIOR
) {
157 return $this->__call( __FUNCTION__
, func_get_args() );
160 public function getFlag( $flag ) {
161 return $this->__call( __FUNCTION__
, func_get_args() );
164 public function getProperty( $name ) {
165 return $this->__call( __FUNCTION__
, func_get_args() );
168 public function getDomainID() {
169 if ( $this->conn
=== null ) {
170 $domain = $this->params
[self
::FLD_DOMAIN
];
171 // Avoid triggering a database connection
172 return $domain instanceof DatabaseDomain ?
$domain->getId() : $domain;
175 return $this->__call( __FUNCTION__
, func_get_args() );
179 * @codeCoverageIgnore
181 public function getWikiID() {
182 return $this->getDomainID();
185 public function getType() {
186 return $this->__call( __FUNCTION__
, func_get_args() );
189 public function fetchObject( $res ) {
190 return $this->__call( __FUNCTION__
, func_get_args() );
193 public function fetchRow( $res ) {
194 return $this->__call( __FUNCTION__
, func_get_args() );
197 public function numRows( $res ) {
198 return $this->__call( __FUNCTION__
, func_get_args() );
201 public function numFields( $res ) {
202 return $this->__call( __FUNCTION__
, func_get_args() );
205 public function fieldName( $res, $n ) {
206 return $this->__call( __FUNCTION__
, func_get_args() );
209 public function insertId() {
210 return $this->__call( __FUNCTION__
, func_get_args() );
213 public function dataSeek( $res, $row ) {
214 return $this->__call( __FUNCTION__
, func_get_args() );
217 public function lastErrno() {
218 return $this->__call( __FUNCTION__
, func_get_args() );
221 public function lastError() {
222 return $this->__call( __FUNCTION__
, func_get_args() );
225 public function affectedRows() {
226 return $this->__call( __FUNCTION__
, func_get_args() );
229 public function getSoftwareLink() {
230 return $this->__call( __FUNCTION__
, func_get_args() );
233 public function getServerVersion() {
234 return $this->__call( __FUNCTION__
, func_get_args() );
237 public function close() {
238 return $this->__call( __FUNCTION__
, func_get_args() );
241 public function query( $sql, $fname = __METHOD__
, $flags = 0 ) {
242 return $this->__call( __FUNCTION__
, func_get_args() );
245 public function freeResult( $res ) {
246 return $this->__call( __FUNCTION__
, func_get_args() );
249 public function selectField(
250 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
252 return $this->__call( __FUNCTION__
, func_get_args() );
255 public function selectFieldValues(
256 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
258 return $this->__call( __FUNCTION__
, func_get_args() );
261 public function select(
262 $table, $vars, $conds = '', $fname = __METHOD__
,
263 $options = [], $join_conds = []
265 return $this->__call( __FUNCTION__
, func_get_args() );
268 public function selectSQLText(
269 $table, $vars, $conds = '', $fname = __METHOD__
,
270 $options = [], $join_conds = []
272 return $this->__call( __FUNCTION__
, func_get_args() );
275 public function selectRow(
276 $table, $vars, $conds, $fname = __METHOD__
,
277 $options = [], $join_conds = []
279 return $this->__call( __FUNCTION__
, func_get_args() );
282 public function estimateRowCount(
283 $table, $vars = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
285 return $this->__call( __FUNCTION__
, func_get_args() );
288 public function selectRowCount(
289 $tables, $vars = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
291 return $this->__call( __FUNCTION__
, func_get_args() );
294 public function lockForUpdate(
295 $table, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
297 return $this->__call( __FUNCTION__
, func_get_args() );
300 public function fieldExists( $table, $field, $fname = __METHOD__
) {
301 return $this->__call( __FUNCTION__
, func_get_args() );
304 public function indexExists( $table, $index, $fname = __METHOD__
) {
305 return $this->__call( __FUNCTION__
, func_get_args() );
308 public function tableExists( $table, $fname = __METHOD__
) {
309 return $this->__call( __FUNCTION__
, func_get_args() );
312 public function insert( $table, $a, $fname = __METHOD__
, $options = [] ) {
313 return $this->__call( __FUNCTION__
, func_get_args() );
316 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] ) {
317 return $this->__call( __FUNCTION__
, func_get_args() );
320 public function makeList( $a, $mode = self
::LIST_COMMA
) {
321 return $this->__call( __FUNCTION__
, func_get_args() );
324 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
325 return $this->__call( __FUNCTION__
, func_get_args() );
328 public function aggregateValue( $valuedata, $valuename = 'value' ) {
329 return $this->__call( __FUNCTION__
, func_get_args() );
332 public function bitNot( $field ) {
333 return $this->__call( __FUNCTION__
, func_get_args() );
336 public function bitAnd( $fieldLeft, $fieldRight ) {
337 return $this->__call( __FUNCTION__
, func_get_args() );
340 public function bitOr( $fieldLeft, $fieldRight ) {
341 return $this->__call( __FUNCTION__
, func_get_args() );
344 public function buildConcat( $stringList ) {
345 return $this->__call( __FUNCTION__
, func_get_args() );
348 public function buildGroupConcatField(
349 $delim, $table, $field, $conds = '', $join_conds = []
351 return $this->__call( __FUNCTION__
, func_get_args() );
354 public function buildSubstring( $input, $startPosition, $length = null ) {
355 return $this->__call( __FUNCTION__
, func_get_args() );
358 public function buildStringCast( $field ) {
359 return $this->__call( __FUNCTION__
, func_get_args() );
362 public function buildIntegerCast( $field ) {
363 return $this->__call( __FUNCTION__
, func_get_args() );
366 public function buildSelectSubquery(
367 $table, $vars, $conds = '', $fname = __METHOD__
,
368 $options = [], $join_conds = []
370 return $this->__call( __FUNCTION__
, func_get_args() );
373 public function databasesAreIndependent() {
374 return $this->__call( __FUNCTION__
, func_get_args() );
377 public function selectDB( $db ) {
378 // Disallow things that might confuse the LoadBalancer tracking
379 throw new DBUnexpectedError( $this, "Database selection is disallowed to enable reuse." );
382 public function selectDomain( $domain ) {
383 // Disallow things that might confuse the LoadBalancer tracking
384 throw new DBUnexpectedError( $this, "Database selection is disallowed to enable reuse." );
387 public function getDBname() {
388 return $this->__call( __FUNCTION__
, func_get_args() );
391 public function getServer() {
392 return $this->__call( __FUNCTION__
, func_get_args() );
395 public function addQuotes( $s ) {
396 return $this->__call( __FUNCTION__
, func_get_args() );
399 public function addIdentifierQuotes( $s ) {
400 return $this->__call( __FUNCTION__
, func_get_args() );
403 public function buildLike() {
404 return $this->__call( __FUNCTION__
, func_get_args() );
407 public function anyChar() {
408 return $this->__call( __FUNCTION__
, func_get_args() );
411 public function anyString() {
412 return $this->__call( __FUNCTION__
, func_get_args() );
415 public function nextSequenceValue( $seqName ) {
416 return $this->__call( __FUNCTION__
, func_get_args() );
419 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
420 return $this->__call( __FUNCTION__
, func_get_args() );
423 public function upsert(
424 $table, array $rows, $uniqueIndexes, array $set, $fname = __METHOD__
426 return $this->__call( __FUNCTION__
, func_get_args() );
429 public function deleteJoin(
430 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
432 return $this->__call( __FUNCTION__
, func_get_args() );
435 public function delete( $table, $conds, $fname = __METHOD__
) {
436 return $this->__call( __FUNCTION__
, func_get_args() );
439 public function insertSelect(
440 $destTable, $srcTable, $varMap, $conds,
441 $fname = __METHOD__
, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
443 return $this->__call( __FUNCTION__
, func_get_args() );
446 public function unionSupportsOrderAndLimit() {
447 return $this->__call( __FUNCTION__
, func_get_args() );
450 public function unionQueries( $sqls, $all ) {
451 return $this->__call( __FUNCTION__
, func_get_args() );
454 public function unionConditionPermutations(
455 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
456 $options = [], $join_conds = []
458 return $this->__call( __FUNCTION__
, func_get_args() );
461 public function conditional( $cond, $trueVal, $falseVal ) {
462 return $this->__call( __FUNCTION__
, func_get_args() );
465 public function strreplace( $orig, $old, $new ) {
466 return $this->__call( __FUNCTION__
, func_get_args() );
469 public function getServerUptime() {
470 return $this->__call( __FUNCTION__
, func_get_args() );
473 public function wasDeadlock() {
474 return $this->__call( __FUNCTION__
, func_get_args() );
477 public function wasLockTimeout() {
478 return $this->__call( __FUNCTION__
, func_get_args() );
481 public function wasConnectionLoss() {
482 return $this->__call( __FUNCTION__
, func_get_args() );
485 public function wasReadOnlyError() {
486 return $this->__call( __FUNCTION__
, func_get_args() );
489 public function wasErrorReissuable() {
490 return $this->__call( __FUNCTION__
, func_get_args() );
493 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
494 return $this->__call( __FUNCTION__
, func_get_args() );
497 public function getReplicaPos() {
498 return $this->__call( __FUNCTION__
, func_get_args() );
501 public function getMasterPos() {
502 return $this->__call( __FUNCTION__
, func_get_args() );
505 public function serverIsReadOnly() {
506 return $this->__call( __FUNCTION__
, func_get_args() );
509 public function onTransactionResolution( callable
$callback, $fname = __METHOD__
) {
510 return $this->__call( __FUNCTION__
, func_get_args() );
513 public function onTransactionCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
514 return $this->__call( __FUNCTION__
, func_get_args() );
517 public function onTransactionIdle( callable
$callback, $fname = __METHOD__
) {
518 return $this->__call( __FUNCTION__
, func_get_args() );
521 public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
522 return $this->__call( __FUNCTION__
, func_get_args() );
525 public function setTransactionListener( $name, callable
$callback = null ) {
526 return $this->__call( __FUNCTION__
, func_get_args() );
529 public function startAtomic(
530 $fname = __METHOD__
, $cancelable = IDatabase
::ATOMIC_NOT_CANCELABLE
532 return $this->__call( __FUNCTION__
, func_get_args() );
535 public function endAtomic( $fname = __METHOD__
) {
536 return $this->__call( __FUNCTION__
, func_get_args() );
539 public function cancelAtomic( $fname = __METHOD__
, AtomicSectionIdentifier
$sectionId = null ) {
540 return $this->__call( __FUNCTION__
, func_get_args() );
543 public function doAtomicSection(
544 $fname, callable
$callback, $cancelable = self
::ATOMIC_NOT_CANCELABLE
546 return $this->__call( __FUNCTION__
, func_get_args() );
549 public function begin( $fname = __METHOD__
, $mode = IDatabase
::TRANSACTION_EXPLICIT
) {
550 return $this->__call( __FUNCTION__
, func_get_args() );
553 public function commit( $fname = __METHOD__
, $flush = '' ) {
554 return $this->__call( __FUNCTION__
, func_get_args() );
557 public function rollback( $fname = __METHOD__
, $flush = '' ) {
558 return $this->__call( __FUNCTION__
, func_get_args() );
561 public function flushSnapshot( $fname = __METHOD__
) {
562 return $this->__call( __FUNCTION__
, func_get_args() );
565 public function timestamp( $ts = 0 ) {
566 return $this->__call( __FUNCTION__
, func_get_args() );
569 public function timestampOrNull( $ts = null ) {
570 return $this->__call( __FUNCTION__
, func_get_args() );
573 public function ping( &$rtt = null ) {
574 return func_num_args()
575 ?
$this->__call( __FUNCTION__
, [ &$rtt ] )
576 : $this->__call( __FUNCTION__
, [] ); // method cares about null vs missing
579 public function getLag() {
580 return $this->__call( __FUNCTION__
, func_get_args() );
583 public function getSessionLagStatus() {
584 return $this->__call( __FUNCTION__
, func_get_args() );
587 public function maxListLen() {
588 return $this->__call( __FUNCTION__
, func_get_args() );
591 public function encodeBlob( $b ) {
592 return $this->__call( __FUNCTION__
, func_get_args() );
595 public function decodeBlob( $b ) {
596 return $this->__call( __FUNCTION__
, func_get_args() );
599 public function setSessionOptions( array $options ) {
600 return $this->__call( __FUNCTION__
, func_get_args() );
603 public function setSchemaVars( $vars ) {
604 return $this->__call( __FUNCTION__
, func_get_args() );
607 public function lockIsFree( $lockName, $method ) {
608 return $this->__call( __FUNCTION__
, func_get_args() );
611 public function lock( $lockName, $method, $timeout = 5 ) {
612 return $this->__call( __FUNCTION__
, func_get_args() );
615 public function unlock( $lockName, $method ) {
616 return $this->__call( __FUNCTION__
, func_get_args() );
619 public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
620 return $this->__call( __FUNCTION__
, func_get_args() );
623 public function namedLocksEnqueue() {
624 return $this->__call( __FUNCTION__
, func_get_args() );
627 public function getInfinity() {
628 return $this->__call( __FUNCTION__
, func_get_args() );
631 public function encodeExpiry( $expiry ) {
632 return $this->__call( __FUNCTION__
, func_get_args() );
635 public function decodeExpiry( $expiry, $format = TS_MW
) {
636 return $this->__call( __FUNCTION__
, func_get_args() );
639 public function setBigSelects( $value = true ) {
640 return $this->__call( __FUNCTION__
, func_get_args() );
643 public function isReadOnly() {
644 return $this->__call( __FUNCTION__
, func_get_args() );
647 public function setTableAliases( array $aliases ) {
648 return $this->__call( __FUNCTION__
, func_get_args() );
651 public function setIndexAliases( array $aliases ) {
652 return $this->__call( __FUNCTION__
, func_get_args() );
656 * Clean up the connection when out of scope
658 function __destruct() {
660 $this->lb
->reuseConnection( $this->conn
);
667 * @deprecated since 1.29
669 class_alias( DBConnRef
::class, 'DBConnRef' );