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 on (false) or off (true) the automatic generation and sending
57 * of a "we're sorry, but there has been a database error" page on
58 * database errors. Default is on (false). When turned off, the
59 * code should use wfLastErrno() and wfLastError() to handle the
60 * situation as appropriate.
64 * @return Returns the previous state.
66 function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST
) {
67 $db =& wfGetDB( $dbi );
68 if ( $db !== false ) {
69 return $db->ignoreErrors( $newstate );
76 * @param $res database result handler
81 * Free a database result
82 * @return bool whether result is sucessful or not
84 function wfFreeResult( $res, $dbi = DB_LAST
)
86 $db =& wfGetDB( $dbi );
87 if ( $db !== false ) {
88 $db->freeResult( $res );
96 * Get an object from a database result
97 * @return object|false object we requested
99 function wfFetchObject( $res, $dbi = DB_LAST
) {
100 $db =& wfGetDB( $dbi );
101 if ( $db !== false ) {
102 return $db->fetchObject( $res, $dbi = DB_LAST
);
109 * Get a row from a database result
110 * @return object|false row we requested
112 function wfFetchRow( $res, $dbi = DB_LAST
) {
113 $db =& wfGetDB( $dbi );
114 if ( $db !== false ) {
115 return $db->fetchRow ( $res, $dbi = DB_LAST
);
122 * Get a number of rows from a database result
123 * @return integer|false number of rows
125 function wfNumRows( $res, $dbi = DB_LAST
) {
126 $db =& wfGetDB( $dbi );
127 if ( $db !== false ) {
128 return $db->numRows( $res, $dbi = DB_LAST
);
135 * Get the number of fields from a database result
136 * @return integer|false number of fields
138 function wfNumFields( $res, $dbi = DB_LAST
) {
139 $db =& wfGetDB( $dbi );
140 if ( $db !== false ) {
141 return $db->numFields( $res );
148 * Return name of a field in a result
149 * @param integer $n id of the field
150 * @return string|false name of field
152 function wfFieldName( $res, $n, $dbi = DB_LAST
)
154 $db =& wfGetDB( $dbi );
155 if ( $db !== false ) {
156 return $db->fieldName( $res, $n, $dbi = DB_LAST
);
164 * @todo document function
166 function wfInsertId( $dbi = DB_LAST
) {
167 $db =& wfGetDB( $dbi );
168 if ( $db !== false ) {
169 return $db->insertId();
176 * @todo document function
178 function wfDataSeek( $res, $row, $dbi = DB_LAST
) {
179 $db =& wfGetDB( $dbi );
180 if ( $db !== false ) {
181 return $db->dataSeek( $res, $row );
188 * @todo document function
190 function wfLastErrno( $dbi = DB_LAST
) {
191 $db =& wfGetDB( $dbi );
192 if ( $db !== false ) {
193 return $db->lastErrno();
200 * @todo document function
202 function wfLastError( $dbi = DB_LAST
) {
203 $db =& wfGetDB( $dbi );
204 if ( $db !== false ) {
205 return $db->lastError();
212 * @todo document function
214 function wfAffectedRows( $dbi = DB_LAST
) {
215 $db =& wfGetDB( $dbi );
216 if ( $db !== false ) {
217 return $db->affectedRows();
224 * @todo document function
226 function wfLastDBquery( $dbi = DB_LAST
) {
227 $db =& wfGetDB( $dbi );
228 if ( $db !== false ) {
229 return $db->lastQuery();
236 * @todo document function
238 function wfSetSQL( $table, $var, $value, $cond, $dbi = DB_MASTER
)
240 $db =& wfGetDB( $dbi );
241 if ( $db !== false ) {
242 return $db->set( $table, $var, $value, $cond );
250 * @todo document function
252 function wfGetSQL( $table, $var, $cond='', $dbi = DB_LAST
)
254 $db =& wfGetDB( $dbi );
255 if ( $db !== false ) {
256 return $db->selectField( $table, $var, $cond );
263 * @todo document function
265 function wfFieldExists( $table, $field, $dbi = DB_LAST
) {
266 $db =& wfGetDB( $dbi );
267 if ( $db !== false ) {
268 return $db->fieldExists( $table, $field );
275 * @todo document function
277 function wfIndexExists( $table, $index, $dbi = DB_LAST
) {
278 $db =& wfGetDB( $dbi );
279 if ( $db !== false ) {
280 return $db->indexExists( $table, $index );
287 * @todo document function
289 function wfInsertArray( $table, $array, $fname = 'wfInsertArray', $dbi = DB_MASTER
) {
290 $db =& wfGetDB( $dbi );
291 if ( $db !== false ) {
292 return $db->insert( $table, $array, $fname );
299 * @todo document function
301 function wfGetArray( $table, $vars, $conds, $fname = 'wfGetArray', $dbi = DB_LAST
) {
302 $db =& wfGetDB( $dbi );
303 if ( $db !== false ) {
304 return $db->getArray( $table, $vars, $conds, $fname );
311 * @todo document function
313 function wfUpdateArray( $table, $values, $conds, $fname = 'wfUpdateArray', $dbi = DB_MASTER
) {
314 $db =& wfGetDB( $dbi );
315 if ( $db !== false ) {
316 $db->update( $table, $values, $conds, $fname );
324 * @todo document function
326 function wfTableName( $name, $dbi = DB_LAST
) {
327 $db =& wfGetDB( $dbi );
328 if ( $db !== false ) {
329 return $db->tableName( $name );
336 * @todo document function
338 function wfStrencode( $s, $dbi = DB_LAST
) {
339 $db =& wfGetDB( $dbi );
340 if ( $db !== false ) {
341 return $db->strencode( $s );
348 * @todo document function
350 function wfNextSequenceValue( $seqName, $dbi = DB_MASTER
) {
351 $db =& wfGetDB( $dbi );
352 if ( $db !== false ) {
353 return $db->nextSequenceValue( $seqName );
360 * @todo document function
362 function wfUseIndexClause( $index, $dbi = DB_SLAVE
) {
363 $db =& wfGetDB( $dbi );
364 if ( $db !== false ) {
365 return $db->useIndexClause( $index );