const classafMongo::MongoColl

Processes documents through an aggregation pipeline.

@see

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

The underlying connection manager.

Returns the number of documents that match the given filter. (Uses an aggregate cmd.)

Creates a new collection explicitly.

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

db.collection("name").create {
  it->capped = true
  it->size   = 64 * 1024  // no of bytes
  it->max    = 14         // no of docs
}

@see https://www.mongodb.com/docs/manual/reference/command/create/

Creates an MongoDb instance of the associated DB.

The name of the database.

Deletes all documents that match the given filter, and returns the number of documents deleted.

delete(["rick":"morty"]) {
  it->limit     = 1
  it->hint      = "_indexName_"
  it->collation = [...]
}

@see https://www.mongodb.com/docs/manual/reference/command/delete/

Deletes ALL documents in a Collection.

Note this is MUCH quicker than dropping the Collection.

Drops this collection, but only if it exists.

Note that deleting all documents is MUCH quicker than dropping the Collection. See deleteAll for details.

If force is true then no checks are made. This will result in an error if the collection does not exist.

@see https://www.mongodb.com/docs/manual/reference/command/drop/

Drops ALL indexes on the collection. Be careful!

@see https://www.mongodb.com/docs/manual/reference/command/dropIndexes/

Returns true if this collection exists.

Returns documents that match the given filter. Many options are possible.

find(["rick":"morty"]) {
  it->sort        = ["fieldName":1]
  it->hint        = "_indexName_"
  it->skip        = 50
  it->limit       = 100
  it->projection  = ["_id":1, "name":1]
  it->batchSize   = 101
  it->singleBatch = true
  it->collation   = [...]
}.toList

• @see https://www.mongodb.com/docs/manual/reference/command/find/
• @see https://www.mongodb.com/docs/manual/tutorial/query-documents/

Finds, deletes, and returns a single document. Returns null if no matching document was found.

@see https://www.mongodb.com/docs/manual/reference/command/findAndModify/

Finds, updates, and returns a single document. Returns null if no matching document was found.

@see https://www.mongodb.com/docs/manual/reference/command/findAndModify/

Return one document that matches the given filter.

Throws an Err if no documents are found and checked is true.

Always throws Err if the filter returns more than one document.

@see https://www.mongodb.com/docs/manual/reference/command/find/

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

Returns an MongoIdx of the given name.

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

Inserts the given document.

@see https://www.mongodb.com/docs/manual/reference/command/insert/

Inserts many documents.

Default behaviour is to stop when inserting fails. See ordered option for details.

@see https://www.mongodb.com/docs/manual/reference/command/insert/

Returns all the index names in this collection.

Returns all the indexes in this collection.

@see https://www.mongodb.com/docs/manual/reference/command/listIndexes/

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.

The simple name of the collection.

Returns the qualified name of this collection. It takes the form of:

<database>.<collection>

Finds a single document that matches the given filter, and replaces it. The _id field is NOT replaced.

replace(["rick":"morty"], ["rick":"sanchez"]) {
  it->upsert  = true
}

@see https://www.mongodb.com/docs/manual/reference/command/update/ @see https://www.mongodb.com/docs/manual/reference/operator/update/

Returns the number of documents in the collection.

The count is based on the collection's metadata, which provides a fast but sometimes inaccurate count for sharded clusters.

Performs a text search on the collection.

Text searching makes use of stemming and ignores language stop words. Quotes may be used to search for exact phrases and prefixing a word with a hyphen-minus (-) negates it.

Results are automatically ordered by search relevance.

To use text searching, make sure the Collection has a text Index else MongoDB will throw an Err.

col.textSearch("some text")

options may include the following:

Text searches may be mixed with regular filters. See MongoQ for details.

@see https://docs.mongodb.com/manual/reference/operator/query/text/.

Runs the given updateCmd against documents that match the given filter.

update(["rick":"morty"], ["\$set":["rick":"sanchez"]]) {
  it->upsert      = true
  it->multi       = false  // defaults to true
  it->hint        = "_indexName_"
  it->collation   = [...]
}

Inspect return value for upserted IDs.

(By default, this will update multiple documents.)

@see https://www.mongodb.com/docs/manual/reference/command/update/ @see https://www.mongodb.com/docs/manual/reference/operator/update/