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 ( 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 call_user_func_array( [ $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 writesOrCallbacksPending() {
117 return $this->__call( __FUNCTION__
, func_get_args() );
120 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
) {
121 return $this->__call( __FUNCTION__
, func_get_args() );
124 public function pendingWriteCallers() {
125 return $this->__call( __FUNCTION__
, func_get_args() );
128 public function pendingWriteRowsAffected() {
129 return $this->__call( __FUNCTION__
, func_get_args() );
132 public function isOpen() {
133 return $this->__call( __FUNCTION__
, func_get_args() );
136 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
137 return $this->__call( __FUNCTION__
, func_get_args() );
140 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
141 return $this->__call( __FUNCTION__
, func_get_args() );
144 public function restoreFlags( $state = self
::RESTORE_PRIOR
) {
145 return $this->__call( __FUNCTION__
, func_get_args() );
148 public function getFlag( $flag ) {
149 return $this->__call( __FUNCTION__
, func_get_args() );
152 public function getProperty( $name ) {
153 return $this->__call( __FUNCTION__
, func_get_args() );
156 public function getDomainID() {
157 if ( $this->conn
=== null ) {
158 $domain = $this->params
[self
::FLD_DOMAIN
];
159 // Avoid triggering a database connection
160 return $domain instanceof DatabaseDomain ?
$domain->getId() : $domain;
163 return $this->__call( __FUNCTION__
, func_get_args() );
166 public function getWikiID() {
167 return $this->getDomainID();
170 public function getType() {
171 return $this->__call( __FUNCTION__
, func_get_args() );
174 public function open( $server, $user, $password, $dbName ) {
175 return $this->__call( __FUNCTION__
, func_get_args() );
178 public function fetchObject( $res ) {
179 return $this->__call( __FUNCTION__
, func_get_args() );
182 public function fetchRow( $res ) {
183 return $this->__call( __FUNCTION__
, func_get_args() );
186 public function numRows( $res ) {
187 return $this->__call( __FUNCTION__
, func_get_args() );
190 public function numFields( $res ) {
191 return $this->__call( __FUNCTION__
, func_get_args() );
194 public function fieldName( $res, $n ) {
195 return $this->__call( __FUNCTION__
, func_get_args() );
198 public function insertId() {
199 return $this->__call( __FUNCTION__
, func_get_args() );
202 public function dataSeek( $res, $row ) {
203 return $this->__call( __FUNCTION__
, func_get_args() );
206 public function lastErrno() {
207 return $this->__call( __FUNCTION__
, func_get_args() );
210 public function lastError() {
211 return $this->__call( __FUNCTION__
, func_get_args() );
214 public function affectedRows() {
215 return $this->__call( __FUNCTION__
, func_get_args() );
218 public function getSoftwareLink() {
219 return $this->__call( __FUNCTION__
, func_get_args() );
222 public function getServerVersion() {
223 return $this->__call( __FUNCTION__
, func_get_args() );
226 public function close() {
227 return $this->__call( __FUNCTION__
, func_get_args() );
230 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false ) {
231 return $this->__call( __FUNCTION__
, func_get_args() );
234 public function freeResult( $res ) {
235 return $this->__call( __FUNCTION__
, func_get_args() );
238 public function selectField(
239 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
241 return $this->__call( __FUNCTION__
, func_get_args() );
244 public function selectFieldValues(
245 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
247 return $this->__call( __FUNCTION__
, func_get_args() );
250 public function select(
251 $table, $vars, $conds = '', $fname = __METHOD__
,
252 $options = [], $join_conds = []
254 return $this->__call( __FUNCTION__
, func_get_args() );
257 public function selectSQLText(
258 $table, $vars, $conds = '', $fname = __METHOD__
,
259 $options = [], $join_conds = []
261 return $this->__call( __FUNCTION__
, func_get_args() );
264 public function selectRow(
265 $table, $vars, $conds, $fname = __METHOD__
,
266 $options = [], $join_conds = []
268 return $this->__call( __FUNCTION__
, func_get_args() );
271 public function estimateRowCount(
272 $table, $vars = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
274 return $this->__call( __FUNCTION__
, func_get_args() );
277 public function selectRowCount(
278 $tables, $vars = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
280 return $this->__call( __FUNCTION__
, func_get_args() );
283 public function fieldExists( $table, $field, $fname = __METHOD__
) {
284 return $this->__call( __FUNCTION__
, func_get_args() );
287 public function indexExists( $table, $index, $fname = __METHOD__
) {
288 return $this->__call( __FUNCTION__
, func_get_args() );
291 public function tableExists( $table, $fname = __METHOD__
) {
292 return $this->__call( __FUNCTION__
, func_get_args() );
295 public function insert( $table, $a, $fname = __METHOD__
, $options = [] ) {
296 return $this->__call( __FUNCTION__
, func_get_args() );
299 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] ) {
300 return $this->__call( __FUNCTION__
, func_get_args() );
303 public function makeList( $a, $mode = self
::LIST_COMMA
) {
304 return $this->__call( __FUNCTION__
, func_get_args() );
307 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
308 return $this->__call( __FUNCTION__
, func_get_args() );
311 public function aggregateValue( $valuedata, $valuename = 'value' ) {
312 return $this->__call( __FUNCTION__
, func_get_args() );
315 public function bitNot( $field ) {
316 return $this->__call( __FUNCTION__
, func_get_args() );
319 public function bitAnd( $fieldLeft, $fieldRight ) {
320 return $this->__call( __FUNCTION__
, func_get_args() );
323 public function bitOr( $fieldLeft, $fieldRight ) {
324 return $this->__call( __FUNCTION__
, func_get_args() );
327 public function buildConcat( $stringList ) {
328 return $this->__call( __FUNCTION__
, func_get_args() );
331 public function buildGroupConcatField(
332 $delim, $table, $field, $conds = '', $join_conds = []
334 return $this->__call( __FUNCTION__
, func_get_args() );
337 public function buildSubstring( $input, $startPosition, $length = null ) {
338 return $this->__call( __FUNCTION__
, func_get_args() );
341 public function buildStringCast( $field ) {
342 return $this->__call( __FUNCTION__
, func_get_args() );
345 public function buildIntegerCast( $field ) {
346 return $this->__call( __FUNCTION__
, func_get_args() );
349 public function buildSelectSubquery(
350 $table, $vars, $conds = '', $fname = __METHOD__
,
351 $options = [], $join_conds = []
353 return $this->__call( __FUNCTION__
, func_get_args() );
356 public function databasesAreIndependent() {
357 return $this->__call( __FUNCTION__
, func_get_args() );
360 public function selectDB( $db ) {
361 return $this->__call( __FUNCTION__
, func_get_args() );
364 public function getDBname() {
365 return $this->__call( __FUNCTION__
, func_get_args() );
368 public function getServer() {
369 return $this->__call( __FUNCTION__
, func_get_args() );
372 public function addQuotes( $s ) {
373 return $this->__call( __FUNCTION__
, func_get_args() );
376 public function buildLike() {
377 return $this->__call( __FUNCTION__
, func_get_args() );
380 public function anyChar() {
381 return $this->__call( __FUNCTION__
, func_get_args() );
384 public function anyString() {
385 return $this->__call( __FUNCTION__
, func_get_args() );
388 public function nextSequenceValue( $seqName ) {
389 return $this->__call( __FUNCTION__
, func_get_args() );
392 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
393 return $this->__call( __FUNCTION__
, func_get_args() );
396 public function upsert(
397 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
399 return $this->__call( __FUNCTION__
, func_get_args() );
402 public function deleteJoin(
403 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
405 return $this->__call( __FUNCTION__
, func_get_args() );
408 public function delete( $table, $conds, $fname = __METHOD__
) {
409 return $this->__call( __FUNCTION__
, func_get_args() );
412 public function insertSelect(
413 $destTable, $srcTable, $varMap, $conds,
414 $fname = __METHOD__
, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
416 return $this->__call( __FUNCTION__
, func_get_args() );
419 public function unionSupportsOrderAndLimit() {
420 return $this->__call( __FUNCTION__
, func_get_args() );
423 public function unionQueries( $sqls, $all ) {
424 return $this->__call( __FUNCTION__
, func_get_args() );
427 public function unionConditionPermutations(
428 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
429 $options = [], $join_conds = []
431 return $this->__call( __FUNCTION__
, func_get_args() );
434 public function conditional( $cond, $trueVal, $falseVal ) {
435 return $this->__call( __FUNCTION__
, func_get_args() );
438 public function strreplace( $orig, $old, $new ) {
439 return $this->__call( __FUNCTION__
, func_get_args() );
442 public function getServerUptime() {
443 return $this->__call( __FUNCTION__
, func_get_args() );
446 public function wasDeadlock() {
447 return $this->__call( __FUNCTION__
, func_get_args() );
450 public function wasLockTimeout() {
451 return $this->__call( __FUNCTION__
, func_get_args() );
454 public function wasConnectionLoss() {
455 return $this->__call( __FUNCTION__
, func_get_args() );
458 public function wasReadOnlyError() {
459 return $this->__call( __FUNCTION__
, func_get_args() );
462 public function wasErrorReissuable() {
463 return $this->__call( __FUNCTION__
, func_get_args() );
466 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
467 return $this->__call( __FUNCTION__
, func_get_args() );
470 public function getReplicaPos() {
471 return $this->__call( __FUNCTION__
, func_get_args() );
474 public function getMasterPos() {
475 return $this->__call( __FUNCTION__
, func_get_args() );
478 public function serverIsReadOnly() {
479 return $this->__call( __FUNCTION__
, func_get_args() );
482 public function onTransactionResolution( callable
$callback, $fname = __METHOD__
) {
483 return $this->__call( __FUNCTION__
, func_get_args() );
486 public function onTransactionIdle( callable
$callback, $fname = __METHOD__
) {
487 return $this->__call( __FUNCTION__
, func_get_args() );
490 public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
491 return $this->__call( __FUNCTION__
, func_get_args() );
494 public function setTransactionListener( $name, callable
$callback = null ) {
495 return $this->__call( __FUNCTION__
, func_get_args() );
498 public function startAtomic(
499 $fname = __METHOD__
, $cancelable = IDatabase
::ATOMIC_NOT_CANCELABLE
501 return $this->__call( __FUNCTION__
, func_get_args() );
504 public function endAtomic( $fname = __METHOD__
) {
505 return $this->__call( __FUNCTION__
, func_get_args() );
508 public function cancelAtomic( $fname = __METHOD__
) {
509 return $this->__call( __FUNCTION__
, func_get_args() );
512 public function doAtomicSection( $fname, callable
$callback ) {
513 return $this->__call( __FUNCTION__
, func_get_args() );
516 public function begin( $fname = __METHOD__
, $mode = IDatabase
::TRANSACTION_EXPLICIT
) {
517 return $this->__call( __FUNCTION__
, func_get_args() );
520 public function commit( $fname = __METHOD__
, $flush = '' ) {
521 return $this->__call( __FUNCTION__
, func_get_args() );
524 public function rollback( $fname = __METHOD__
, $flush = '' ) {
525 return $this->__call( __FUNCTION__
, func_get_args() );
528 public function flushSnapshot( $fname = __METHOD__
) {
529 return $this->__call( __FUNCTION__
, func_get_args() );
532 public function timestamp( $ts = 0 ) {
533 return $this->__call( __FUNCTION__
, func_get_args() );
536 public function timestampOrNull( $ts = null ) {
537 return $this->__call( __FUNCTION__
, func_get_args() );
540 public function ping( &$rtt = null ) {
541 return func_num_args()
542 ?
$this->__call( __FUNCTION__
, [ &$rtt ] )
543 : $this->__call( __FUNCTION__
, [] ); // method cares about null vs missing
546 public function getLag() {
547 return $this->__call( __FUNCTION__
, func_get_args() );
550 public function getSessionLagStatus() {
551 return $this->__call( __FUNCTION__
, func_get_args() );
554 public function maxListLen() {
555 return $this->__call( __FUNCTION__
, func_get_args() );
558 public function encodeBlob( $b ) {
559 return $this->__call( __FUNCTION__
, func_get_args() );
562 public function decodeBlob( $b ) {
563 return $this->__call( __FUNCTION__
, func_get_args() );
566 public function setSessionOptions( array $options ) {
567 return $this->__call( __FUNCTION__
, func_get_args() );
570 public function setSchemaVars( $vars ) {
571 return $this->__call( __FUNCTION__
, func_get_args() );
574 public function lockIsFree( $lockName, $method ) {
575 return $this->__call( __FUNCTION__
, func_get_args() );
578 public function lock( $lockName, $method, $timeout = 5 ) {
579 return $this->__call( __FUNCTION__
, func_get_args() );
582 public function unlock( $lockName, $method ) {
583 return $this->__call( __FUNCTION__
, func_get_args() );
586 public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
587 return $this->__call( __FUNCTION__
, func_get_args() );
590 public function namedLocksEnqueue() {
591 return $this->__call( __FUNCTION__
, func_get_args() );
594 public function getInfinity() {
595 return $this->__call( __FUNCTION__
, func_get_args() );
598 public function encodeExpiry( $expiry ) {
599 return $this->__call( __FUNCTION__
, func_get_args() );
602 public function decodeExpiry( $expiry, $format = TS_MW
) {
603 return $this->__call( __FUNCTION__
, func_get_args() );
606 public function setBigSelects( $value = true ) {
607 return $this->__call( __FUNCTION__
, func_get_args() );
610 public function isReadOnly() {
611 return $this->__call( __FUNCTION__
, func_get_args() );
614 public function setTableAliases( array $aliases ) {
615 return $this->__call( __FUNCTION__
, func_get_args() );
618 public function setIndexAliases( array $aliases ) {
619 return $this->__call( __FUNCTION__
, func_get_args() );
623 * Clean up the connection when out of scope
625 function __destruct() {
627 $this->lb
->reuseConnection( $this->conn
);
632 class_alias( DBConnRef
::class, 'DBConnRef' );