const classafMongo::Collection

Performs an aggregation operation using a sequence of stage-based manipulations.

The options parameter is merged with the Mongo command and may contain the following:

@see

• http://docs.mongodb.org/manual/reference/command/aggregate/
• http://docs.mongodb.org/manual/reference/aggregation/

Same as aggregate() but returns a cursor to iterate over the results.

@see

• http://docs.mongodb.org/manual/reference/command/aggregate/
• http://docs.mongodb.org/manual/reference/aggregation/

Creates a new collection explicitly.

There is usually no no need to call this unless you wish explicitly set collection options.

@see http://docs.mongodb.org/manual/reference/command/create/

Creates a capped collection.

@see http://docs.mongodb.org/manual/reference/command/create/

Deletes documents that match the given query. Returns the number of documents deleted.

If deleteAll is true then all documents matching the query will be deleted, otherwise only the first match will be deleted.

@see http://docs.mongodb.org/manual/reference/command/delete/

Executes multiple delete queries.

@see http://docs.mongodb.org/manual/reference/command/delete/

Finds the distinct values for a specified field.

@see http://docs.mongodb.org/manual/reference/command/distinct/

Drops this collection, but only if it exists.

If force is true then the collection is dropped regardless. Note this may result in an error if the collection doesn't exist.

@see http://docs.mongodb.org/manual/reference/command/drop/

Drops ALL indexes on the collection. Be careful!

@see http://docs.mongodb.org/manual/reference/command/dropIndexes/

Returns true if this collection exists.

Creates a Cursor over the given query allowing you to iterate over results. Documents are downloaded from MongoDB in batches behind the scene as and when required. Use find() to optomise iterating over a massive result set.

Returns what is returned from the given cursor function.

second := collection.find([:]) |cursor->Obj?| {
    first  := cursor.next
    second := cursor.next
    return second
}

• @see Cursor
• @see http://docs.mongodb.org/manual/reference/operator/query/

Returns the result of the given query as a list of documents.

If sort is a Str it should the name of an index to use as a hint. If sort is a [Str:Obj?] map, it should be a sort document with field names as keys. Values may either be the standard Mongo 1 and -1 for ascending / descending or the strings ASC / DESC.

The sort map, should it contain more than 1 entry, must be ordered.

projection alters / limits which fields returned in the query results.

Note that findAll(...) is a convenience for calling find(...) and returning the cursor as a list.

• @see Cursor.toList
• @see http://docs.mongodb.org/manual/reference/operator/query/
• @see https://docs.mongodb.com/manual/reference/operator/projection/

Deletes and returns a single document. If the query returns multiple documents then the first one is delete.

The options parameter is merged with the Mongo command and may contain the following:

Example:

collection.findAndDelete(query, ["fields": ["myEntity.myField":1]]

@see http://docs.mongodb.org/manual/reference/command/findAndModify/

Updates and returns a single document. If the query returns multiple documents then the first one is updated.

If returnModified is true then the document is returned after the updates have been applied.

Returns null if no document was found.

The options parameter is merged with the Mongo command and may contain the following:

Example:

collection.findAndUpdate(query, cmd, true, ["upsert":true, "fields": ["myEntity.myField":1]]

@see http://docs.mongodb.org/manual/reference/command/findAndModify/

Returns the number of documents that would be returned by the given query.

@see Cursor.count

An (optomised) method to return one document from the given query.

Throws MongoErr if no documents are found and checked is true, returns null otherwise. Always throws MongoErr if the query returns more than one document.

@see http://docs.mongodb.org/manual/reference/operator/query/

Convenience / shorthand notation for findOne(["_id" : id], checked)

Groups documents by the specified key and performs simple aggregation functions.

key must either be a list of field names ( Str[] ) or a function that creates a "key object" ( Str ).

The options parameter is merged with the Mongo command and may contain the following:

@see http://docs.mongodb.org/manual/reference/command/group/

Returns an Index of the given name.

Note this just instantiates the Fantom object, it does not create anything in the database.

Returns all the index names of this collection.

Inserts the given document. Returns the number of documents inserted.

@see http://docs.mongodb.org/manual/reference/command/insert/

Inserts multiple documents.

@see http://docs.mongodb.org/manual/reference/command/insert/

Creates a Collection with the given name under the database.

Note this just instantiates the Fantom object, it does not create anything in the database.

Creates a Collection with the given qualified (dot separated) name.

Note this just instantiates the Fantom object, it does not create anything in the database.

Run a map-reduce aggregation operation over the collection.

If out is a Str, it specifies the name of a collection to store the results. If out is a Map, it specifies the action to take.

The options parameter is merged with the Mongo command and may contain the following:

Note if an out option is not specified, it is taken to be inline and the returned document contains the results.

@see http://docs.mongodb.org/manual/reference/command/mapReduce/

The simple name of the collection.

The qualified name of the collection. It takes the form of:

<database>.<collection>

Runs an arbitrary command against this Collection. Example, to return the size of the collection:

size := runCmd(
  ["count" : "<collectionName>"]
)["n"]->toInt

This is a low level operation.

See https://docs.mongodb.com/manual/reference/command/

Returns the number of documents in the collection.

@see http://docs.mongodb.org/manual/reference/command/count/

Returns storage statistics for this collection.

@see http://docs.mongodb.org/manual/reference/command/collStats/

Runs the given updateCmd against documents returned by query. Returns the number of documents modified. Note this does not throw an Err should the query not match any documents.

If multi is true then the multiple documents may be updated, otherwise the update is limited to one.

If upsert is true and no documents are updated, then one is inserted.

@see http://docs.mongodb.org/manual/reference/command/update/

Runs multiple update queries.

@see http://docs.mongodb.org/manual/reference/command/update/