|
| getFloatDeclarationSQL (array $column) |
|
| addIdentifierQuotes ( $s) |
| MySQL uses backticks for identifier quoting instead of the sql standard "double quotes". More...
|
|
| buildExcludedValue ( $column) |
| Build a reference to a column value from the conflicting proposed upsert() row. More...
|
|
| buildIntegerCast ( $field) |
|
| buildStringCast ( $field) |
| - Parameters
-
string | $field | Field or column to cast |
- Returns
- string
- Since
- 1.28 in IDatabase, moved to ISQLPlatform in 1.39
- Stability: stable
- to override
More...
|
|
| deleteJoinSqlText ( $delTable, $joinTable, $delVar, $joinVar, $conds) |
|
| ignoreIndexClause ( $index) |
|
| isQuotedIdentifier ( $name) |
|
| isTransactableQuery ( $sql) |
| Determine whether a SQL statement is sensitive to isolation level. More...
|
|
| lockIsFreeSQLText ( $lockName) |
|
| lockSQLText ( $lockName, $timeout) |
|
| makeLockName ( $lockName) |
|
| unlockSQLText ( $lockName) |
|
| useIndexClause ( $index) |
|
| __construct (DbQuoter $quoter, LoggerInterface $logger=null, DatabaseDomain $currentDomain=null, $errorLogger=null) |
|
| 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...
|
|
| assertValidUpsertSetArray (array $set, array $identityKey, array $rows) |
|
| bitAnd ( $fieldLeft, $fieldRight) |
| - Parameters
-
string | int | $fieldLeft | |
string | int | $fieldRight | |
- Returns
- string
More...
|
|
| bitNot ( $field) |
| - Parameters
-
- Returns
- string
More...
|
|
| bitOr ( $fieldLeft, $fieldRight) |
| - Parameters
-
string | int | $fieldLeft | |
string | int | $fieldRight | |
- Returns
- string
More...
|
|
| buildComparison (string $op, array $conds) |
| Build a condition comparing multiple values, for use with indexes that cover multiple fields, common when e.g. More...
|
|
| buildConcat ( $stringList) |
| Build a concatenation list to feed into a SQL query.- Parameters
-
string[] | $stringList | Raw SQL expression list; caller is responsible for escaping |
- Returns
- string
More...
|
|
| 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[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
- Returns
- mixed
- Since
- 1.35 in IDatabase, moved to ISQLPlatform in 1.39
More...
|
|
| 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 | $delim | Glue to bind the results together |
string | array | $table | Table name |
string | $field | Field name |
string | array | $conds | Conditions |
string | array | $join_conds | Join conditions |
- Returns
- string SQL text
- Since
- 1.23
More...
|
|
| 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[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
- Returns
- mixed
- Since
- 1.35 in IDatabase, moved to ISQLPlatform in 1.39
More...
|
|
| buildLike ( $param,... $params) |
| LIKE statement wrapper.This takes a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). Alternatively, the function could be provided with an array of aforementioned parameters.Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches for subpages of 'My page title'. Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ]; $query .= $dbr->buildLike( $pattern );- Since
- 1.16 in IDatabase, moved to ISQLPlatform in 1.39
- Parameters
-
array[] | string | LikeMatch | $param | |
| string|LikeMatch | ...$params |
- Returns
- string Fully built LIKE statement
More...
|
|
| buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) |
| Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. More...
|
|
| buildSubstring ( $input, $startPosition, $length=null) |
|
| conditional ( $cond, $caseTrueExpression, $caseFalseExpression) |
| Returns an SQL expression for a simple conditional.This doesn't need to be overridden unless CASE isn't supported in the RDBMS.- Parameters
-
string | array | $cond | SQL condition expression (yields a boolean) |
string | $caseTrueExpression | SQL expression to return when the condition is true |
string | $caseFalseExpression | SQL expression to return when the condition is false |
- Returns
- string SQL fragment
More...
|
|
| decodeExpiry ( $expiry, $format=TS_MW) |
| Decode an expiry time into a DBMS independent format. More...
|
|
| deleteSqlText ( $table, $conds) |
|
| dispatchingInsertSqlText ( $table, $rows, $options) |
|
| dropTableSqlText ( $table) |
|
| encodeExpiry ( $expiry) |
| Encode an expiry time into the DBMS dependent format. More...
|
|
| escapeLikeInternal ( $s, $escapeChar='`') |
|
| extractSingleFieldFromList ( $var) |
|
| factorConds ( $condsArray) |
| Given an array of condition arrays representing an OR list of AND lists, for example: More...
|
|
| fieldNameWithAlias ( $name, $alias=false) |
| Get an aliased field name e.g. More...
|
|
| getInfinity () |
| Find out when 'infinity' is.Most DBMSes support this. This is a special keyword for timestamps in PostgreSQL, and works with CHAR(14) as well because "i" sorts after all numbers.- Returns
- string
More...
|
|
| getQueryVerb ( $sql) |
|
| getTableAliases () |
|
| 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.- Returns
- bool
More...
|
|
| indexName ( $index) |
| Allows for index remapping in queries where this is not consistent across DBMS. More...
|
|
| insertNonConflictingSqlText ( $table, array $rows) |
|
| insertSelectNativeSqlText ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds) |
|
| insertSqlText ( $table, array $rows) |
|
| isFlagInOptions ( $option, array $options) |
|
| isWriteQuery ( $sql, $flags) |
| Determine whether a query writes to the DB. More...
|
|
| limitResult ( $sql, $limit, $offset=false) |
| Construct a LIMIT query with optional offset.The SQL should be adjusted so that only the first $limit rows are returned. If $offset is provided as well, then the first $offset rows should be discarded, and the next $limit rows should be returned. If the result of the query is not ordered, then the rows to be returned are theoretically arbitrary.$sql is expected to be a SELECT, if that makes a difference.- Parameters
-
string | $sql | SQL query we will append the limit too |
int | $limit | The SQL limit |
int | false | $offset | The SQL offset (default false) |
- Returns
- string
- Since
- 1.34 in IDatabase, moved to ISQLPlatform in 1.39
More...
|
|
| makeInsertLists (array $rows, $aliasPrefix='', array $typeByColumn=[]) |
| Make SQL lists of columns, row tuples, and column aliases for INSERT/VALUES expressions. More...
|
|
| makeKeyCollisionCondition (array $rows, array $uniqueKey) |
| Build an SQL condition to find rows with matching key values to those in $rows. More...
|
|
| makeList (array $a, $mode=self::LIST_COMMA) |
| Makes an encoded list of strings from an array. More...
|
|
| makeWhereFrom2d ( $data, $baseKey, $subKey) |
| Build a partial where clause from a 2-d array such as used for LinkBatch. More...
|
|
| normalizeConditions ( $conds, $fname) |
|
| normalizeOptions ( $options) |
|
| normalizeUpsertParams ( $uniqueKeys, &$rows) |
| Validate and normalize parameters to upsert() or replace() More...
|
|
| qualifiedTableComponents ( $name) |
| Get the table components needed for a query given the currently selected database. More...
|
|
| releaseSavepointSqlText ( $identifier) |
|
| replaceVars ( $ins) |
| Database-independent variable replacement. More...
|
|
| 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.This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().- See also
- IDatabase::select()
- Parameters
-
string | array | $table | Table name(s) |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
string | array | $join_conds | Join conditions |
- Returns
- string SQL query string
More...
|
|
| setCurrentDomain (DatabaseDomain $currentDomain) |
|
| setIndexAliases (array $aliases) |
| Convert certain index names to alternative names before querying the DB.Note that this applies to indexes regardless of the table they belong to.This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.- Parameters
-
- Since
- 1.31 in IDatabase, moved to ISQLPlatform in 1.39
More...
|
|
| setPrefix ( $prefix) |
|
| setSchemaVars ( $vars) |
| Set schema variables to be used when streaming commands from SQL files or stdin. More...
|
|
| 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.For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user , somedb.user, somedb.someschema.user will used literally.Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.- Parameters
-
array[] | $aliases | Map of (table => (dbname, schema, prefix) map) |
- Since
- 1.28 in IDatabase, moved to ISQLPlatform in 1.39
More...
|
|
| strreplace ( $orig, $old, $new) |
| Returns a SQL expression for simple string replacement (e.g.REPLACE() in mysql)- Parameters
-
string | $orig | Column to modify |
string | $old | Column to seek |
string | $new | Column to replace with |
- Returns
- string
More...
|
|
| tableName ( $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 | $name | Database table name |
string | $format | One 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 Full database name
More...
|
|
| tableNames (... $tables) |
| Fetch a number of table names into an associative array. More...
|
|
| tableNamesN (... $tables) |
| Fetch a number of table names into a zero-indexed numerical array. More...
|
|
| 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.The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.- Parameters
-
- Returns
- string
More...
|
|
| 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. More...
|
|
| unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[]) |
| Construct a UNION query for permutations of conditions. More...
|
|
| unionQueries ( $sqls, $all) |
| Construct a UNION query.This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax. - Parameters
-
array | $sqls | SQL statements to combine |
bool | $all | Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT |
- Returns
- string SQL fragment
More...
|
|
| unionSupportsOrderAndLimit () |
| Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.- Returns
- bool
More...
|
|
| updateSqlText ( $table, $set, $conds, $options) |
|
| buildSubString ( $input, $startPosition, $length=null) |
| Build a SUBSTRING function. More...
|
|