mongodb\Command createIndexes()

createIndexes() public method

Creates indexes in the collection.

public boolean createIndexes ( $collectionName, $indexes )
$collectionName string

Collection name.

$indexes array[]

Indexes specification. Each specification should be an array in format: optionName => value The main options are:

  • keys: array, column names with sort order, to be indexed. This option is mandatory.
  • unique: boolean, whether to create unique index.
  • name: string, the name of the index, if not set it will be generated automatically.
  • background: boolean, whether to bind index in the background.
  • sparse: boolean, whether index should reference only documents with the specified field.

See [[https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options-for-all-index-types]] for the full list of options.

return boolean

Whether operation was successful.

doc_Yii
2016-10-30 17:07:45
Comments
Leave a Comment

Please login to continue.