3 * Helper class to handle automatically marking connections as reusable (via RAII pattern)
4 * as well handling deferring the actual network connection until the handle is used
6 * @note: proxy methods are defined explicity to avoid interface errors
10 class DBConnRef
implements IDatabase
{
11 /** @var LoadBalancer */
14 /** @var DatabaseBase|null */
17 /** @var array|null */
21 * @param LoadBalancer $lb
22 * @param DatabaseBase|array $conn Connection or (server index, group, wiki ID) array
24 public function __construct( LoadBalancer
$lb, $conn ) {
26 if ( $conn instanceof DatabaseBase
) {
29 $this->params
= $conn;
33 function __call( $name, array $arguments ) {
34 if ( $this->conn
=== null ) {
35 list( $db, $groups, $wiki ) = $this->params
;
36 $this->conn
= $this->lb
->getConnection( $db, $groups, $wiki );
39 return call_user_func_array( array( $this->conn
, $name ), $arguments );
42 public function getServerInfo() {
43 return $this->__call( __FUNCTION__
, func_get_args() );
46 public function bufferResults( $buffer = null ) {
47 return $this->__call( __FUNCTION__
, func_get_args() );
50 public function trxLevel() {
51 return $this->__call( __FUNCTION__
, func_get_args() );
54 public function trxTimestamp() {
55 return $this->__call( __FUNCTION__
, func_get_args() );
58 public function tablePrefix( $prefix = null ) {
59 return $this->__call( __FUNCTION__
, func_get_args() );
62 public function dbSchema( $schema = null ) {
63 return $this->__call( __FUNCTION__
, func_get_args() );
66 public function getLBInfo( $name = null ) {
67 return $this->__call( __FUNCTION__
, func_get_args() );
70 public function setLBInfo( $name, $value = null ) {
71 return $this->__call( __FUNCTION__
, func_get_args() );
74 public function implicitGroupby() {
75 return $this->__call( __FUNCTION__
, func_get_args() );
78 public function implicitOrderby() {
79 return $this->__call( __FUNCTION__
, func_get_args() );
82 public function lastQuery() {
83 return $this->__call( __FUNCTION__
, func_get_args() );
86 public function doneWrites() {
87 return $this->__call( __FUNCTION__
, func_get_args() );
90 public function lastDoneWrites() {
91 return $this->__call( __FUNCTION__
, func_get_args() );
94 public function writesOrCallbacksPending() {
95 return $this->__call( __FUNCTION__
, func_get_args() );
98 public function pendingWriteQueryDuration() {
99 return $this->__call( __FUNCTION__
, func_get_args() );
102 public function isOpen() {
103 return $this->__call( __FUNCTION__
, func_get_args() );
106 public function setFlag( $flag ) {
107 return $this->__call( __FUNCTION__
, func_get_args() );
110 public function clearFlag( $flag ) {
111 return $this->__call( __FUNCTION__
, func_get_args() );
114 public function getFlag( $flag ) {
115 return $this->__call( __FUNCTION__
, func_get_args() );
118 public function getProperty( $name ) {
119 return $this->__call( __FUNCTION__
, func_get_args() );
122 public function getWikiID() {
123 return $this->__call( __FUNCTION__
, func_get_args() );
126 public function getType() {
127 return $this->__call( __FUNCTION__
, func_get_args() );
130 public function open( $server, $user, $password, $dbName ) {
131 return $this->__call( __FUNCTION__
, func_get_args() );
134 public function fetchObject( $res ) {
135 return $this->__call( __FUNCTION__
, func_get_args() );
138 public function fetchRow( $res ) {
139 return $this->__call( __FUNCTION__
, func_get_args() );
142 public function numRows( $res ) {
143 return $this->__call( __FUNCTION__
, func_get_args() );
146 public function numFields( $res ) {
147 return $this->__call( __FUNCTION__
, func_get_args() );
150 public function fieldName( $res, $n ) {
151 return $this->__call( __FUNCTION__
, func_get_args() );
154 public function insertId() {
155 return $this->__call( __FUNCTION__
, func_get_args() );
158 public function dataSeek( $res, $row ) {
159 return $this->__call( __FUNCTION__
, func_get_args() );
162 public function lastErrno() {
163 return $this->__call( __FUNCTION__
, func_get_args() );
166 public function lastError() {
167 return $this->__call( __FUNCTION__
, func_get_args() );
170 public function fieldInfo( $table, $field ) {
171 return $this->__call( __FUNCTION__
, func_get_args() );
174 public function affectedRows() {
175 return $this->__call( __FUNCTION__
, func_get_args() );
178 public function getSoftwareLink() {
179 return $this->__call( __FUNCTION__
, func_get_args() );
182 public function getServerVersion() {
183 return $this->__call( __FUNCTION__
, func_get_args() );
186 public function close() {
187 return $this->__call( __FUNCTION__
, func_get_args() );
190 public function reportConnectionError( $error = 'Unknown error' ) {
191 return $this->__call( __FUNCTION__
, func_get_args() );
194 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false ) {
195 return $this->__call( __FUNCTION__
, func_get_args() );
198 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
199 return $this->__call( __FUNCTION__
, func_get_args() );
202 public function freeResult( $res ) {
203 return $this->__call( __FUNCTION__
, func_get_args() );
206 public function selectField(
207 $table, $var, $cond = '', $fname = __METHOD__
, $options = array()
209 return $this->__call( __FUNCTION__
, func_get_args() );
212 public function selectFieldValues(
213 $table, $var, $cond = '', $fname = __METHOD__
, $options = array()
215 return $this->__call( __FUNCTION__
, func_get_args() );
218 public function select(
219 $table, $vars, $conds = '', $fname = __METHOD__
,
220 $options = array(), $join_conds = array()
222 return $this->__call( __FUNCTION__
, func_get_args() );
225 public function selectSQLText(
226 $table, $vars, $conds = '', $fname = __METHOD__
,
227 $options = array(), $join_conds = array()
229 return $this->__call( __FUNCTION__
, func_get_args() );
232 public function selectRow(
233 $table, $vars, $conds, $fname = __METHOD__
,
234 $options = array(), $join_conds = array()
236 return $this->__call( __FUNCTION__
, func_get_args() );
239 public function estimateRowCount(
240 $table, $vars = '*', $conds = '', $fname = __METHOD__
, $options = array()
242 return $this->__call( __FUNCTION__
, func_get_args() );
245 public function selectRowCount(
246 $tables, $vars = '*', $conds = '', $fname = __METHOD__
, $options = array(), $join_conds = array()
248 return $this->__call( __FUNCTION__
, func_get_args() );
251 public function fieldExists( $table, $field, $fname = __METHOD__
) {
252 return $this->__call( __FUNCTION__
, func_get_args() );
255 public function indexExists( $table, $index, $fname = __METHOD__
) {
256 return $this->__call( __FUNCTION__
, func_get_args() );
259 public function tableExists( $table, $fname = __METHOD__
) {
260 return $this->__call( __FUNCTION__
, func_get_args() );
263 public function indexUnique( $table, $index ) {
264 return $this->__call( __FUNCTION__
, func_get_args() );
267 public function insert( $table, $a, $fname = __METHOD__
, $options = array() ) {
268 return $this->__call( __FUNCTION__
, func_get_args() );
271 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = array() ) {
272 return $this->__call( __FUNCTION__
, func_get_args() );
275 public function makeList( $a, $mode = LIST_COMMA
) {
276 return $this->__call( __FUNCTION__
, func_get_args() );
279 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
280 return $this->__call( __FUNCTION__
, func_get_args() );
283 public function bitNot( $field ) {
284 return $this->__call( __FUNCTION__
, func_get_args() );
287 public function bitAnd( $fieldLeft, $fieldRight ) {
288 return $this->__call( __FUNCTION__
, func_get_args() );
291 public function bitOr( $fieldLeft, $fieldRight ) {
292 return $this->__call( __FUNCTION__
, func_get_args() );
295 public function buildConcat( $stringList ) {
296 return $this->__call( __FUNCTION__
, func_get_args() );
299 public function buildGroupConcatField(
300 $delim, $table, $field, $conds = '', $join_conds = array()
302 return $this->__call( __FUNCTION__
, func_get_args() );
305 public function selectDB( $db ) {
306 return $this->__call( __FUNCTION__
, func_get_args() );
309 public function getDBname() {
310 return $this->__call( __FUNCTION__
, func_get_args() );
313 public function getServer() {
314 return $this->__call( __FUNCTION__
, func_get_args() );
317 public function addQuotes( $s ) {
318 return $this->__call( __FUNCTION__
, func_get_args() );
321 public function buildLike() {
322 return $this->__call( __FUNCTION__
, func_get_args() );
325 public function anyChar() {
326 return $this->__call( __FUNCTION__
, func_get_args() );
329 public function anyString() {
330 return $this->__call( __FUNCTION__
, func_get_args() );
333 public function nextSequenceValue( $seqName ) {
334 return $this->__call( __FUNCTION__
, func_get_args() );
337 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
338 return $this->__call( __FUNCTION__
, func_get_args() );
341 public function upsert(
342 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
344 return $this->__call( __FUNCTION__
, func_get_args() );
347 public function deleteJoin(
348 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
350 return $this->__call( __FUNCTION__
, func_get_args() );
353 public function delete( $table, $conds, $fname = __METHOD__
) {
354 return $this->__call( __FUNCTION__
, func_get_args() );
357 public function insertSelect(
358 $destTable, $srcTable, $varMap, $conds,
359 $fname = __METHOD__
, $insertOptions = array(), $selectOptions = array()
361 return $this->__call( __FUNCTION__
, func_get_args() );
364 public function unionSupportsOrderAndLimit() {
365 return $this->__call( __FUNCTION__
, func_get_args() );
368 public function unionQueries( $sqls, $all ) {
369 return $this->__call( __FUNCTION__
, func_get_args() );
372 public function conditional( $cond, $trueVal, $falseVal ) {
373 return $this->__call( __FUNCTION__
, func_get_args() );
376 public function strreplace( $orig, $old, $new ) {
377 return $this->__call( __FUNCTION__
, func_get_args() );
380 public function getServerUptime() {
381 return $this->__call( __FUNCTION__
, func_get_args() );
384 public function wasDeadlock() {
385 return $this->__call( __FUNCTION__
, func_get_args() );
388 public function wasLockTimeout() {
389 return $this->__call( __FUNCTION__
, func_get_args() );
392 public function wasErrorReissuable() {
393 return $this->__call( __FUNCTION__
, func_get_args() );
396 public function wasReadOnlyError() {
397 return $this->__call( __FUNCTION__
, func_get_args() );
400 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
401 return $this->__call( __FUNCTION__
, func_get_args() );
404 public function getSlavePos() {
405 return $this->__call( __FUNCTION__
, func_get_args() );
408 public function getMasterPos() {
409 return $this->__call( __FUNCTION__
, func_get_args() );
412 public function onTransactionIdle( $callback ) {
413 return $this->__call( __FUNCTION__
, func_get_args() );
416 public function onTransactionPreCommitOrIdle( $callback ) {
417 return $this->__call( __FUNCTION__
, func_get_args() );
420 public function startAtomic( $fname = __METHOD__
) {
421 return $this->__call( __FUNCTION__
, func_get_args() );
424 public function endAtomic( $fname = __METHOD__
) {
425 return $this->__call( __FUNCTION__
, func_get_args() );
428 public function begin( $fname = __METHOD__
) {
429 return $this->__call( __FUNCTION__
, func_get_args() );
432 public function commit( $fname = __METHOD__
, $flush = '' ) {
433 return $this->__call( __FUNCTION__
, func_get_args() );
436 public function rollback( $fname = __METHOD__
, $flush = '' ) {
437 return $this->__call( __FUNCTION__
, func_get_args() );
440 public function listTables( $prefix = null, $fname = __METHOD__
) {
441 return $this->__call( __FUNCTION__
, func_get_args() );
444 public function timestamp( $ts = 0 ) {
445 return $this->__call( __FUNCTION__
, func_get_args() );
448 public function timestampOrNull( $ts = null ) {
449 return $this->__call( __FUNCTION__
, func_get_args() );
452 public function ping() {
453 return $this->__call( __FUNCTION__
, func_get_args() );
456 public function getLag() {
457 return $this->__call( __FUNCTION__
, func_get_args() );
460 public function getSessionLagStatus() {
461 return $this->__call( __FUNCTION__
, func_get_args() );
464 public function maxListLen() {
465 return $this->__call( __FUNCTION__
, func_get_args() );
468 public function encodeBlob( $b ) {
469 return $this->__call( __FUNCTION__
, func_get_args() );
472 public function decodeBlob( $b ) {
473 return $this->__call( __FUNCTION__
, func_get_args() );
476 public function setSessionOptions( array $options ) {
477 return $this->__call( __FUNCTION__
, func_get_args() );
480 public function setSchemaVars( $vars ) {
481 return $this->__call( __FUNCTION__
, func_get_args() );
484 public function lockIsFree( $lockName, $method ) {
485 return $this->__call( __FUNCTION__
, func_get_args() );
488 public function lock( $lockName, $method, $timeout = 5 ) {
489 return $this->__call( __FUNCTION__
, func_get_args() );
492 public function unlock( $lockName, $method ) {
493 return $this->__call( __FUNCTION__
, func_get_args() );
496 public function namedLocksEnqueue() {
497 return $this->__call( __FUNCTION__
, func_get_args() );
500 public function getInfinity() {
501 return $this->__call( __FUNCTION__
, func_get_args() );
504 public function encodeExpiry( $expiry ) {
505 return $this->__call( __FUNCTION__
, func_get_args() );
508 public function decodeExpiry( $expiry, $format = TS_MW
) {
509 return $this->__call( __FUNCTION__
, func_get_args() );
512 public function setBigSelects( $value = true ) {
513 return $this->__call( __FUNCTION__
, func_get_args() );
516 public function isReadOnly() {
517 return $this->__call( __FUNCTION__
, func_get_args() );
521 * Clean up the connection when out of scope
523 function __destruct() {
524 if ( $this->conn
!== null ) {
525 $this->lb
->reuseConnection( $this->conn
);