Class yii\mongodb\file\Collection

List of pipeline operators.

Optional parameters.

{@see \yii\mongodb\Command::aggregate()}

The result of the aggregation.

on failure.

Array of arrays or objects to be inserted.

List of options in format: optionName => optionValue.

{@see \yii\mongodb\Command::batchInsert()}

Inserted data, each row will have "_id" key assigned to it.

on failure.

Query condition

List of options in format: optionName => optionValue.

{@see \yii\mongodb\Command::count()}

Records count.

Column name or list of column names. If array is given, each element in the array has as key the field name, and as value either 1 for ascending sort, or -1 for descending sort. You can specify field using native numeric key with the field name as a value, in this case ascending sort will be used. For example:

[
    'name',
    'status' => -1,
]

List of options in format: optionName => optionValue.

{@see \yii\mongodb\Command::createIndexes()}

Whether the operation successful.

on failure.

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: bool, whether to create unique index.
• name: string, the name of the index, if not set it will be generated automatically.
• background: bool, whether to bind index in the background.
• sparse: bool, 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.

{@see \yii\mongodb\Command::createIndexes()}

Whether operation was successful.

Column to use.

Query parameters.

List of options in format: optionName => optionValue.

{@see \yii\mongodb\Command::distinct()}

Array of distinct values, or "false" on failure.

on failure.

Query condition.

{@see \yii\mongodb\Command::dropIndexes()}

Count of dropped indexes.

on failure.

Column name or list of column names. If array is given, each element in the array has as key the field name, and as value either 1 for ascending sort, or -1 for descending sort. Use value 'text' to specify text index. You can specify field using native numeric key with the field name as a value, in this case ascending sort will be used. For example:

[
    'name',
    'status' => -1,
    'description' => 'text',
]

{@see \yii\mongodb\Command::dropIndexes()}

Whether the operation successful.

on failure.

Wildcard for name of the indexes to be dropped. You can use * to drop all indexes.

{@see \yii\mongodb\Command::dropIndexes()}

Count of dropped indexes.

Query condition

Update criteria

List of options in format: optionName => optionValue.

{@see \yii\mongodb\Command::findAndModify()}

The original document, or the modified document when $options['new'] is set.

on failure.

Query condition

Fields to be selected

Query options (available since 2.1).

{@see \yii\mongodb\find()}

The single document. Null is returned if the query results in nothing.

Full name of this collection, including database name.

Fields to group by. If an array or non-code object is passed, it will be the key used to group results. If instance of \MongoDB\BSON\Javascript passed, it will be treated as a function that returns the key to group by.

Initial value of the aggregation counter object.

Function that takes two arguments (the current document and the aggregation to this point) and does the aggregation. Argument will be automatically cast to \MongoDB\BSON\Javascript.

Optional parameters to the group command. Valid options include:

• condition - criteria for including a document in the aggregation.
• finalize - function called once per unique key that takes the final output of the reduce function.

{@see \yii\mongodb\Command::group()}

The result of the aggregation.

on failure.

Data to be inserted.

List of options in format: optionName => optionValue.

{@see \yii\mongodb\Command::insert()}

New record ID instance.

on failure.

List of options in format: optionName => optionValue.

{@see \yii\mongodb\Command::listIndexes()}

List of indexes info.

Function, which emits map data from collection. Argument will be automatically cast to \MongoDB\BSON\Javascript.

Function that takes two arguments (the map key and the map values) and does the aggregation. Argument will be automatically cast to \MongoDB\BSON\Javascript.

Output collection name. It could be a string for simple output ('outputCollection'), or an array for parametrized output (['merge' => 'outputCollection']). You can pass ['inline' => true] to fetch the result at once without temporary collection usage.

Criteria for including a document in the aggregation.

Additional optional parameters to the mapReduce command. Valid options include:

• sort: array, key to sort the input documents. The sort key must be in an existing index for this collection.
• limit: int, the maximum number of documents to return in the collection.
• finalize: \MongoDB\BSON\Javascript|string, function, which follows the reduce method and modifies the output.
• scope: array, specifies global variables that are accessible in the map, reduce and finalize functions.
• jsMode: bool, specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions.
• verbose: bool, specifies whether to include the timing information in the result information.

{@see \yii\mongodb\Command::mapReduce()}

The map reduce output collection name or output results.

on failure.

Data to be updated/inserted.

List of options in format: optionName => optionValue.

{@see \yii\mongodb\Command::insert()}

Updated/new record id instance.

on failure.

Description of the objects to update.

The object with which to update the matching records.

List of options in format: optionName => optionValue.

{@see \yii\mongodb\Command::update()}

Number of updated documents or whether operation was successful.

on failure.