3 * Backwards compatibility wrapper for Database.php
5 * Note: $wgDatabase has ceased to exist. Destroy all references.
11 * Usually aborts on failure
12 * If errors are explicitly ignored, returns success
13 * @param string $sql SQL query
14 * @param mixed $db database handler
15 * @param string $fname name of the php function calling
17 function wfQuery( $sql, $db, $fname = '' ) {
19 if ( !is_numeric( $db ) ) {
20 # Someone has tried to call this the old way
21 $wgOut->fatalError( wfMsgNoDB( 'wrong_wfQuery_params', $db, $sql ) );
25 return $c->query( $sql, $fname );
33 * @param string $sql SQL query
35 * @param string $fname name of the php function calling
36 * @return array first row from the database
38 function wfSingleQuery( $sql, $dbi, $fname = '' ) {
39 $db =& wfGetDB( $dbi );
40 $res = $db->query($sql, $fname );
41 $row = $db->fetchRow( $res );
43 $db->freeResult( $res );
48 * @todo document function
50 function &wfGetDB( $db = DB_LAST
) {
51 global $wgLoadBalancer;
52 return $wgLoadBalancer->getConnection( $db );
56 * Turns buffering of SQL result
57 * Sets on (true) or off (false). Default is "on" and it should not be changed
58 * without good reasons.
62 * @return mixed|NULL Returns the previous state.
64 function wfBufferSQLResults( $newstate, $dbi = DB_LAST
) {
65 $db =& wfGetDB( $dbi );
66 if ( $db !== false ) {
67 return $db->setBufferResults( $newstate );
74 * Turns on (false) or off (true) the automatic generation and sending
75 * of a "we're sorry, but there has been a database error" page on
76 * database errors. Default is on (false). When turned off, the
77 * code should use wfLastErrno() and wfLastError() to handle the
78 * situation as appropriate.
82 * @return Returns the previous state.
84 function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST
) {
85 $db =& wfGetDB( $dbi );
86 if ( $db !== false ) {
87 return $db->ignoreErrors( $newstate );
94 * @param $res database result handler
99 * Free a database result
100 * @return bool whether result is sucessful or not
102 function wfFreeResult( $res, $dbi = DB_LAST
)
104 $db =& wfGetDB( $dbi );
105 if ( $db !== false ) {
106 $db->freeResult( $res );
114 * Get an object from a database result
115 * @return object|false object we requested
117 function wfFetchObject( $res, $dbi = DB_LAST
) {
118 $db =& wfGetDB( $dbi );
119 if ( $db !== false ) {
120 return $db->fetchObject( $res, $dbi = DB_LAST
);
127 * Get a row from a database result
128 * @return object|false row we requested
130 function wfFetchRow( $res, $dbi = DB_LAST
) {
131 $db =& wfGetDB( $dbi );
132 if ( $db !== false ) {
133 return $db->fetchRow ( $res, $dbi = DB_LAST
);
140 * Get a number of rows from a database result
141 * @return integer|false number of rows
143 function wfNumRows( $res, $dbi = DB_LAST
) {
144 $db =& wfGetDB( $dbi );
145 if ( $db !== false ) {
146 return $db->numRows( $res, $dbi = DB_LAST
);
153 * Get the number of fields from a database result
154 * @return integer|false number of fields
156 function wfNumFields( $res, $dbi = DB_LAST
) {
157 $db =& wfGetDB( $dbi );
158 if ( $db !== false ) {
159 return $db->numFields( $res );
166 * Return name of a field in a result
167 * @param integer $n id of the field
168 * @return string|false name of field
170 function wfFieldName( $res, $n, $dbi = DB_LAST
)
172 $db =& wfGetDB( $dbi );
173 if ( $db !== false ) {
174 return $db->fieldName( $res, $n, $dbi = DB_LAST
);
182 * @todo document function
184 function wfInsertId( $dbi = DB_LAST
) {
185 $db =& wfGetDB( $dbi );
186 if ( $db !== false ) {
187 return $db->insertId();
194 * @todo document function
196 function wfDataSeek( $res, $row, $dbi = DB_LAST
) {
197 $db =& wfGetDB( $dbi );
198 if ( $db !== false ) {
199 return $db->dataSeek( $res, $row );
206 * @todo document function
208 function wfLastErrno( $dbi = DB_LAST
) {
209 $db =& wfGetDB( $dbi );
210 if ( $db !== false ) {
211 return $db->lastErrno();
218 * @todo document function
220 function wfLastError( $dbi = DB_LAST
) {
221 $db =& wfGetDB( $dbi );
222 if ( $db !== false ) {
223 return $db->lastError();
230 * @todo document function
232 function wfAffectedRows( $dbi = DB_LAST
) {
233 $db =& wfGetDB( $dbi );
234 if ( $db !== false ) {
235 return $db->affectedRows();
242 * @todo document function
244 function wfLastDBquery( $dbi = DB_LAST
) {
245 $db =& wfGetDB( $dbi );
246 if ( $db !== false ) {
247 return $db->lastQuery();
254 * @todo document function
256 function wfSetSQL( $table, $var, $value, $cond, $dbi = DB_MASTER
)
258 $db =& wfGetDB( $dbi );
259 if ( $db !== false ) {
260 return $db->set( $table, $var, $value, $cond );
268 * @todo document function
270 function wfGetSQL( $table, $var, $cond='', $dbi = DB_LAST
)
272 $db =& wfGetDB( $dbi );
273 if ( $db !== false ) {
274 return $db->selectField( $table, $var, $cond );
281 * @todo document function
283 function wfFieldExists( $table, $field, $dbi = DB_LAST
) {
284 $db =& wfGetDB( $dbi );
285 if ( $db !== false ) {
286 return $db->fieldExists( $table, $field );
293 * @todo document function
295 function wfIndexExists( $table, $index, $dbi = DB_LAST
) {
296 $db =& wfGetDB( $dbi );
297 if ( $db !== false ) {
298 return $db->indexExists( $table, $index );
305 * @todo document function
307 function wfInsertArray( $table, $array, $fname = 'wfInsertArray', $dbi = DB_MASTER
) {
308 $db =& wfGetDB( $dbi );
309 if ( $db !== false ) {
310 return $db->insert( $table, $array, $fname );
317 * @todo document function
319 function wfGetArray( $table, $vars, $conds, $fname = 'wfGetArray', $dbi = DB_LAST
) {
320 $db =& wfGetDB( $dbi );
321 if ( $db !== false ) {
322 return $db->getArray( $table, $vars, $conds, $fname );
329 * @todo document function
331 function wfUpdateArray( $table, $values, $conds, $fname = 'wfUpdateArray', $dbi = DB_MASTER
) {
332 $db =& wfGetDB( $dbi );
333 if ( $db !== false ) {
334 $db->update( $table, $values, $conds, $fname );
342 * @todo document function
344 function wfTableName( $name, $dbi = DB_LAST
) {
345 $db =& wfGetDB( $dbi );
346 if ( $db !== false ) {
347 return $db->tableName( $name );
354 * @todo document function
356 function wfStrencode( $s, $dbi = DB_LAST
) {
357 $db =& wfGetDB( $dbi );
358 if ( $db !== false ) {
359 return $db->strencode( $s );
366 * @todo document function
368 function wfNextSequenceValue( $seqName, $dbi = DB_MASTER
) {
369 $db =& wfGetDB( $dbi );
370 if ( $db !== false ) {
371 return $db->nextSequenceValue( $seqName );
378 * @todo document function
380 function wfUseIndexClause( $index, $dbi = DB_SLAVE
) {
381 $db =& wfGetDB( $dbi );
382 if ( $db !== false ) {
383 return $db->useIndexClause( $index );