db\pgsql\QueryBuilder createIndex()

createIndex() public method

Builds a SQL statement for creating a new index.

See also http://www.postgresql.org/docs/8.2/static/sql-createindex.html.

public string createIndex ( $name, $table, $columns, $unique = false )
$name string

The name of the index. The name will be properly quoted by the method.

$table string

The table that the new index will be created for. The table name will be properly quoted by the method.

$columns string|array

The column(s) that should be included in the index. If there are multiple columns, separate them with commas or use an array to represent them. Each column name will be properly quoted by the method, unless a parenthesis is found in the name.

$unique boolean|string

Whether to make this a UNIQUE index constraint. You can pass true or INDEX_UNIQUE to create a unique index, false to make a non-unique index using the default index type, or one of the following constants to specify the index method to use: INDEX_B_TREE, INDEX_HASH, INDEX_GIST, INDEX_GIN.

return string

The SQL statement for creating a new index.

doc_Yii
2016-10-30 16:58:45
Comments
Leave a Comment

Please login to continue.