Class craft\db\pgsql\QueryBuilder

Inheritance: craft\db\pgsql\QueryBuilder » yii\db\pgsql\QueryBuilder » yii\db\QueryBuilder » yii\base\BaseObject
Implements: yii\base\Configurable
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/db/pgsql/QueryBuilder.php

Public Properties
Property	Type	Description	Defined By
`$db`	yii\db\Connection	The database connection.	yii\db\QueryBuilder
`$separator`	string	The separator between different fragments of a SQL statement.	yii\db\QueryBuilder
`$typeMap`	array	Mapping from abstract column types (keys) to physical column types (values).	yii\db\pgsql\QueryBuilder

Protected Properties
Property	Type	Description	Defined By
`$conditionBuilders`	array	Map of query condition to builder methods.	yii\db\QueryBuilder
`$conditionClasses`	array	Map of condition aliases to condition classes.	yii\db\QueryBuilder
`$expressionBuilders`	string[], yii\db\ExpressionBuilderInterface	Maps expression class to expression builder class.	yii\db\QueryBuilder

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`addCheck()`	Creates a SQL command for adding a check constraint to an existing table.	yii\db\QueryBuilder
`addColumn()`	Builds a SQL statement for adding a new DB column.	yii\db\QueryBuilder
`addCommentOnColumn()`	Builds a SQL command for adding comment to column.	yii\db\QueryBuilder
`addCommentOnTable()`	Builds a SQL command for adding comment to table.	yii\db\QueryBuilder
`addDefaultValue()`	Creates a SQL command for adding a default value constraint to an existing table.	yii\db\QueryBuilder
`addForeignKey()`	Builds a SQL statement for adding a foreign key constraint to an existing table.	yii\db\QueryBuilder
`addPrimaryKey()`	Builds a SQL statement for adding a primary key constraint to an existing table.	yii\db\QueryBuilder
`addUnique()`	Creates a SQL command for adding an unique constraint to an existing table.	yii\db\QueryBuilder
`alterColumn()`	Builds a SQL statement for changing the definition of a column.	yii\db\pgsql\QueryBuilder
`batchInsert()`	{@inheritdoc}	yii\db\pgsql\QueryBuilder
`bindParam()`	Helper method to add $value to $params array using PARAM_PREFIX.	yii\db\QueryBuilder
`build()`	Generates a SELECT SQL statement from a yii\db\Query object.	yii\db\QueryBuilder
`buildAndCondition()`	Connects two or more SQL expressions with the `AND` or `OR` operator.	yii\db\QueryBuilder
`buildBetweenCondition()`	Creates an SQL expressions with the `BETWEEN` operator.	yii\db\QueryBuilder
`buildColumns()`	Processes columns and properly quotes them if necessary.	yii\db\QueryBuilder
`buildCondition()`	Parses the condition specification and generates the corresponding SQL expression.	yii\db\QueryBuilder
`buildExistsCondition()`	Creates an SQL expressions with the `EXISTS` operator.	yii\db\QueryBuilder
`buildExpression()`	Builds given $expression	yii\db\QueryBuilder
`buildFrom()`		yii\db\QueryBuilder
`buildGroupBy()`		yii\db\QueryBuilder
`buildHashCondition()`	Creates a condition based on column-value pairs.	yii\db\QueryBuilder
`buildHaving()`		yii\db\QueryBuilder
`buildInCondition()`	Creates an SQL expressions with the `IN` operator.	yii\db\QueryBuilder
`buildJoin()`		yii\db\QueryBuilder
`buildLikeCondition()`	Creates an SQL expressions with the `LIKE` operator.	yii\db\QueryBuilder
`buildLimit()`		yii\db\QueryBuilder
`buildNotCondition()`	Inverts an SQL expressions with `NOT` operator.	yii\db\QueryBuilder
`buildOrderBy()`		yii\db\QueryBuilder
`buildOrderByAndLimit()`	Builds the ORDER BY and LIMIT/OFFSET clauses and appends them to the given SQL.	yii\db\QueryBuilder
`buildSelect()`		yii\db\QueryBuilder
`buildSimpleCondition()`	Creates an SQL expressions like `"column" operator value`.	yii\db\QueryBuilder
`buildUnion()`		yii\db\QueryBuilder
`buildWhere()`		yii\db\QueryBuilder
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`checkIntegrity()`	Builds a SQL statement for enabling or disabling integrity check.	yii\db\pgsql\QueryBuilder
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`createConditionFromArray()`	Transforms $condition defined in array format (as described in yii\db\Query::where() to instance of \yii\db\yii\db\condition\ConditionInterface according to $conditionClasses map.	yii\db\QueryBuilder
`createIndex()`	Builds a SQL statement for creating a new index.	yii\db\pgsql\QueryBuilder
`createTable()`	Builds a SQL statement for creating a new DB table.	yii\db\QueryBuilder
`createView()`	Creates a SQL View.	yii\db\QueryBuilder
`delete()`	Creates a DELETE SQL statement.	yii\db\QueryBuilder
`dropCheck()`	Creates a SQL command for dropping a check constraint.	yii\db\QueryBuilder
`dropColumn()`	Builds a SQL statement for dropping a DB column.	yii\db\QueryBuilder
`dropCommentFromColumn()`	Builds a SQL command for adding comment to column.	yii\db\QueryBuilder
`dropCommentFromTable()`	Builds a SQL command for adding comment to table.	yii\db\QueryBuilder
`dropDefaultValue()`	Creates a SQL command for dropping a default value constraint.	yii\db\QueryBuilder
`dropForeignKey()`	Builds a SQL statement for dropping a foreign key constraint.	yii\db\QueryBuilder
`dropIndex()`	Builds a SQL statement for dropping an index.	yii\db\pgsql\QueryBuilder
`dropPrimaryKey()`	Builds a SQL statement for removing a primary key constraint to an existing table.	yii\db\QueryBuilder
`dropTable()`	Builds a SQL statement for dropping a DB table.	yii\db\QueryBuilder
`dropTableIfExists()`	Builds a SQL statement for dropping a DB table if it exists.	craft\db\pgsql\QueryBuilder
`dropUnique()`	Creates a SQL command for dropping an unique constraint.	yii\db\QueryBuilder
`dropView()`	Drops a SQL View.	yii\db\QueryBuilder
`fixedOrder()`	Builds the SQL expression used to return a DB result in a fixed order.	craft\db\pgsql\QueryBuilder
`getColumnType()`	Converts an abstract column type into a physical column type.	yii\db\QueryBuilder
`getExpressionBuilder()`	Gets object of yii\db\ExpressionBuilderInterface that is suitable for $expression.	yii\db\QueryBuilder
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	yii\base\BaseObject
`insert()`	{@inheritdoc}	yii\db\pgsql\QueryBuilder
`renameColumn()`	Builds a SQL statement for renaming a column.	yii\db\QueryBuilder
`renameSequence()`	Builds a SQL statement for renaming a DB sequence.	craft\db\pgsql\QueryBuilder
`renameTable()`	Builds a SQL statement for renaming a DB table.	yii\db\pgsql\QueryBuilder
`replace()`	Builds a SQL statement for replacing some text with other text in a given table column.	craft\db\pgsql\QueryBuilder
`resetSequence()`	Creates a SQL statement for resetting the sequence value of a table's primary key.	yii\db\pgsql\QueryBuilder
`selectExists()`	Creates a SELECT EXISTS() SQL statement.	yii\db\QueryBuilder
`setConditionClasses()`	Setter for $conditionClasses property.	yii\db\QueryBuilder
`setExpressionBuilders()`	Setter for $expressionBuilders property.	yii\db\QueryBuilder
`truncateTable()`	Builds a SQL statement for truncating a DB table.	yii\db\pgsql\QueryBuilder
`update()`	{@inheritdoc}	yii\db\pgsql\QueryBuilder
`upsert()`	{@inheritdoc}	yii\db\pgsql\QueryBuilder

Protected Methods
Method	Description	Defined By
`defaultConditionClasses()`	{@inheritdoc}	yii\db\pgsql\QueryBuilder
`defaultExpressionBuilders()`	{@inheritdoc}	yii\db\pgsql\QueryBuilder
`hasLimit()`	Checks to see if the given limit is effective.	yii\db\QueryBuilder
`hasOffset()`	Checks to see if the given offset is effective.	yii\db\QueryBuilder
`prepareInsertSelectSubQuery()`	Prepare select-subquery and field names for INSERT INTO .	yii\db\QueryBuilder
`prepareInsertValues()`	Prepares a `VALUES` part for an `INSERT` SQL statement.	yii\db\QueryBuilder
`prepareUpdateSets()`	Prepares a `SET` parts for an `UPDATE` SQL statement.	yii\db\QueryBuilder
`prepareUpsertColumns()`		yii\db\QueryBuilder

Constants
Constant	Value	Description	Defined By
`INDEX_B_TREE`	'btree'	Defines a B-tree index for createIndex().	yii\db\pgsql\QueryBuilder
`INDEX_GIN`	'gin'	Defines a GIN index for createIndex().	yii\db\pgsql\QueryBuilder
`INDEX_GIST`	'gist'	Defines a GiST index for createIndex().	yii\db\pgsql\QueryBuilder
`INDEX_HASH`	'hash'	Defines a hash index for createIndex().	yii\db\pgsql\QueryBuilder
`INDEX_UNIQUE`	'unique'	Defines a UNIQUE index for createIndex().	yii\db\pgsql\QueryBuilder
`PARAM_PREFIX`	':qp'	The prefix for automatically generated query binding parameters.	yii\db\QueryBuilder

Method Details

`dropTableIfExists()` public method #

Builds a SQL statement for dropping a DB table if it exists.

public string dropTableIfExists ( \craft\db\pgsql\string $table )

`$table`	string	The table to be dropped. The name will be properly quoted by the method.
return	string	The SQL statement for dropping a DB table.

`fixedOrder()` public method #

Builds the SQL expression used to return a DB result in a fixed order.

http://stackoverflow.com/a/1310188/684

public string fixedOrder ( \craft\db\pgsql\string $column, array $values )

`$column`	string	The column name that contains the values.
`$values`	array	The column values, in the order in which the rows should be returned in.
return	string	The SQL expression.

`renameSequence()` public method #

Builds a SQL statement for renaming a DB sequence.

public string renameSequence ( \craft\db\pgsql\string $oldName, \craft\db\pgsql\string $newName )

`$oldName`	string	The sequence to be renamed. The name will be properly quoted by the method.
`$newName`	string	The new sequence name. The name will be properly quoted by the method.
return	string	The SQL statement for renaming a DB table.

`replace()` public method #

Builds a SQL statement for replacing some text with other text in a given table column.

public string replace ( \craft\db\pgsql\string $table, \craft\db\pgsql\string $column, \craft\db\pgsql\string $find, \craft\db\pgsql\string $replace, $condition, array &$params )

`$table`	string	The table to be updated.
`$column`	string	The column to be searched.
`$find`	string	The text to be searched for.
`$replace`	string	The replacement text.
`$condition`	array, string	The condition that will be put in the WHERE part. Please refer to \craft\db\pgsql\Query::where() on how to specify condition.
`$params`	array	The binding parameters that will be generated by this method. They should be bound to the DB command later.
return	string	The SQL statement for replacing some text in a given table.

Method Details

dropTableIfExists() public method #

fixedOrder() public method #

renameSequence() public method #

replace() public method #

`dropTableIfExists()` public method #

`fixedOrder()` public method #

`renameSequence()` public method #

`replace()` public method #