# Collections

Meteor stores data in _collections_. To get started, declare a
collection with `new Mongo.Collection`.

<ApiBox name="Mongo.Collection" />

Calling this function is analogous to declaring a model in a traditional ORM
(Object-Relation Mapper)-centric framework. It sets up a _collection_ (a storage
space for records, or "documents") that can be used to store a particular type
of information, like users, posts, scores, todo items, or whatever matters to
your application. Each document is a EJSON object. It includes an `_id`
property whose value is unique in the collection, which Meteor will set when you
first create the document.

```js
// Common code on client and server declares a DDP-managed Mongo collection.
const Chatrooms = new Mongo.Collection("chatrooms");
const Messages = new Mongo.Collection("messages");
```

The function returns an object with methods to [`insert`](#Mongo-Collection-insert)
documents in the collection, [`update`](#Mongo-Collection-update) their properties, and
[`remove`](#Mongo-Collection-remove) them, and to [`find`](#Mongo-Collection-find) the documents in the
collection that match arbitrary criteria. The way these methods work is
compatible with the popular Mongo database API. The same database API
works on both the client and the server (see below).

```js
// Return an array of my messages.
const myMessages = await Messages.find({ userId: Meteor.userId() }).fetchAsync();

// Create a new message.
await Messages.insertAsync({ text: "Hello, world!" });

// Mark my first message as important.
await Messages.updateAsync(myMessages[0]._id, { $set: { important: true } });
```


If you pass a `name` when you create the collection, then you are
declaring a persistent collection &mdash; one that is stored on the
server and seen by all users. Client code and server code can both
access the same collection using the same API.

Specifically, when you pass a `name`, here's what happens:

- On the server (if you do not specify a `connection`), a collection with that
  name is created on a backend Mongo server. When you call methods on that
  collection on the server, they translate directly into normal Mongo operations
  (after checking that they match your [access control rules](#Mongo-Collection-allow)).

- On the client (and on the server if you specify a `connection`), a Minimongo
  instance is created. Minimongo is essentially an in-memory, non-persistent
  implementation of Mongo in pure JavaScript. It serves as a local cache that
  stores just the subset of the database that this client is working with. Queries
  ([`find`](#Mongo-Collection-find)) on these collections are served directly out of this cache,
  without talking to the server.

- When you write to the database on the client ([`insert`](#Mongo-Collection-insert),
  [`update`](#Mongo-Collection-update), [`remove`](#Mongo-Collection-remove)), the command is executed locally
  immediately, and, simultaneously, it's sent to the server and executed
  there too. This happens via [stubs](./meteor.md#meteor-methods), because writes are
  implemented as methods.

> When, on the server, you write to a collection which has a specified
> `connection` to another server, it sends the corresponding method to the other
> server and receives the changed values back from it over DDP. Unlike on the
> client, it does not execute the write locally first.

::: danger
On Meteor 3.x and later using `insert`, `update`, `upsert`,
`remove`, `findOne` on the server will throw and error. Use the
`*Async` counterparts instead.

For example, instead of `collection.insert(doc)`, use `collection.insertAsync(doc)`.
:::

If you pass a name to a client-only collection, it will not be synchronized
with the server and you need to populate the collection "manually" using the
low-level publication interface (`added/changed/removed`).
See [`added`](./meteor.md#Subscription-added) for more information.

If you pass `null` as the `name`, then you're creating a local
collection. It's not synchronized anywhere; it's just a local scratchpad
that supports Mongo-style [`find`](#Mongo-Collection-find), [`insert`](#Mongo-Collection-insert),
[`update`](#Mongo-Collection-update), and [`remove`](#Mongo-Collection-remove) operations. (On both the
client and the server, this scratchpad is implemented using Minimongo.)

By default, Meteor automatically publishes every document in your
collection to each connected client. To turn this behavior off, remove
the `autopublish` package, in your terminal:

```bash
meteor remove autopublish
```

and instead call [`Meteor.publish`](./meteor.md#Meteor-publish) to specify which parts of
your collection should be published to which users.

```js
// client.js
// Create a collection called `Posts` and put a document in it. The document
// will be immediately visible in the local copy of the collection. It will be
// written to the server-side database a fraction of a second later, and a
// fraction of a second after that, it will be synchronized down to any other
// clients that are subscribed to a query that includes it (see
// `Meteor.subscribe` and `autopublish`).
const Posts = new Mongo.Collection("posts");
Posts.insert({ title: "Hello world", body: "First post" });

// Changes are visible immediately—no waiting for a round trip to the server.
assert(Posts.find().count() === 1);

// Create a temporary, local collection. It works just like any other collection
// but it doesn't send changes to the server, and it can't receive any data from
// subscriptions.
const Scratchpad = new Mongo.Collection();

for (let i = 0; i < 10; i += 1) {
  Scratchpad.insert({ number: i * 2 });
}

assert(Scratchpad.find({ number: { $lt: 9 } }).count() === 5);
```

Generally, you'll assign `Mongo.Collection` objects in your app to global
variables. You can only create one `Mongo.Collection` object for each
underlying Mongo collection.

If you specify a `transform` option to the `Collection` or any of its retrieval
methods, documents are passed through the `transform` function before being
returned or passed to callbacks. This allows you to add methods or otherwise
modify the contents of your collection from their database representation. You
can also specify `transform` on a particular `find`, `findOne`, `allow`, or
`deny` call. Transform functions must return an object and they may not change
the value of the document's `_id` field (though it's OK to leave it out).

```js
// An animal class that takes a document in its constructor.
class Animal {
  constructor(doc) {
    _.extend(this, doc);
  }

  makeNoise() {
    console.log(this.sound);
  }
}

// Define a collection that uses `Animal` as its document.
const Animals = new Mongo.Collection("animals", {
  transform: (doc) => new Animal(doc),
});

// Create an animal and call its `makeNoise` method.
Animals.insert({ name: "raptor", sound: "roar" });
Animals.findOne({ name: "raptor" }).makeNoise(); // Prints 'roar'
```

`transform` functions are not called reactively. If you want to add a
dynamically changing attribute to an object, do it with a function that computes
the value at the time it's called, not by computing the attribute at `transform`
time.

::: warning
In this release, Minimongo has some limitations:

- `$pull` in modifiers can only accept certain kinds
  of selectors.
- `findAndModify`, aggregate functions, and
  map/reduce aren't supported.

All of these will be addressed in a future release. For full
Minimongo release notes, see packages/minimongo/NOTES
in the repository.
:::


::: warning
Minimongo doesn't currently have indexes. It's rare for this to be an
issue, since it's unusual for a client to have enough data that an
index is worthwhile.
:::

Use the `resolverType` option to determine the default method for resolving the functions of the collection methods. In Meteor 3.x, a distinction exists between stub and server promises on call methods. The former handles client simulation and minimongo population, while the latter solely manages success or error on the server call without populating the data in minimongo. The resolverType option offers `stub` and `server` values.

This option is particularly useful on test environments to maintain isomorphic code without needing to manage different code for the server and stub scenarios.

```javascript
const Greetings = new Meteor.Collection('greetUser', { resolverType: 'stub' });
    
await Greetings.insertAsync({ test: 1 });

// 🔵 Client simulation
Greetings.findOne({ name: 'John' }); // 🧾 Data is available (Optimistic-UI)
```

Read more about server and stub promises on calling methods, [please refer to the docs](./meteor.md#Meteor-callAsync).

Read more about collections and how to use them in the [Collections](http://guide.meteor.com/collections.html) article in the Meteor Guide.


<ApiBox name="Mongo.Collection#find" instanceName="Collection"/>


`find` returns a cursor. It does not immediately access the database or return
documents. Cursors provide `fetch` to return all matching documents, `map` and
`forEach` to iterate over all matching documents, and `observeAsync` and
`observeChangesAsync` to register callbacks when the set of matching documents
changes. Cursors also implement ES2015's [iteration protocols](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).

::: warning
Collection cursors are not query snapshots. If the database changes
between calling `Collection.find` and fetching the
results of the cursor, or while fetching results from the cursor,
those changes may or may not appear in the result set.
:::

Cursors are a reactive data source. On the client, the first time you retrieve a
cursor's documents with `fetch`, `map`, or `forEach` inside a
reactive computation (eg, a template or
[`autorun`](./Tracker.md#Tracker-autorun)), Meteor will register a
dependency on the underlying data. Any change to the collection that
changes the documents in a cursor will trigger a recomputation. To
disable this behavior, pass `{reactive: false}` as an option to
`find`.

Note that when `fields` are specified, only changes to the included
fields will trigger callbacks in `observeAsync`, `observeChangesAsync` and
invalidations in reactive computations using this cursor. Careful use
of `fields` allows for more fine-grained reactivity for computations
that don't depend on an entire document.

On the client, there will be a period of time between when the page loads and
when the published data arrives from the server during which your client-side
collections will be empty.


<ApiBox name="Mongo.Collection#findOne"  instanceName="Collection"/>

::: warning
Client only.
For server/isomorphic usage see [findOneAsync](#Mongo-Collection-findOneAsync).
:::

Equivalent to [`find`](#Mongo-Collection-find)`(selector, options).`[`fetch`](#Mongo-Cursor-fetch)`()[0]` with
`options.limit = 1`.

<ApiBox name="Mongo.Collection#findOneAsync" instanceName="Collection"/>

Async version of [`findOne`](#Mongo-Collection-findOne) that return a `Promise`.

<ApiBox name="Mongo.Collection#countDocuments" instanceName="Collection"/>

Similar to `cursor.count`, but returns a `Promise`. For a faster version, see `estimatedDocumentCount`.

<ApiBox name= "Mongo.Collection#estimatedDocumentCount" instanceName="Collection"/>

Returns a `Promise` that resolves to the number of documents in the cursor's result set. The count is an estimate and not guaranteed to be exact.

<ApiBox name="Mongo.Collection#insert" instanceName="Collection"/>

::: warning
Client only.
For server/isomorphic usage see [insertAsync](#Mongo-Collection-insertAsync).
:::

Add a document to the collection. A document is just an object, and
its fields can contain any combination of EJSON-compatible datatypes
(arrays, objects, numbers, strings, `null`, true, and false).

`insert` will generate a unique ID for the object you pass, insert it
in the database, and return the ID. When `insert` is called from
untrusted client code, it will be allowed only if passes any
applicable [`allow`](#Mongo-Collection-allow) and [`deny`](#Mongo-Collection-deny) rules.

On the server, it should be used `insertAsync` that will return a promise with the `ID` of your
object.

On the client, `insert` never blocks. If you do not provide a callback
and the insert fails on the server, then Meteor will log a warning to
the console. If you provide a callback, Meteor will call that function
with `error` and `result` arguments. In an error case, `result` is
undefined. If the insert is successful, `error` is undefined and
`result` is the new document ID.

Example:

```js
const groceriesId = Lists.insert({ name: "Groceries" });

Items.insert({ list: groceriesId, name: "Watercress" });
Items.insert({ list: groceriesId, name: "Persimmons" });
```


<ApiBox name="Mongo.Collection#insertAsync" instanceName="Collection"/>

Async version of [`insert`](#Mongo-Collection-insert) that return a `Promise`.

<ApiBox name="Mongo.Collection#update" instanceName="Collection"/>

::: warning
Client only.
For server/isomorphic usage see [updateAsync](#Mongo-Collection-updateAsync).
:::

Modify documents that match `selector` according to `modifier` (see
[modifier documentation](#modifiers)).

The behavior of `update` differs depending on whether it is called by
trusted or untrusted code. Trusted code includes server code and
method code. Untrusted code includes client-side code such as event
handlers and a browser's JavaScript console.

- Trusted code can modify multiple documents at once by setting
  `multi` to true, and can use an arbitrary [Mongo
  selector](#selectors) to find the documents to modify. It bypasses
  any access control rules set up by [`allow`](#Mongo-Collection-allow) and
  [`deny`](#Mongo-Collection-deny). The number of affected documents will be returned
  from the `update` call if you don't pass a callback.

- Untrusted code can only modify a single document at once, specified
  by its `_id`. The modification is allowed only after checking any
  applicable [`allow`](#Mongo-Collection-allow) and [`deny`](#Mongo-Collection-deny) rules. The number
  of affected documents will be returned to the callback. Untrusted
  code cannot perform upserts, except in insecure mode.

On the server, it should be used `updateAsync`.

On the client, `update` never blocks. If you do not provide a callback
and the update fails on the server, then Meteor will log a warning to
the console. If you provide a callback, Meteor will call that function
with an error argument if there was an error, or a second argument
indicating the number of affected documents if the update was successful.

::: code-group

```js [server.js]
// Give the 'Winner' badge to each user with a score greater than 10. If they
// are logged in and their badge list is visible on the screen, it will update
// automatically as they watch.
Meteor.methods({
  async declareWinners() {
    await Players.updateAsync(
      { score: { $gt: 10 } },
      {
        $addToSet: { badges: "Winner" },
      },
      { multi: true }
    );
  },
});
```

```js [client.js]
// When the 'give points' button in the admin dashboard is pressed, give 5
// points to the current player. The new score will be immediately visible on
// everyone's screens.
Template.adminDashboard.events({
  "click .give-points"() {
    Players.update(Session.get("currentPlayer"), {
      $inc: { score: 5 },
    });
  },
});
```


You can use `update` to perform a Mongo upsert by setting the `upsert`
option to true. You can also use the [`upsert`](#Mongo-Collection-upsert) method to perform an
upsert that returns the `_id` of the document that was inserted (if there was one)
in addition to the number of affected documents.

<ApiBox name="Mongo.Collection#updateAsync" instanceName="Collection"/>

Async version of [`update`](#Mongo-Collection-update) that return a `Promise`.

<ApiBox name="Mongo.Collection#upsert" instanceName="Collection"/>

::: warning
Client only.
For server/isomorphic usage see [upsertAsync](#Mongo-Collection-upsertAsync).
:::

Modify documents that match `selector` according to `modifier`, or insert
a document if no documents were modified. `upsert` is the same as calling
`update` with the `upsert` option set to true, except that the return
value of `upsert` is an object that contain the keys `numberAffected`
and `insertedId`. (`update` returns only the number of affected documents.)

<ApiBox name="Mongo.Collection#upsertAsync" instanceName="Collection"/>

Async version of [`upsert`](#Mongo-Collection-upsert) that return a `Promise`.

<ApiBox name="Mongo.Collection#remove" instanceName="Collection"/>

::: warning
Client only.
For server/isomorphic usage see [removeAsync](#Mongo-Collection-removeAsync).
:::

Find all of the documents that match `selector` and delete them from
the collection.

The behavior of `remove` differs depending on whether it is called by
trusted or untrusted code. Trusted code includes server code and
method code. Untrusted code includes client-side code such as event
handlers and a browser's JavaScript console.

- Trusted code can use an arbitrary [Mongo selector](#selectors) to
  find the documents to remove, and can remove more than one document
  at once by passing a selector that matches multiple documents. It
  bypasses any access control rules set up by [`allow`](#Mongo-Collection-allow) and
  [`deny`](#Mongo-Collection-deny). The number of removed documents will be returned
  from `remove` if you don't pass a callback.

  As a safety measure, if `selector` is omitted (or is `undefined`),
  no documents will be removed. Set `selector` to `{}` if you really
  want to remove all documents from your collection.

- Untrusted code can only remove a single document at a time,
  specified by its `_id`. The document is removed only after checking
  any applicable [`allow`](#Mongo-Collection-allow) and [`deny`](#Mongo-Collection-deny) rules. The
  number of removed documents will be returned to the callback.

On the server, it should be used `removeAsync`.

On the client, `remove` never blocks. If you do not provide a callback
and the remove fails on the server, then Meteor will log a warning to the
console. If you provide a callback, Meteor will call that function with an
error argument if there was an error, or a second argument indicating the number
of removed documents if the remove was successful.

::: code-group

```js [server.js]
// When the server starts, clear the log and delete all players with a karma of
// less than -2.
Meteor.startup(async () => {
  if (Meteor.isServer) {
    await Logs.removeAsync({});
    await Players.removeAsync({ karma: { $lt: -2 } });
  }
});
```

```js [client.js]
// When the 'remove' button is clicked on a chat message, delete that message.
Template.chat.events({
  "click .remove"() {
    Messages.remove(this._id);
  },
});
```

:::



<ApiBox name="Mongo.Collection#removeAsync" instanceName="Collection"/>

Async version of [`remove`](#Mongo-Collection-remove) that return a `Promise`.

<ApiBox name="Mongo.Collection#createIndex" instanceName="Collection"/>

For efficient and performant queries you will sometimes need to define indexes other than the default `_id` field.
You should add indexes to fields (or combinations of fields) you use to lookup documents in a collection.
This is where `createIndex` comes into play. It takes in 2 objects. First is the key and index type specification (which field and how they should be indexed) and second are options like the index name.
For details on how indexes work read the [MongoDB documentation](https://docs.mongodb.com/manual/indexes/).

> Note that indexes only apply to server and MongoDB collection. They are not implemented for Minimongo at this time.

Example defining a simple index on Players collection in Meteor:

```js
Players.createIndex({ userId: 1 }, { name: "user reference on players" });
```



Sometimes you or a package might change an already established indexes. This might throw an error and prevent a startup.
For cases where you can afford to re-build indexes or the change affect too many indexes you can set the `reCreateIndexOnOptionMismatch`
to true in your `settings.json`:

```json
{
  "packages": {
    "mongo": {
      "reCreateIndexOnOptionMismatch": true
    }
  }
}
```

> You should use this option only when you are dealing with a change across many indexes and it is not feasible to fix them manually and you can afford the re-building of the indexes as this will destroy the old index and create a new one. Use this carefully.

<ApiBox name="Mongo.Collection#createIndexAsync" instanceName="Collection"/>

Async version of [`createIndex`](#Mongo-Collection-createIndex) that return a `Promise`.

<ApiBox name="Mongo.Collection#allow" instanceName="Collection"/>


::: warning
While `allow` and `deny` make it easy to get started building an app, it's
harder than it seems to write secure `allow` and `deny` rules. We recommend
that developers avoid `allow` and `deny`, and switch directly to custom methods
once they are ready to remove `insecure` mode from their app. See
[the Meteor Guide on security](https://guide.meteor.com/security.html#allow-deny)
for more details.
:::

When a client calls `insert`/`insertAsync`, `update`/`updateAsync`, `remove`/`removeAsync`
on a collection, the collection's `allow` and [`deny`](#Mongo-Collection-deny) callbacks
are called on the server to determine if the write should be allowed. If at least
one `allow` callback allows the write, and no `deny` callbacks deny the
write, then the write is allowed to proceed.

These checks are run only when a client tries to write to the database
directly, for example by calling `update`/`updateAsync` from inside an event
handler. Server code is trusted and isn't subject to `allow` and `deny`
restrictions. That includes methods that are called with `Meteor.call`
&mdash; they are expected to do their own access checking rather than
relying on `allow` and `deny`.

You can call `allow` as many times as you like, and each call can
include any combination of `insert`, `update`,
and `remove` functions. The functions should return `true`
if they think the operation should be allowed. Otherwise they should
return `false`, or nothing at all (`undefined`). In that case Meteor
will continue searching through any other `allow` rules on the collection.

The available callbacks are:

### Callbacks

- `insert(userId, doc)` - The user `userId` wants to insert the
  document `doc` into the collection. Return `true` if this should be
  allowed. Supports async validations.

  `doc` will contain the `_id` field if one was explicitly set by the client, or
  if there is an active `transform`. You can use this to prevent users from
  specifying arbitrary `_id` fields.

- `update(userId, doc, fieldNames, modifier)` - The user `userId`
  wants to update a document `doc` in the database. (`doc` is the
  current version of the document from the database, without the
  proposed update.) Return `true` to permit the change. Supports async validations.

  `fieldNames` is an array of the (top-level) fields in `doc` that the
  client wants to modify, for example
  `['name', 'score']`.

  `modifier` is the raw Mongo modifier that
  the client wants to execute; for example,
  `{ $set: { 'name.first': 'Alice' }, $inc: { score: 1 } }`.

  Only Mongo modifiers are supported (operations like `$set` and `$push`).
  If the user tries to replace the entire document rather than use
  \$-modifiers, the request will be denied without checking the `allow`
  functions.

- `remove(userId, doc)` - the user `userId` wants to remove `doc` from the database. Return
  `true` to permit this. Supports async validations.


When calling `update`/`updateAsync` or `remove`/`removeAsync` Meteor will by default fetch the
entire document `doc` from the database. If you have large documents
you may wish to fetch only the fields that are actually used by your
functions. Accomplish this by setting `fetch` to an array of field
names to retrieve.

Example:

```js
// Create a collection where users can only modify documents that they own.
// Ownership is tracked by an `owner` field on each document. All documents must
// be owned by the user that created them and ownership can't be changed. Only a
// document's owner is allowed to delete it, and the `locked` attribute can be
// set on a document to prevent its accidental deletion.
const Posts = new Mongo.Collection("posts");

Posts.allow({
  insert(userId, doc) {
    // The user must be logged in and the document must be owned by the user.
    return userId && doc.owner === userId;
  },

  update(userId, doc, fields, modifier) {
    // Can only change your own documents.
    return doc.owner === userId;
  },

  async remove(userId, doc) {
    // Any custom async validation is supported
    await Meteor.sleep(100);
    // Can only remove your own documents.
    return doc.owner === userId;
  },

  fetch: ["owner"],
});

Posts.deny({
  update(userId, doc, fields, modifier) {
    // Can't change owners.
    return _.contains(fields, "owner");
  },

  async remove(userId, doc) {
    // Any custom async validation is supported
    await Meteor.sleep(100);
    // Can't remove locked documents.
    return doc.locked;
  },

  fetch: ["locked"], // No need to fetch `owner`
});
```

If you never set up any `allow` rules on a collection then all client
writes to the collection will be denied, and it will only be possible to
write to the collection from server-side code. In this case you will
have to create a method for each possible write that clients are allowed
to do. You'll then call these methods with `Meteor.call` rather than
having the clients call `insert`/`insertAsync`, `update`/`updateAsync`,
and `remove`/`removeAsync` directly on the
collection.


Meteor also has a special "insecure mode" for quickly prototyping new
applications. In insecure mode, if you haven't set up any `allow` or `deny`
rules on a collection, then all users have full write access to the
collection. This is the only effect of insecure mode. If you call `allow` or
`deny` at all on a collection, even `Posts.allow({})`, then access is checked
just like normal on that collection. **New Meteor projects start in insecure
mode by default.** To turn it off just run in your terminal:

```bash
meteor remove insecure
```

<ApiBox name="Mongo.Collection#deny" instanceName="Collection"/>

::: warning
While `allow` and `deny` make it easy to get started building an app, it's
harder than it seems to write secure `allow` and `deny` rules. We recommend
that developers avoid `allow` and `deny`, and switch directly to custom methods
once they are ready to remove `insecure` mode from their app. See
[the Meteor Guide on security](https://guide.meteor.com/security.html#allow-deny)
for more details.
:::

This works just like [`allow`](#Mongo-Collection-allow), except it lets you
make sure that certain writes are definitely denied, even if there is an
`allow` rule that says that they should be permitted.

When a client tries to write to a collection, the Meteor server first
checks the collection's `deny` rules. If none of them return true then
it checks the collection's `allow` rules. Meteor allows the write only
if no `deny` rules return `true` and at least one `allow` rule returns
`true`.

<ApiBox name="Mongo.Collection#rawCollection" instanceName="Collection"/>

The methods (like `update` or `insert`) you call on the resulting _raw_ collection return promises and can be used outside of a Fiber.

<ApiBox name="Mongo.Collection#rawDatabase" instanceName="Collection"/>

## Collection Extensions

Meteor provides a powerful Collection Extensions API that allows you to extend the functionality of all collection instances. These static methods on `Mongo.Collection` let you add constructor extensions, prototype methods, and static methods to customize collection behavior. These very same APIs are exported under `CollectionExtensions` for backwards compatibility with [lai:collection-extensions](https://github.com/Meteor-Community-Packages/meteor-collection-extensions). 

<ApiBox name="Mongo.Collection.addExtension" />

Add a constructor extension function that runs when collections are created. The extension function is called with `(name, options)` and `this` bound to the collection instance.

Example:
```js
Mongo.Collection.addExtension(function(name, options) {
  this._customProperty = 'value';
  console.log(`Collection ${name} was created`);
});
```

<ApiBox name="Mongo.Collection.addPrototypeMethod" />

Add a prototype method to all collection instances. The method is bound to the collection instance and available on all collections.

Example:
```js
Mongo.Collection.addPrototypeMethod('customMethod', function() {
  return `${this._name} is awesome`;
});

// Now available on all collections
const Users = new Mongo.Collection('users');
console.log(Users.customMethod()); // "users is awesome"
```

<ApiBox name="Mongo.Collection.addStaticMethod" />

Add a static method to the `Mongo.Collection` constructor itself.

Example:
```js
Mongo.Collection.addStaticMethod('getAllCollections', function() {
  return Array.from(Mongo._collections.values());
});

// Now available as static method
const allCollections = Mongo.Collection.getAllCollections();
```

<ApiBox name="Mongo.Collection.removeExtension" />

Remove a constructor extension (useful for testing).

<ApiBox name="Mongo.Collection.removePrototypeMethod" />

Remove a prototype method from all collection instances.

<ApiBox name="Mongo.Collection.removeStaticMethod" />

Remove a static method from the `Mongo.Collection` constructor.

<ApiBox name="Mongo.Collection.clearExtensions" />

Clear all extensions, prototype methods, and static methods. This is useful for testing to ensure a clean state.

<ApiBox name="Mongo.Collection.getExtensions" />

Get all registered constructor extensions. Returns an array of extension functions. Useful for debugging.

<ApiBox name="Mongo.Collection.getPrototypeMethods" />

Get all registered prototype methods. Returns a Map of method names to functions. Useful for debugging.

<ApiBox name="Mongo.Collection.getStaticMethods" />

Get all registered static methods. Returns a Map of method names to functions. Useful for debugging.

### Legacy Aliases

<ApiBox name="Mongo.Collection.addPrototype" />

Backwards compatibility alias for `addPrototypeMethod`. **Deprecated** - use `addPrototypeMethod` instead.

<ApiBox name="Mongo.Collection.removePrototype" />

Backwards compatibility alias for `removePrototypeMethod`. **Deprecated** - use `removePrototypeMethod` instead.


## Cursors {#mongo_cursor}

To create a cursor, use [`find`](#Mongo-Collection-find). To access the documents in a
cursor, use [`forEach`](#Mongo-Cursor-forEach), [`map`](##Mongo-Cursor-map), [`fetch`](#Mongo-Cursor-fetch),
[`forEachAsync`](#Mongo-Cursor-forEachAsync), [`mapAsync`](#Mongo-Cursor-mapAsync), [`fetchAsync`](#Mongo-Cursor-fetchAsync) or ES2015's [iteration protocols](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).

<ApiBox name="Mongo.Cursor#forEach" instanceName="Cursor"/>

This interface is compatible with [Array.forEach](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach).

When called from a reactive computation, `forEach` registers dependencies on
the matching documents.

Examples:

```js
// Print the titles of the five top-scoring posts.
const topPosts = Posts.find({}, { sort: { score: -1 }, limit: 5 });
let count = 0;

topPosts.forEach((post) => {
  console.log(`Title of post ${count}: ${post.title}`);
  count += 1;
});
```

::: warning
Client only.
For server/isomorphic usage see [forEachAsync](#Mongo-Cursor-forEachAsync).
:::

<ApiBox name="Mongo.Cursor#forEachAsync" instanceName="Cursor"/>

Async version of [`forEach`](#Mongo-Cursor-forEach) that return a `Promise`.

The same example as from `forEach` but using `forEachAsync`:

```js

// Print the titles of the five top-scoring posts.
const topPosts = Posts.find({}, { sort: { score: -1 }, limit: 5 });
let count = 0;

await topPosts.forEachAsync((post) => {
  console.log(`Title of post ${count}: ${post.title}`);
  count += 1;
});

console.log("All done!"); // This will be printed after all the posts are printed.

```

<ApiBox name="Mongo.Cursor#map" instanceName="Cursor"/>

This interface is compatible with [Array.map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map).

When called from a reactive computation, `map` registers dependencies on
the matching documents.

<!-- The following is not yet implemented, but users shouldn't assume
     sequential execution anyway because that will break. -->

On the server, if `callback` yields, other calls to `callback` may occur while
the first call is waiting. If strict sequential execution is necessary, use
`forEach` instead.

::: warning
Client only.
For server/isomorphic usage see [mapAsync](#Mongo-Cursor-mapAsync).
:::


<ApiBox name="Mongo.Cursor#mapAsync" instanceName="Cursor" />

Async version of [`map`](#Mongo-Cursor-map) that return a `Promise`.

<ApiBox name="Mongo.Cursor#fetch" instanceName="Cursor"/>

When called from a reactive computation, `fetch` registers dependencies on
the matching documents.

::: warning
Client only.
For server/isomorphic usage see [fetchAsync](#Mongo-Cursor-fetchAsync).
:::

<ApiBox name="Mongo.Cursor#fetchAsync" instanceName="Cursor"/>

Async version of [`fetch`](#Mongo-Cursor-fetch) that return a `Promise`.

<ApiBox name="Mongo.Cursor#count" instanceName="Cursor"/>


Unlike the other functions, `count` registers a dependency only on the
number of matching documents. (Updates that just change or reorder the
documents in the result set will not trigger a recomputation.)

::: warning
Client only.
For server/isomorphic usage see [countAsync](#Mongo-Cursor-countAsync).
:::

<ApiBox name="Mongo.Cursor#countAsync" instanceName="Cursor"/>

Async version of [`count`](#Mongo-Cursor-count) that return a `Promise`.

<ApiBox name="Mongo.Cursor#observeAsync" instanceName="Cursor"/>

Establishes a _live query_ that invokes callbacks when the result of
the query changes. The callbacks receive the entire contents of the
document that was affected, as well as its old contents, if
applicable. If you only need to receive the fields that changed, see
[`observeChangesAsync`](#Mongo-Cursor-observeChangesAsync).

`callbacks` may have the following functions as properties:


### Callbacks

- `added(document)` or `addedAt(document, atIndex, before)`
  A new document `document` entered the result set. The new document
  appears at position `atIndex`. It is immediately before the document
  whose `_id` is `before`. `before` will be `null` if the new document
  is at the end of the results.

- `changed(newDocument, oldDocument)` or `changedAt(newDocument, oldDocument, atIndex)`
  The contents of a document were previously `oldDocument` and are now
  `newDocument`. The position of the changed document is `atIndex`.

- `removed(oldDocument)` or `removedAt(oldDocument, atIndex)`
  The document `oldDocument` is no longer in the result set. It used
  to be at position `atIndex`.

- `movedTo(document, fromIndex, toIndex, before)`
  A document changed its position in the result set, from `fromIndex`
  to `toIndex` (which is before the document with id `before`). Its
  current contents is `document`.

Use `added`, `changed`, and `removed` when you don't care about the
order of the documents in the result set. They are more efficient than
`addedAt`, `changedAt`, and `removedAt`.

Before `observeAsync` returns, `added` (or `addedAt`) will be called zero
or more times to deliver the initial results of the query.


`observeAsync` returns a promise of the live query handle, which is an object with a `stop` method.
Call `stop` with no arguments to stop calling the callback functions and tear
down the query. **The query will run forever until you call this.** If
`observeAsync` is called from a `Tracker.autorun` computation, it is automatically
stopped when the computation is rerun or stopped.

::: tip
`observeAsync` is recommended to keep code isomorphism in the client and server.

`observe` stays sync for easier client-side handler management.
:::

(If the cursor was created with the option `reactive` set to false, it will
only deliver the initial results and will not call any further callbacks;
it is not necessary to call `stop` on the handle.)


<ApiBox name="Mongo.Cursor#observeChangesAsync" instanceName="Cursor"/>

Establishes a _live query_ that invokes callbacks when the result of
the query changes. In contrast to [`observeAsync`](#Mongo-Cursor-observeAsync),
`observeChangesAsync` provides only the difference between the old and new
result set, not the entire contents of the document that changed.

`callbacks` may have the following functions as properties:

### Callbacks


- `added(id, fields)` or `addedBefore(id, fields, before)`
  A new document entered the result set. It has the `id` and `fields`
  specified. `fields` contains all fields of the document excluding the
  `_id` field. The new document is before the document identified by
  `before`, or at the end if `before` is `null`.

- `changed(id, fields)`
  The document identified by `id` changed its contents. `fields`
  contains the changed fields with their new values. If a field was
  removed from the document then it will be present in `fields` with a
  value of `undefined`.

- `removed(id)`
  The document identified by `id` is no longer in the result set.

- `movedBefore(id, before)`
  The document identified by `id` changed its position in the result
  set, and now appears before the document identified by `before`.

`observeChangesAsync` is significantly more efficient if you do not use
`addedBefore` or `movedBefore`.

Before `observeChangesAsync` returns, `added` (or `addedBefore`) will be called
zero or more times to deliver the initial results of the query.

`observeChangesAsync` returns a promise of the live query handle, which is an object with a `stop`
method. Call `stop` with no arguments to stop calling the callback functions
and tear down the query. **The query will run forever until you call this.**
If
`observeChangesAsync` is called from a `Tracker.autorun` computation, it is automatically
stopped when the computation is rerun or stopped.

::: tip
`observeChangesAsync` is recommended to keep code isomorphism in the client and server.

`observeChanges` stays sync for easier client-side handler management.
:::

(If the cursor was created with the option `reactive` set to false, it will
only deliver the initial results and will not call any further callbacks;
it is not necessary to call `stop` on the handle.)

> Unlike `observeAsync`, `observeChangesAsync` does not provide absolute position
> information (that is, `atIndex` positions rather than `before`
> positions.) This is for efficiency.

Example:

```js
// Keep track of how many administrators are online.
let count = 0;
const cursor = Users.find({ admin: true, onlineNow: true });

const handle = await cursor.observeChangesAsync({
  added(id, user) {
    count += 1;
    console.log(`${user.name} brings the total to ${count} admins.`);
  },

  removed() {
    count -= 1;
    console.log(`Lost one. We're now down to ${count} admins.`);
  },
});

// After five seconds, stop keeping the count.
setTimeout(() => handle.stop(), 5000);
```

<ApiBox name="Mongo.getCollection" />
<ApiBox name="Mongo.ObjectID" />


`Mongo.ObjectID` follows the same API as the [Node MongoDB driver `ObjectID`](http://mongodb.github.io/node-mongodb-native/3.0/api/ObjectID.html)
class. Note that you must use the `equals` method (or [`EJSON.equals`](./EJSON.md#EJSON-equals)) to
compare them; the `===` operator will not work. If you are writing generic code
that needs to deal with `_id` fields that may be either strings or `ObjectID`s, use
[`EJSON.equals`](./EJSON.md#EJSON-equals) instead of `===` to compare them.

> `ObjectID` values created by Meteor will not have meaningful answers to their `getTimestamp`
> method, since Meteor currently constructs them fully randomly.



## Selectors {#selectors}

The simplest selectors are just a string or
[`Mongo.ObjectID`](#Mongo-ObjectID). These selectors match the
document with that value in its `_id` field.

A slightly more complex form of selector is an object containing a set of keys
that must match in a document:

```js
// Matches all documents where `deleted` is false.
{ deleted: false }

// Matches all documents where the `name` and `cognomen` are as given.
{ name: 'Rhialto', cognomen: 'the Marvelous' }

// Matches every document.
{}
```


But they can also contain more complicated tests:

```js
// Matches documents where `age` is greater than 18.
{
  age: {
    $gt: 18;
  }
}

// Matches documents where `tags` is an array containing 'popular'.
{
  tags: "popular";
}

// Matches documents where `fruit` is one of three possibilities.
{
  fruit: {
    $in: ["peach", "plum", "pear"];
  }
}
```

See the [complete documentation](http://docs.mongodb.org/manual/reference/operator/).

## Modifiers {#modifiers}


A modifier is an object that describes how to update a document in
place by changing some of its fields. Some examples:

```js
// Set the `admin` property on the document to true.
{ $set: { admin: true } }

// Add 2 to the `votes` property and add 'Traz' to the end of the `supporters`
// array.
{ $inc: { votes: 2 }, $push: { supporters: 'Traz' } }
```

But if a modifier doesn't contain any \$-operators, then it is instead
interpreted as a literal document, and completely replaces whatever was
previously in the database. (Literal document modifiers are not currently
supported by [validated updates](#Mongo-Collection-allow).)


```js
// Find the document with ID '123' and completely replace it.
Users.update({ _id: "123" }, { name: "Alice", friends: ["Bob"] });
```

See the [full list of modifiers](http://docs.mongodb.org/manual/reference/operator/update/).

## Sort specifiers {#sortspecifiers}

Sorts may be specified using your choice of several syntaxes:

```js
// All of these do the same thing (sort in ascending order by key `a`, breaking
// ties in descending order of key `b`).
[['a', 'asc'], ['b', 'desc']]
['a', ['b', 'desc']]
{ a: 1, b: -1 }

// Sorted by `createdAt` descending.
Users.find({}, { sort: { createdAt: -1 } });

// Sorted by `createdAt` descending and by `name` ascending.
Users.find({}, { sort: [['createdAt', 'desc'], ['name', 'asc']] });
```

The last form will only work if your JavaScript implementation
preserves the order of keys in objects. Most do, most of the time, but
it's up to you to be sure.

For local collections you can pass a comparator function which receives two
document objects, and returns -1 if the first document comes first in order,
1 if the second document comes first, or 0 if neither document comes before
the other. This is a Minimongo extension to MongoDB.

## Field specifiers {#fieldspecifiers}

Queries can specify a particular set of fields to include or exclude from the
result object.

To exclude specific fields from the result objects, the field specifier is a
dictionary whose keys are field names and whose values are `0`. All unspecified
fields are included.

```js
Users.find({}, { fields: { password: 0, hash: 0 } });
```

To include only specific fields in the result documents, use `1` as
the value. The `_id` field is still included in the result.

```js
Users.find({}, { fields: { firstname: 1, lastname: 1 } });
```

With one exception, it is not possible to mix inclusion and exclusion styles:
the keys must either be all 1 or all 0. The exception is that you may specify
`_id: 0` in an inclusion specifier, which will leave `_id` out of the result
object as well. However, such field specifiers can not be used with
[`observeChangesAsync`](#Mongo-Cursor-observeChangesAsync), [`observeAsync`](#Mongo-Cursor-observeAsync), cursors returned
from a [publish function](./meteor.md#Meteor-publish). They may be used with [`fetch`](#Mongo-Cursor-fetch),
[`findOne`](#Mongo-Collection-findOne), [`forEach`](#Mongo-Cursor-forEach), and [`map`](#Mongo-Cursor-map).

<a href="http://docs.mongodb.org/manual/reference/operator/projection/">Field
operators</a> such as `$` and `$elemMatch` are not available on the client side
yet.


A more advanced example:

```js
Users.insert({
  alterEgos: [
    { name: "Kira", alliance: "murderer" },
    { name: "L", alliance: "police" },
  ],
  name: "Yagami Light",
});

Users.findOne({}, { fields: { "alterEgos.name": 1, _id: 0 } });
// Returns { alterEgos: [{ name: 'Kira' }, { name: 'L' }] }
```



See <a href="http://docs.mongodb.org/manual/tutorial/project-fields-from-query-results/#projection">
the MongoDB docs</a> for details of the nested field rules and array behavior.

## Connecting to your database {#mongo_url}

When developing your application, Meteor starts a local MongoDB instance and
automatically connects to it. In production, you must specify a `MONGO_URL`
environment variable pointing at your database in [the standard mongo connection
string format](https://docs.mongodb.com/manual/reference/connection-string).

> You can also set `MONGO_URL` in development if you want to connect to a
> different MongoDB instance.

If you want to use oplog tailing for livequeries, you should also set
`MONGO_OPLOG_URL` (generally you'll need a special user with oplog access, but
the detail can differ depending on how you host your MongoDB. Read more [here](https://github.com/meteor/docs/blob/master/long-form/oplog-observe-driver.md)).

> As of Meteor 1.4, you must ensure you set the `replicaSet` parameter on your
> `METEOR_OPLOG_URL`

## MongoDB connection options {#mongo_connection_options}

MongoDB provides many connection options, usually the default works but in some
cases you may want to pass additional options. You can do it in two ways:

### Meteor settings {#mongo_connection_options_settings}

You can use your Meteor settings file to set the options in a property called
`options` inside `packages` > `mongo`, these values will be provided as options for MongoDB in
the connect method.

> this option was introduced in Meteor 1.10.2

For example, you may want to specify a certificate for your
TLS connection ([see the options here](https://mongodb.github.io/node-mongodb-native/3.5/tutorials/connect/tls/)) then you could use these options:

```json
  "packages": {
    "mongo": {
      "options": {
        "tls": true,
        "tlsCAFileAsset": "certificate.pem"
      }
    }
  }
```

Meteor will convert relative paths to absolute paths if the option name (key)
ends with `Asset`, for this to work properly you need to place the files in the
`private` folder in the root of your project. In the example Mongo connection would
receive this:

```json
  "packages": {
    "mongo": {
      "options": {
        "tls": true,
        "tlsCAFile": "/absolute/path/certificate.pem"
      }
    }
  }
```

See that the final option name (key) does not contain `Asset` in the end as
expected by MongoDB.

This configuration is necessary in some MongoDB host providers to avoid this
error `MongoNetworkError: failed to connect to server [sg-meteorappdb-32194.servers.mongodirector.com:27017] on first connect [Error: self signed certificate`.

Another way to avoid this error is to allow invalid certificates with this
option:

```json
  "packages": {
    "mongo": {
      "options": {
        "tlsAllowInvalidCertificates": true
      }
    }
  }
```

You can pass any MongoDB valid option, these are just examples using
certificates configurations.

If you're using a certificate and having authentication errors when trying to connect to a database other than `admin`, make sure to provide the flags `&ssl=true&authSource=admin`. You MONGO_URL string should look like this:

```
mongodb://<username>:<password>@[server-1],[server-2],[server-3]/my-database?replicaSet=my-replica&ssl=true&authSource=admin
```

### Mongo Oplog Options {#mongo-oplog-options}

> Oplog options were introduced in Meteor 2.15.1
If you set the [`MONGO_OPLOG_URL`](/cli/environment-variables.html#mongo-oplog-url) env var, Meteor will use MongoDB's Oplog to show efficient, real time updates to your users via your subscriptions.

Due to how Meteor's Oplog implementation is built behind the scenes, if you have certain collections where you expect **big amounts of write operations**, this might lead to **big CPU spikes on your meteor app server, even if you have no publications/subscriptions on any data/documents of these collections**. For more information on this, please have a look into [this blog post from 2016](https://blog.meteor.com/tuning-meteor-mongo-livedata-for-scalability-13fe9deb8908), [this github discussion from 2022](https://github.com/meteor/meteor/discussions/11842) or [this meteor forums post from 2023](https://forums.meteor.com/t/cpu-spikes-due-to-oplog-updates-without-subscriptions/60028).

To solve this, **2 Oplog settings** have been introduced **to tweak, which collections are *watched* or *ignored* in the oplog**.

**Exclusion**: To *exclude* for example all updates/inserts of documents in the 2 collections called `products` and `prices`, you would need to set the following setting in your Meteor settings file:

```json
  "packages": {
    "mongo": {
      "oplogExcludeCollections": ["products", "prices"]
    }
  }
```

**Inclusion**: vice versa, if you only want to watch/*include* the oplog for changes on documents in the 2 collections `chats` and `messages`, you would use:

```json
  "packages": {
    "mongo": {
      "oplogIncludeCollections": ["chats", "messages"]
    }
  }
```

For obvious reasons, using both `oplogExcludeCollections` and `oplogIncludeCollections` at the same time is not possible and will result in an error.

### Mongo.setConnectionOptions(options)

You can also call `Mongo.setConnectionOptions` to set the connection options but
you need to call it before any other package using Mongo connections is
initialized so you need to add this code in a package and add it above the other
packages, like accounts-base in your `.meteor/packages` file.

> this option was introduced in Meteor 1.4
