MediaWiki master
Wikimedia\Rdbms\Platform\SqlitePlatform Class Reference

Inherits Wikimedia\Rdbms\Platform\SQLPlatform.

Collaboration diagram for Wikimedia\Rdbms\Platform\SqlitePlatform:

Public Member Functions

 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query.
 
 buildGreatest ( $fields, $values)
 Build a GREATEST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35 in IDatabase, moved to ISQLPlatform in 1.39

 
 buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query.
 
 buildLeast ( $fields, $values)
 Build a LEAST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35 in IDatabase, moved to ISQLPlatform in 1.39

 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
Stability: stable
to override

 
 dropTableSqlText ( $table)
 
 isTransactableQuery (Query $sql)
 Determine whether a SQL statement is sensitive to isolation level.
 
 tableName (string $name, $format='quoted')
 Format a table name ready for use in constructing an SQL query.
 
 unionQueries ( $sqls, $all, $options=[])
 
 unionSupportsOrderAndLimit ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\Platform\SQLPlatform
 __construct (DbQuoter $quoter, LoggerInterface $logger=null, DatabaseDomain $currentDomain=null, $errorLogger=null)
 
 addIdentifierQuotes ( $s)
 Escape a SQL identifier (e.g.
 
 anyChar ()
 Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.
 
 anyString ()
 Returns a token for buildLike() that denotes a '' to be used in a LIKE query.
 
 assertValidUpsertSetArray (array $set, array $uniqueKey, array $rows)
 
 bitAnd ( $fieldLeft, $fieldRight)
 
 bitNot ( $field)
 
 bitOr ( $fieldLeft, $fieldRight)
 
 buildComparison (string $op, array $conds)
 Build a condition comparing multiple values, for use with indexes that cover multiple fields, common when e.g.
 
 buildExcludedValue ( $column)
 Build a reference to a column value from the conflicting proposed upsert() row.
 
 buildIntegerCast ( $field)
 
 buildLike ( $param,... $params)
 LIKE statement wrapper.
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.
 
 conditional ( $cond, $caseTrueExpression, $caseFalseExpression)
 Returns an SQL expression for a simple conditional.
 
 decodeExpiry ( $expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format.
 
 deleteJoinSqlText ( $delTable, $joinTable, $delVar, $joinVar, $conds)
 
 deleteSqlText ( $table, $conds)
 
 dispatchingInsertSqlText ( $table, $rows, $options)
 
 encodeExpiry ( $expiry)
 Encode an expiry time into the DBMS dependent format.
 
 escapeLikeInternal ( $s, $escapeChar='`')
 
 extractSingleFieldFromList ( $var)
 
 extractTableNameComponents (string $name)
 Extract the dot-separated components of a table name, preserving identifier quotation.
 
 factorConds ( $condsArray)
 Given an array of condition arrays representing an OR list of AND lists, for example:
 
 fieldNameWithAlias ( $name, $alias=false)
 Get an aliased field name e.g.
 
 getCurrentDomain ()
 
 getInfinity ()
 Find out when 'infinity' is.
 
 getQueryVerb ( $sql)
 
 getTableAliases ()
 
 ignoreIndexClause ( $index)
 IGNORE INDEX clause.
 
 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.
 
 indexName ( $index)
 Allows for index remapping in queries where this is not consistent across DBMS.
 
 insertNonConflictingSqlText ( $table, array $rows)
 
 insertSelectNativeSqlText ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds)
 
 insertSqlText ( $table, array $rows)
 
 isFlagInOptions ( $option, array $options)
 
 isQuotedIdentifier ( $name)
 Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers.
 
 limitResult ( $sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset.
 
 lockIsFreeSQLText ( $lockName)
 
 lockSQLText ( $lockName, $timeout)
 
 makeInsertLists (array $rows, $aliasPrefix='', array $typeByColumn=[])
 Make SQL lists of columns, row tuples, and column aliases for INSERT/VALUES expressions.
 
 makeKeyCollisionCondition (array $rows, array $uniqueKey)
 Build an SQL condition to find rows with matching key values to those in $rows.
 
 makeList (array $a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array.
 
 makeWhereFrom2d ( $data, $baseKey, $subKey)
 Build a "OR" condition with pairs from a two-dimensional array.
 
 normalizeConditions ( $conds, $fname)
 
 normalizeOptions ( $options)
 
 normalizeUpsertParams ( $uniqueKeys, &$rows)
 Validate and normalize parameters to upsert() or replace()
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database/schema.
 
 releaseSavepointSqlText ( $identifier)
 
 replaceVars ( $ins)
 Database-independent variable replacement.
 
 rollbackSqlText ()
 
 rollbackToSavepointSqlText ( $identifier)
 
 savepointSqlText ( $identifier)
 
 selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Take the same arguments as IDatabase::select() and return the SQL it would use.
 
 setCurrentDomain (DatabaseDomain $currentDomain)
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB.
 
 setPrefix ( $prefix)
 
 setSchemaVars ( $vars)
 Set schema variables to be used when streaming commands from SQL files or stdin.
 
 setTableAliases (array $aliases)
 Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.
 
 strreplace ( $orig, $old, $new)
 Returns a SQL expression for simple string replacement (e.g.
 
 tableNames (... $tables)
 Fetch a number of table names into an associative array.
 
 tableNamesN (... $tables)
 Fetch a number of table names into a zero-indexed numerical array.
 
 timestamp ( $ts=0)
 Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
 
 timestampOrNull ( $ts=null)
 Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
 
 unlockSQLText ( $lockName)
 
 updateSqlText ( $table, $set, $conds, $options)
 
 useIndexClause ( $index)
 USE INDEX clause.
 
- Public Member Functions inherited from Wikimedia\Rdbms\Platform\ISQLPlatform
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function.
 

Protected Member Functions

 makeInsertNonConflictingVerbAndOptions ()
 
 makeSelectOptions (array $options)
 Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.
 
 makeUpdateOptionsArray ( $options)
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Platform\SQLPlatform
 assertBuildSubstringParams ( $startPosition, $length)
 Check type and bounds for parameters to self::buildSubstring()
 
 assertValidUpsertRowArray (array $rows, array $uniqueKey)
 
 buildSuperlative ( $sqlfunc, $fields, $values)
 Build a superlative function statement comparing columns/values.
 
 fieldNamesWithAlias ( $fields)
 Gets an array of aliased field names.
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars().
 
 getIdentifierQuoteChar ()
 Get the character used for identifier quoting.
 
 getSchemaVars ()
 Get schema variables.
 
 makeGroupByWithHaving ( $options)
 Returns an optional GROUP BY with an optional HAVING.
 
 makeOrderBy ( $options)
 Returns an optional ORDER BY.
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the Database::update function.
 
 normalizeJoinType (string $joinType)
 Validate and normalize a join type.
 
 normalizeRowArray (array $rowOrRows)
 
 relationSchemaQualifier ()
 
 tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[])
 Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause.
 
 tableNameWithAlias ( $table, $alias=false)
 Get an aliased table name.
 

Additional Inherited Members

- Public Attributes inherited from Wikimedia\Rdbms\Platform\ISQLPlatform
const QUERY_PSEUDO_PERMANENT = 2
 Track a TEMPORARY table CREATE as if it was for a permanent table (for testing)
 
- Protected Attributes inherited from Wikimedia\Rdbms\Platform\SQLPlatform
DatabaseDomain null $currentDomain
 
callable $errorLogger
 Error logging callback.
 
string[] $indexAliases = []
 Current map of (index alias => index)
 
LoggerInterface $logger
 
DbQuoter $quoter
 
array null $schemaVars
 Current variables use for schema element placeholders.
 
array[] $tableAliases = []
 Current map of (table => (dbname, schema, prefix) map)
 

Detailed Description

Since
1.38
See also
ISQLPlatform

Definition at line 28 of file SqlitePlatform.php.

Member Function Documentation

◆ buildConcat()

Wikimedia\Rdbms\Platform\SqlitePlatform::buildConcat ( $stringList)

Build a concatenation list to feed into a SQL query.

Parameters
string[]$stringList
Returns
string

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 43 of file SqlitePlatform.php.

◆ buildGreatest()

Wikimedia\Rdbms\Platform\SqlitePlatform::buildGreatest ( $fields,
$values )

Build a GREATEST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.

Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35 in IDatabase, moved to ISQLPlatform in 1.39

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 29 of file SqlitePlatform.php.

References Wikimedia\Rdbms\Platform\SQLPlatform\buildSuperlative().

◆ buildGroupConcatField()

Wikimedia\Rdbms\Platform\SqlitePlatform::buildGroupConcatField ( $delim,
$table,
$field,
$conds = '',
$join_conds = [] )

Build a GROUP_CONCAT or equivalent statement for a query.

This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.

Parameters
string$delimGlue to bind the results together
string | array$tableUnqualified name of table
string$fieldField name
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>>|array<int,string|IExpression>$conds Conditions
string | array$join_condsJoin conditions
Returns
string SQL text
Since
1.23

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 104 of file SqlitePlatform.php.

References Wikimedia\Rdbms\Platform\SQLPlatform\selectSQLText().

◆ buildLeast()

Wikimedia\Rdbms\Platform\SqlitePlatform::buildLeast ( $fields,
$values )

Build a LEAST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.

Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35 in IDatabase, moved to ISQLPlatform in 1.39

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 33 of file SqlitePlatform.php.

References Wikimedia\Rdbms\Platform\SQLPlatform\buildSuperlative().

◆ buildStringCast()

Wikimedia\Rdbms\Platform\SqlitePlatform::buildStringCast ( $field)
Parameters
string$fieldField or column to cast
Returns
string
Since
1.28

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 80 of file SqlitePlatform.php.

◆ buildSubstring()

Wikimedia\Rdbms\Platform\SqlitePlatform::buildSubstring ( $input,
$startPosition,
$length = null )

Stability: stable
to override

Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 66 of file SqlitePlatform.php.

References $params, and Wikimedia\Rdbms\Platform\SQLPlatform\assertBuildSubstringParams().

◆ dropTableSqlText()

Wikimedia\Rdbms\Platform\SqlitePlatform::dropTableSqlText ( $table)

◆ isTransactableQuery()

Wikimedia\Rdbms\Platform\SqlitePlatform::isTransactableQuery ( Query $sql)

Determine whether a SQL statement is sensitive to isolation level.

A SQL statement is considered transactable if its result could vary depending on the transaction isolation level. Operational commands such as 'SET' and 'SHOW' are not considered to be transactable.

Main purpose: Used by query() to decide whether to begin a transaction before the current query (in DBO_TRX mode, on by default).

Returns
bool

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 147 of file SqlitePlatform.php.

References Wikimedia\Rdbms\Query\getVerb().

◆ makeInsertNonConflictingVerbAndOptions()

Wikimedia\Rdbms\Platform\SqlitePlatform::makeInsertNonConflictingVerbAndOptions ( )
protected
Stability: stable
to override
Returns
string[] ("INSERT"-style SQL verb, "ON CONFLICT"-style clause or "")
Since
1.35

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 112 of file SqlitePlatform.php.

◆ makeSelectOptions()

Wikimedia\Rdbms\Platform\SqlitePlatform::makeSelectOptions ( array $options)
protected

Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.

See also
Database::select()
Stability: stable
to override
Parameters
array$optionsAssociative array of options to be turned into an SQL query, valid keys are listed in the function.
Returns
string[] (START OPTIONS, PRE-LIMIT TAIL, POST-LIMIT TAIL)

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 93 of file SqlitePlatform.php.

◆ makeUpdateOptionsArray()

Wikimedia\Rdbms\Platform\SqlitePlatform::makeUpdateOptionsArray ( $options)
protected
Parameters
array$options
Returns
array

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 120 of file SqlitePlatform.php.

◆ tableName()

Wikimedia\Rdbms\Platform\SqlitePlatform::tableName ( string $name,
$format = 'quoted' )

Format a table name ready for use in constructing an SQL query.

This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.

All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query() directly.

Note
This function does not sanitize user input. It is not safe to use this function to escape user input.
Parameters
string$nameUnqualified name of table (no quotes, db, schema, nor table prefix)
string$formatOne of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name
Returns
string Qualified table name (includes any applicable prefix or foreign db/schema)

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 84 of file SqlitePlatform.php.

Referenced by Wikimedia\Rdbms\Platform\SqlitePlatform\dropTableSqlText().

◆ unionQueries()

Wikimedia\Rdbms\Platform\SqlitePlatform::unionQueries ( $sqls,
$all,
$options = [] )
Parameters
string[]$sqls
bool$allWhether to "UNION ALL" or not
array$optionsQuery options, will be ignored in Sqlite
Returns
string

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 53 of file SqlitePlatform.php.

◆ unionSupportsOrderAndLimit()

Wikimedia\Rdbms\Platform\SqlitePlatform::unionSupportsOrderAndLimit ( )
Returns
bool

Reimplemented from Wikimedia\Rdbms\Platform\SQLPlatform.

Definition at line 62 of file SqlitePlatform.php.


The documentation for this class was generated from the following file: