DatabaseSqliteStandalone Class Reference
This class allows simple acccess to a SQLite database independently from main database settings. More...
Inheritance diagram for DatabaseSqliteStandalone:
Collaboration diagram for DatabaseSqliteStandalone:
Public Member Functions | |
| __construct ( $fileName, $flags=0) | |
 Public Member Functions inherited from DatabaseSqlite | |
| __construct ( $p=null) | |
| Constructor. More... | |
| addQuotes ( $s) | |
| affectedRows () | |
| attachDatabase ( $name, $file=false, $fname=__METHOD__) | |
| Attaches external database to our connection, see http://sqlite.org/lang_attach.html for details. More... | |
| buildConcat ( $stringList) | |
| Build a concatenation list to feed into a SQL query. More... | |
| buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=array()) | |
| Build a GROUP_CONCAT or equivalent statement for a query. More... | |
| buildLike () | |
| checkForEnabledSearch () | |
| Check if the searchindext table is FTS enabled. More... | |
| dataSeek ( $res, $row) | |
| deadlockLoop () | |
| No-op version of deadlockLoop. More... | |
| decodeBlob ( $b) | |
| duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__) | |
| encodeBlob ( $b) | |
| fetchObject ( $res) | |
| fetchRow ( $res) | |
| fieldInfo ( $table, $field) | |
| Get information about a given field Returns false if the field does not exist. More... | |
| fieldName ( $res, $n) | |
| freeResult ( $res) | |
| getSearchEngine () | |
| getServerInfo () | |
| getServerVersion () | |
| getSoftwareLink () | |
| getType () | |
| implicitGroupby () | |
| indexInfo ( $table, $index, $fname=__METHOD__) | |
| Returns information about an index Returns false if the index does not exist. More... | |
| indexName ( $index) | |
| Index names have DB scope. More... | |
| indexUnique ( $table, $index, $fname=__METHOD__) | |
| insert ( $table, $a, $fname=__METHOD__, $options=array()) | |
| Based on generic method (parent) with some prior SQLite-sepcific adjustments. More... | |
| insertId () | |
| This must be called after nextSequenceVal. More... | |
| isWriteQuery ( $sql) | |
| lastErrno () | |
| lastError () | |
| listTables ( $prefix=null, $fname=__METHOD__) | |
| List all tables on the database. More... | |
| lock ( $lockName, $method, $timeout=5) | |
| Acquire a named lock. More... | |
| makeInsertOptions ( $options) | |
| makeSelectOptions ( $options) | |
| Filter the options used in SELECT statements. More... | |
| numFields ( $res) | |
| numRows ( $res) | |
| The PDO::Statement class implements the array interface so count() will work. More... | |
| open ( $server, $user, $pass, $dbName) | |
| Open an SQLite database and return a resource handle to it NOTE: only $dbName is used, the other parameters are irrelevant for SQLite databases. More... | |
| openFile ( $fileName) | |
| Opens a database file. More... | |
| replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__) | |
| strencode ( $s) | |
| tableName ( $name, $format='quoted') | |
| Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks. More... | |
| textFieldSize ( $table, $field) | |
| Returns the size of a text field, or -1 for "unlimited" In SQLite this is SQLITE_MAX_LENGTH, by default 1GB. More... | |
| unionQueries ( $sqls, $all) | |
| unionSupportsOrderAndLimit () | |
| unlock ( $lockName, $method) | |
| Release a lock. More... | |
| wasDeadlock () | |
| wasErrorReissuable () | |
| wasReadOnlyError () | |
| Public Member Functions inherited from DatabaseBase | |
| __destruct () | |
| Run a few simple sanity checks. More... | |
| __sleep () | |
| Called by serialize. More... | |
| __toString () | |
| addIdentifierQuotes ( $s) | |
Quotes an identifier using backticks or "double quotes" depending on the database type. More... | |
| aggregateValue ( $valuedata, $valuename='value') | |
| Return aggregated value alias. More... | |
| anyChar () | |
| Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More... | |
| anyString () | |
| Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More... | |
| begin ( $fname=__METHOD__) | |
| Begin a transaction. More... | |
| bitAnd ( $fieldLeft, $fieldRight) | |
| bitNot ( $field) | |
| bitOr ( $fieldLeft, $fieldRight) | |
| bufferResults ( $buffer=null) | |
| Turns buffering of SQL result sets on (true) or off (false). More... | |
| cascadingDeletes () | |
| Returns true if this database supports (and uses) cascading deletes. More... | |
| cleanupTriggers () | |
| Returns true if this database supports (and uses) triggers (e.g. More... | |
| clearFlag ( $flag) | |
| Clear a flag for this connection. More... | |
| clearViewsCache () | |
| Reset the views process cache set by listViews() More... | |
| close () | |
| Closes a database connection. More... | |
| commit ( $fname=__METHOD__, $flush='') | |
| Commits a transaction previously started using begin(). More... | |
| conditional ( $cond, $trueVal, $falseVal) | |
| Returns an SQL expression for a simple conditional. More... | |
| connectionErrorHandler ( $errno, $errstr) | |
| dbSchema ( $schema=null) | |
| Get/set the db schema. More... | |
| debug ( $debug=null) | |
| Boolean, controls output of large amounts of debug information. More... | |
| decodeExpiry ( $expiry, $format=TS_MW) | |
| Decode an expiry time into a DBMS independent format. More... | |
| delete ( $table, $conds, $fname=__METHOD__) | |
| DELETE query wrapper. More... | |
| deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |
| DELETE where the condition is a join. More... | |
| doneWrites () | |
| Returns true if the connection may have been used for write queries. More... | |
| dropTable ( $tableName, $fName=__METHOD__) | |
| Delete a table. More... | |
| encodeExpiry ( $expiry) | |
| Encode an expiry time into the DBMS dependent format. More... | |
| endAtomic ( $fname=__METHOD__) | |
| Ends an atomic section of SQL statements. More... | |
| errorCount ( $count=null) | |
| Get/set the number of errors logged. More... | |
| estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=array()) | |
| Estimate rows in dataset. More... | |
| execute ( $prepared, $args=null) | |
| Execute a prepared query with the various arguments. More... | |
| fieldExists ( $table, $field, $fname=__METHOD__) | |
| Determines whether a field exists in a table. More... | |
| fieldNamesWithAlias ( $fields) | |
| Gets an array of aliased field names. More... | |
| fieldNameWithAlias ( $name, $alias=false) | |
| Get an aliased field name e.g. More... | |
| fillPrepared ( $preparedQuery, $args) | |
| For faking prepared SQL statements on DBs that don't support it directly. More... | |
| functionalIndexes () | |
| Returns true if this database can use functional indexes. More... | |
| getDBname () | |
| Get the current DB name. More... | |
| getDelimiter () | |
| getFlag ( $flag) | |
| Returns a boolean whether the flag $flag is set for this connection. More... | |
| getInfinity () | |
| Find out when 'infinity' is. More... | |
| getLag () | |
| Get slave lag. More... | |
| getLBInfo ( $name=null) | |
| Get properties passed down from the server info array of the load balancer. More... | |
| getMasterPos () | |
| Get the position of this master. More... | |
| getProperty ( $name) | |
| General read-only accessor. More... | |
| getSchemaPath () | |
| Return a path to the DBMS-specific schema file, otherwise default to tables.sql. More... | |
| getServer () | |
| Get the server hostname or IP address. More... | |
| getServerUptime () | |
| Determines how long the server has been up STUB. More... | |
| getSlavePos () | |
| Get the replication position of this slave. More... | |
| getWikiID () | |
| ignoreErrors ( $ignoreErrors=null) | |
| Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors. More... | |
| implicitOrderby () | |
| Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. More... | |
| indexExists ( $table, $index, $fname=__METHOD__) | |
| Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure. More... | |
| indexUnique ( $table, $index) | |
| Determines if a given index is unique. More... | |
| insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=array(), $selectOptions=array()) | |
| INSERT SELECT wrapper. More... | |
| isOpen () | |
| Is a connection to the database open? More... | |
| isQuotedIdentifier ( $name) | |
| Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers . More... | |
| isView ( $name) | |
| Differentiates between a TABLE and a VIEW. More... | |
| lastQuery () | |
| Return the last query that went through DatabaseBase::query() More... | |
| limitResult ( $sql, $limit, $offset=false) | |
| Construct a LIMIT query with optional offset. More... | |
| listViews ( $prefix=null, $fname=__METHOD__) | |
| Lists all the VIEWs in the database. More... | |
| lockIsFree ( $lockName, $method) | |
| Check to see if a named lock is available. More... | |
| lockTables ( $read, $write, $method, $lowPriority=true) | |
| Lock specific tables. More... | |
| lowPriorityOption () | |
| A string to insert into queries to show that they're low-priority, like MySQL's LOW_PRIORITY. More... | |
| makeGroupByWithHaving ( $options) | |
| Returns an optional GROUP BY with an optional HAVING. More... | |
| makeList ( $a, $mode=LIST_COMMA) | |
| Makes an encoded list of strings from an array. More... | |
| makeOrderBy ( $options) | |
| Returns an optional ORDER BY. More... | |
| makeWhereFrom2d ( $data, $baseKey, $subKey) | |
| Build a partial where clause from a 2-d array such as used for LinkBatch. More... | |
| masterPosWait (DBMasterPos $pos, $timeout) | |
| Wait for the slave to catch up to a given master position. More... | |
| maxListLen () | |
| Return the maximum number of items allowed in a list, or 0 for unlimited. More... | |
| nextSequenceValue ( $seqName) | |
| Returns an appropriately quoted sequence value for inserting a new row. More... | |
| onTransactionIdle ( $callback) | |
| Run an anonymous function as soon as there is no transaction pending. More... | |
| onTransactionPreCommitOrIdle ( $callback) | |
| Run an anonymous function before the current transaction commits or now if there is none. More... | |
| patchPath ( $patch) | |
| Get the full path of a patch file. More... | |
| ping () | |
| Ping the server and try to reconnect if it there is no connection. More... | |
| query ( $sql, $fname=__METHOD__, $tempIgnore=false) | |
| Run an SQL query and return the result. More... | |
| realTimestamps () | |
| Returns true if this database uses timestamps rather than integers. More... | |
| reportConnectionError ( $error='Unknown error') | |
| reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false) | |
| Report a query error. More... | |
| resultObject ( $result) | |
| Take the result from a query, and wrap it in a ResultWrapper if necessary. More... | |
| rollback ( $fname=__METHOD__, $flush='') | |
| Rollback a transaction previously started using begin(). More... | |
| searchableIPs () | |
| Returns true if this database can do a native search on IP columns e.g. More... | |
| select ( $table, $vars, $conds='', $fname=__METHOD__, $options=array(), $join_conds=array()) | |
| Execute a SELECT query constructed using the various parameters provided. More... | |
| selectDB ( $db) | |
| Change the current database. More... | |
| selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=array()) | |
| A SELECT wrapper which returns a single field from a single result row. More... | |
| selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=array(), $join_conds=array()) | |
| Single row SELECT wrapper. More... | |
| selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=array(), $join_conds=array()) | |
| The equivalent of DatabaseBase::select() except that the constructed SQL is returned, instead of being immediately executed. More... | |
| setBigSelects ( $value=true) | |
| Allow or deny "big selects" for this session only. More... | |
| setFakeMaster ( $enabled=true) | |
| Make this connection a fake master. More... | |
| setFakeSlaveLag ( $lag) | |
| Set lag time in seconds for a fake slave. More... | |
| setFileHandle ( $fh) | |
| Set the filehandle to copy write statements to. More... | |
| setFlag ( $flag) | |
| Set a flag for this connection. More... | |
| setLBInfo ( $name, $value=null) | |
| Set the LB info array, or a member of it. More... | |
| setSchemaVars ( $vars) | |
| Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. More... | |
| setSessionOptions (array $options) | |
| Override database's default behavior. More... | |
| sourceFile ( $filename, $lineCallback=false, $resultCallback=false, $fname=false, $inputCallback=false) | |
| Read and execute SQL commands from a file. More... | |
| sourceStream ( $fp, $lineCallback=false, $resultCallback=false, $fname=__METHOD__, $inputCallback=false) | |
| Read and execute commands from an open file handle. More... | |
| startAtomic ( $fname=__METHOD__) | |
| Begin an atomic section of statements. More... | |
| streamStatementEnd (&$sql, &$newLine) | |
| Called by sourceStream() to check if we've reached a statement end. More... | |
| strictIPs () | |
| Returns true if this database is strict about what can be put into an IP field. More... | |
| strreplace ( $orig, $old, $new) | |
| Returns a comand for str_replace function in SQL query. More... | |
| tableExists ( $table, $fname=__METHOD__) | |
| Query whether a given table exists. More... | |
| tableNames () | |
| Fetch a number of table names into an array This is handy when you need to construct SQL for joins. More... | |
| tableNamesN () | |
| Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. More... | |
| tableNamesWithAlias ( $tables) | |
| Gets an array of aliased table names. More... | |
| tableNameWithAlias ( $name, $alias=false) | |
| Get an aliased table name e.g. More... | |
| tablePrefix ( $prefix=null) | |
| Get/set the table prefix. More... | |
| timestamp ( $ts=0) | |
| Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More... | |
| timestampOrNull ( $ts=null) | |
| Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More... | |
| trxLevel () | |
| Gets the current transaction level. More... | |
| unlockTables ( $method) | |
| Unlock specific tables. More... | |
| update ( $table, $values, $conds, $fname=__METHOD__, $options=array()) | |
| UPDATE wrapper. More... | |
| upsert ( $table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__) | |
| INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More... | |
| useIndexClause ( $index) | |
| USE INDEX clause. More... | |
| wasLockTimeout () | |
| Determines if the last failure was due to a lock timeout STUB. More... | |
| writesOrCallbacksPending () | |
| Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from DatabaseSqlite | |
| static | fixIgnore ( $options) |
| static | generateFileName ( $dir, $dbName) |
| Generates a database file name. More... | |
| static | getFulltextSearchModule () |
| Returns version of currently supported SQLite fulltext search module or false if none present. More... | |
| Static Public Member Functions inherited from DatabaseBase | |
| static | factory ( $dbType, $p=array()) |
| Given a DB type, construct the name of the appropriate child class of DatabaseBase. More... | |
| static | generalizeSQL ( $sql) |
| Removes most variables from an SQL query and replaces them with X or N for numbers. More... | |
| Public Attributes inherited from DatabaseSqlite | |
| string | $mDatabaseFile |
| File name for SQLite database file *. More... | |
| Public Attributes inherited from DatabaseBase | |
| $mDBname | |
| $mPassword | |
| $mUser | |
| const | DEADLOCK_DELAY_MAX = 1500000 |
| Maximum time to wait before retry. More... | |
| const | DEADLOCK_DELAY_MIN = 500000 |
| Minimum time to wait before retry, in microseconds. More... | |
| const | DEADLOCK_TRIES = 4 |
| Number of times to re-try an operation in case of deadlock. More... | |
| Protected Member Functions inherited from DatabaseSqlite | |
| closeConnection () | |
| Does not actually close the connection, just destroys the reference for GC to do its work. More... | |
| doBegin ( $fname='') | |
| Issues the BEGIN command to the database server. More... | |
| doCommit ( $fname='') | |
| Issues the COMMIT command to the database server. More... | |
| doQuery ( $sql) | |
| SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result. More... | |
| doRollback ( $fname='') | |
| Issues the ROLLBACK command to the database server. More... | |
| makeUpdateOptionsArray ( $options) | |
| replaceVars ( $s) | |
| Protected Member Functions inherited from DatabaseBase | |
| escapeLikeInternal ( $s) | |
| fillPreparedArg ( $matches) | |
| preg_callback func for fillPrepared() The arguments should be in $this->preparedArgs and must not be touched while we're doing this. More... | |
| freePrepared ( $prepared) | |
| Free a prepared query, generated by prepare(). More... | |
| getDefaultSchemaVars () | |
| Get schema variables to use if none have been set via setSchemaVars(). More... | |
| getSchemaVars () | |
| Get schema variables. More... | |
| indexNameCallback ( $matches) | |
| Index name callback. More... | |
| installErrorHandler () | |
| makeUpdateOptions ( $options) | |
| Make UPDATE options for the DatabaseBase::update function. More... | |
| nativeReplace ( $table, $rows, $fname) | |
| REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More... | |
| prepare ( $sql, $func='DatabaseBase::prepare') | |
| Intended to be compatible with the PEAR::DB wrapper functions. More... | |
| replaceSchemaVars ( $ins) | |
| Database independent variable replacement. More... | |
| restoreErrorHandler () | |
| runOnTransactionIdleCallbacks () | |
| Actually any "on transaction idle" callbacks. More... | |
| runOnTransactionPreCommitCallbacks () | |
| Actually any "on transaction pre-commit" callbacks. More... | |
| tableNameCallback ( $matches) | |
| Table name callback. More... | |
| tableNamesWithUseIndexOrJOIN ( $tables, $use_index=array(), $join_conds=array()) | |
| Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX clause. More... | |
| Protected Attributes inherited from DatabaseSqlite | |
| FSLockManager | $lockMgr |
| (hopefully on the same server as the DB) * More... | |
| int | $mAffectedRows |
| The number of rows affected as an integer *. More... | |
| PDO | $mConn |
| resource | $mLastResult |
| Protected Attributes inherited from DatabaseBase | |
| string[] | $allViews = null |
| $delimiter = ';' | |
| resource | $fileHandle = null |
| $htmlErrors | |
| resource | $mConn = null |
| Database connection *. More... | |
| $mDefaultBigSelects = null | |
| $mDoneWrites = false | |
| $mErrorCount = 0 | |
| $mFlags | |
| $mForeign | |
| $mLastQuery = '' | |
| $mLBInfo = array() | |
| $mOpened = false | |
| $mPHPError = false | |
| $mSchema | |
| $mSchemaVars = false | |
| $mServer | |
| $mTablePrefix | |
| callable[] | $mTrxIdleCallbacks = array() |
| int | $mTrxLevel = 0 |
| Either 1 if a transaction is active or 0 otherwise. More... | |
| callable[] | $mTrxPreCommitCallbacks = array() |
| $preparedArgs | |
Detailed Description
This class allows simple acccess to a SQLite database independently from main database settings.
Definition at line 974 of file DatabaseSqlite.php.
Constructor & Destructor Documentation
◆ __construct()
| DatabaseSqliteStandalone::__construct | ( | $fileName, | |
$flags = 0 |
|||
| ) |
Definition at line 975 of file DatabaseSqlite.php.
References $flags, DatabaseSqlite\openFile(), and DatabaseBase\tablePrefix().
The documentation for this class was generated from the following file:
- includes/db/DatabaseSqlite.php
