mongodb\Collection createIndexes()

createIndexes() public method (available since version 2.1)

Creates several indexes at once.

Example:

$collection = Yii::$app->mongo->getCollection('customer');
$collection->createIndexes([
    [
        'key' => ['name'],
    ],
    [
        'key' => [
            'email' => 1,
            'address' => -1,
        ],
        'name' => 'my_index'
    ],
]);

public boolean createIndexes ( $indexes )
$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.

Links:

http://www.yiiframework.com/doc-2.0/yii-mongodb-collection.html#createIndexes()-detail

doc_Yii

2025-01-10 15:47:30

Comments