js-data-mongodb Class: MongoDBAdapter

new MongoDBAdapter(opts)

MongoDBAdapter class.

Parameters:

Name Type Argument Description

opts

Object

Configuration opts.

Properties

Name	Type	Argument	Default	Description
`debug`	boolean	<optional>	false	Whether to log debugging information.
`findOpts`	Object	<optional>		Options to pass to collection#find.
`findOneOpts`	Object	<optional>		Options to pass to collection#findOne.
`insertOpts`	Object	<optional>		Options to pass to collection#insert.
`insertManyOpts`	Object	<optional>		Options to pass to collection#insertMany.
`raw`	boolean	<optional>	false	Whether to return detailed result objects instead of just record data.
`removeOpts`	Object	<optional>		Options to pass to collection#remove.
`translateId`	boolean	<optional>	true	Convert ObjectIDs to strings when pulling records out of the database.
`updateOpts`	Object	<optional>		Options to pass to collection#update.
`uri`	string	<optional>	"mongodb://localhost:27017"	MongoDB URI.

Source:

index.js, line 100

Example

// Use Container instead of DataStore on the server
import {Container} from 'js-data'
import MongoDBAdapter from 'js-data-mongodb'

// Create a store to hold your Mappers
const store = new Container({
  mapperDefaults: {
    // MongoDB uses "_id" as the primary key
    idAttribute: '_id'
  }
})

// Create an instance of MongoDBAdapter with default settings
const adapter = new MongoDBAdapter()

// Mappers in "store" will use the MongoDB adapter by default
store.registerAdapter('mongodb', adapter, { default: true })

// Create a Mapper that maps to a "user" collection
store.defineMapper('user')

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 210

debug :boolean

Whether to log debugging information.

Type:

boolean

Default Value:

false

Source:

index.js, line 56

findOneOpts :Object

Default options to pass to collection#findOne.

Type:

Object

Default Value:

{}

Source:

index.js, line 160

findOpts :Object

Default options to pass to collection#find.

Type:

Object

Default Value:

{}

Source:

index.js, line 150

insertManyOpts :Object

Default options to pass to collection#insertMany.

Type:

Object

Default Value:

{}

Source:

index.js, line 180

insertOpts :Object

Default options to pass to collection#insert.

Type:

Object

Default Value:

{}

Source:

index.js, line 170

raw :boolean

Whether to return detailed result objects instead of just record data.

Type:

boolean

Default Value:

false

Source:

index.js, line 65

removeOpts :Object

Default options to pass to collection#update.

Type:

Object

Default Value:

{}

Source:

index.js, line 200

translateId :boolean

Convert ObjectIDs to strings when pulling records out of the database.

Type:

boolean

Default Value:

true

Source:

index.js, line 74

updateOpts :Object

Default options to pass to collection#update.

Type:

Object

Default Value:

{}

Source:

index.js, line 190

uri :string

MongoDB URI.

Type:

string

Default Value:

mongodb://localhost:27017

Source:

index.js, line 83

Methods

_translateId()

Translate ObjectIDs to strings.

Source:

index.js, line 225

Returns:

Type: *

afterCreate()

Source:

index.js, line 248

afterCreateMany()

Source:

index.js, line 254

afterDestroy()

Source:

index.js, line 260

afterDestroyAll()

Source:

index.js, line 266

afterFind()

Source:

index.js, line 272

afterFindAll()

Source:

index.js, line 278

afterUpdate()

Source:

index.js, line 284

afterUpdateAll()

Source:

index.js, line 290

afterUpdateMany()

Source:

index.js, line 296

beforeCreate()

Source:

index.js, line 302

beforeCreateMany()

Source:

index.js, line 308

beforeDestroy()

Source:

index.js, line 314

beforeDestroyAll()

Source:

index.js, line 320

beforeFind()

Source:

index.js, line 326

beforeFindAll()

Source:

index.js, line 332

beforeUpdate()

Source:

index.js, line 338

beforeUpdateAll()

Source:

index.js, line 344

beforeUpdateMany()

Source:

index.js, line 350

create(mapper, props, opts)

Create a new record.

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

props

Object

The record to be created.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`insertOpts`	Object	<optional>		Options to pass to collection#insert.
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.

Source:

index.js, line 948

Returns:

Type: Promise

createMany(mapper, props, opts)

Create multiple records in a single batch.

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

props

Object

The records to be created.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`insertManyOpts`	Object	<optional>		Options to pass to collection#insertMany.
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.

Source:

index.js, line 1004

Returns:

Type: Promise

dbg()

Source:

index.js, line 356

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

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.
`removeOpts`	Object	<optional>		Options to pass to collection#remove.

Source:

index.js, line 1060

Returns:

Type: Promise

destroyAll(mapper, query, opts)

Destroy the records that match the selection query.

Parameters:

Name Type Argument Description

mapper

Object

the mapper.

query

Object

Selection query.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.
`removeOpts`	Object	<optional>		Options to pass to collection#remove.

Source:

index.js, line 1107

Returns:

Type: Promise

find(mapper, id, opts)

Retrieve the record with the given primary key.

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

id

string | number

Primary key of the record to retrieve.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`findOneOpts`	Object	<optional>		Options to pass to collection#findOne.
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.
`with`	Array.<string>	<optional>	[]	Relations to eager load.

Source:

index.js, line 748

Returns:

Type: Promise

findAll(mapper, query, opts)

Retrieve the records that match the selection query.

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

query

Object

Selection query.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`findOpts`	Object	<optional>		Options to pass to collection#find.
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.
`with`	Array.<string>	<optional>	[]	Relations to eager load.

Source:

index.js, line 848

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 364

Returns:

MongoDB client.

Type: Object

getOpt(opt, opts)

Resolve the value of the specified option based on the given options and this adapter's settings.

Parameters:

Name	Type	Argument	Description
`opt`	string		The name of the option.
`opts`	Object	<optional>	Configuration options.

Source:

index.js, line 569

Returns:

The value of the specified option.

Type: *

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 378

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 524

Returns:

Type: Object

loadBelongsTo()

Load a belongsTo relationship.

Source:

index.js, line 708

Returns:

Type: Promise

loadHasMany()

Load a hasMany relationship.

Source:

index.js, line 630

Returns:

Type: Promise

loadHasOne()

Load a hasOne relationship.

Source:

index.js, line 676

Returns:

Type: Promise

log()

Logging utility method.

Source:

index.js, line 502

makeBelongsToForeignKey()

Return the foreignKey from the given record for the provided relationship.

Source:

index.js, line 697

Returns:

Type: *

makeHasManyForeignKey()

Return the foreignKey from the given record for the provided relationship.

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

return this.toObjectID(mapper, this.constructor.prototype.makeHasManyForeignKey.call(this, mapper, 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 598

Returns:

Type: *

makeHasManyForeignKeys()

Return the foreignKeys from the given record for the provided relationship.

Source:

index.js, line 619

Returns:

Type: *

toObjectID()

Turn an _id into an ObjectID if it isn't already an ObjectID.

Source:

index.js, line 584

Returns:

Type: *

update(mapper, id, props, opts)

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

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

id

string | number

The primary key of the record to be updated.

props

Object

The update to apply to the record.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.
`updateOpts`	Object	<optional>		Options to pass to collection#update.

Source:

index.js, line 1155

Returns:

Type: Promise

updateAll(mapper, props, query, opts)

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

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

props

Object

The update to apply to the selected records.

query

Object

Selection query.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.
`updateOpts`	Object	<optional>		Options to pass to collection#update.

Source:

index.js, line 1216

Returns:

Type: Promise

updateMany()

Not supported.

Source:

index.js, line 1284