Class: MongoDBAdapter

import {DS} from 'js-data'
import MongoDBAdapter from 'js-data-mongodb'
const store = new DS()
const adapter = new MongoDBAdapter({
  uri: 'mongodb://localhost:27017'
})
store.registerAdapter('mongodb', adapter, { 'default': true })

Members

---

client :Object

A Promise that resolves to a reference to the MongoDB client being used by this adapter.

Type:

• Object

Source:

• index.js, line 79

Methods

---

create(Resource, props, opts)

Create a new record.

Parameters:

Name	Type	Argument	Description
Resource	Object		The Resource.
props	Object		The record to be created.
opts	Object	<optional>	Configuration options.

Source:

• index.js, line 671

Returns:

Type

Promise

---

destroy(Resource, id, opts)

Destroy the record with the given primary key.

Parameters:

Name	Type	Argument	Description
Resource	Object		The Resource.
id	string | number		Primary key of the record to destroy.
opts	Object	<optional>	Configuration options.

Source:

• index.js, line 703

Returns:

Type

Promise

---

destroyAll(Resource, query, opts)

Destroy the records that match the selection query.

Parameters:

Name	Type	Argument	Description
Resource	Object		the Resource.
query	Object	<optional>	Selection query.
opts	Object	<optional>	Configuration options.

Source:

• index.js, line 733

Returns:

Type

Promise

---

find(Resource, id, opts)

Retrieve the record with the given primary key.

Parameters:

Name	Type	Argument	Description
Resource	Object		The Resource.
id	string | number		Primary key of the record to retrieve.
opts	Object	<optional>	Configuration options. Properties Name Type Argument Default Description with Array.<string> <optional> [] TODO

Source:

• index.js, line 469

Returns:

Type

Promise

---

findAll(Resource, query, opts)

Retrieve the records that match the selection query.

Parameters:

Name	Type	Argument	Description
Resource	Object		The Resource.
query	Object		Selection query.
opts	Object	<optional>	Configuration options. Properties Name Type Argument Default Description with Array.<string> <optional> [] TODO

Source:

• index.js, line 566

Returns:

Type

Promise

---

getClient()

Return a Promise that resolves to a reference to the MongoDB client being used by this adapter.

Useful when you need to do anything custom with the MongoDB client library.

Source:

• index.js, line 94

Returns:

MongoDB client.

Type

Object

---

getQuery()

Map filtering params in a selection query to MongoDB a filtering object.

Handles the following:

• where
  • and bunch of filtering operators

Source:

• index.js, line 108

Returns:

Type

Object

---

getQueryOptions()

Map non-filtering params in a selection query to MongoDB query options.

Handles the following:

• limit
• skip/offset
• orderBy/sort

Source:

• index.js, line 233

Returns:

Type

Object

---

loadBelongsTo()

TODO

Source:

• index.js, line 429

Returns:

Type

Promise

---

loadHasMany()

TODO

Source:

• index.js, line 351

Returns:

Type

Promise

---

loadHasOne()

TODO

Source:

• index.js, line 397

Returns:

Type

Promise

---

makeBelongsToForeignKey()

TODO

Source:

• index.js, line 418

Returns:

Type

*

---

makeHasManyForeignKey()

TODO

If the foreignKeys in your database are saved as ObjectIDs, then override this method and change it to something like:

return this.toObjectID(Resource, this.constructor.prototype.makeHasManyForeignKey.call(this, Resource, def, record))

There may be other reasons why you may want to override this method, like when the id of the parent doesn't exactly match up to the key on the child.

Source:

• index.js, line 330

Returns:

Type

*

---

makeHasManyForeignKey()

TODO

Source:

• index.js, line 316

Returns:

Type

*

---

origify()

TODO

Source:

• index.js, line 301

Returns:

Type

Object

---

translateId()

TODO

Source:

• index.js, line 278

Returns:

Type

*

---

update(Resource, id, props, opts)

Apply the given update to the record with the specified primary key.

Parameters:

Name	Type	Argument	Description
Resource	Object		The Resource.
id	string | number		The primary key of the record to be updated.
props	Object		The update to apply to the record.
opts	Object	<optional>	Configuration options.

Source:

• index.js, line 763

Returns:

Type

Promise

---

updateAll(Resource, props, query, opts)

Apply the given update to all records that match the selection query.

Parameters:

Name	Type	Argument	Description
Resource	Object		The Resource.
props	Object		The update to apply to the selected records.
query	Object	<optional>	Selection query.
opts	Object	<optional>	Configuration options.

Source:

• index.js, line 799

Returns:

Type

Promise