Class: RethinkDBAdapter

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

// Create a store to hold your Mappers
const store = new Container()

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

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

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

Members

---

authKey :string

RethinkDB authorization key.

Type:

• string

Source:

• index.js, line 55

---

bufferSize :number

Buffer size for connection pool.

Type:

• number

Default Value:

• 10

Source:

• index.js, line 63

---

db :string

Default database.

Type:

• string

Default Value:

• "test"

Source:

• index.js, line 72

---

debug :boolean

Whether to log debugging information.

Type:

• boolean

Default Value:

• false

Source:

• index.js, line 81

---

deleteOpts :Object

Default options to pass to r#delete.

Type:

• Object

Default Value:

• {}

Source:

• index.js, line 200

---

host :string

RethinkDB host.

Type:

• string

Default Value:

• "localhost"

Source:

• index.js, line 90

---

insertOpts :Object

Default options to pass to r#insert.

Type:

• Object

Default Value:

• {}

Source:

• index.js, line 180

---

max :number

Maximum connections in pool.

Type:

• number

Default Value:

• 50

Source:

• index.js, line 108

---

min :number

Minimum connections in pool.

Type:

• number

Default Value:

• 10

Source:

• index.js, line 99

---

port :number

RethinkDB port.

Type:

• number

Default Value:

• 10

Source:

• index.js, line 117

---

r :Object

The rethinkdbdash instance used by this adapter. Use this directly when you need to write custom queries.

Type:

• Object

Source:

• index.js, line 220

---

raw :boolean

Whether to return a more detailed response object.

Type:

• boolean

Default Value:

• false

Source:

• index.js, line 126

---

runOpts :Object

Default options to pass to r#run.

Type:

• Object

Default Value:

• {}

Source:

• index.js, line 210

---

updateOpts :Object

Default options to pass to r#update.

Type:

• Object

Default Value:

• {}

Source:

• index.js, line 190

Methods

---

afterCreate()

Source:

• index.js, line 242

---

afterCreateMany()

Source:

• index.js, line 248

---

afterDestroy()

Source:

• index.js, line 254

---

afterDestroyAll()

Source:

• index.js, line 260

---

afterFind()

Source:

• index.js, line 266

---

afterFindAll()

Source:

• index.js, line 272

---

afterUpdate()

Source:

• index.js, line 278

---

afterUpdateAll()

Source:

• index.js, line 284

---

afterUpdateMany()

Source:

• index.js, line 290

---

beforeCreate()

Source:

• index.js, line 296

---

beforeCreateMany()

Source:

• index.js, line 302

---

beforeDestroy()

Source:

• index.js, line 308

---

beforeDestroyAll()

Source:

• index.js, line 314

---

beforeFind()

Source:

• index.js, line 320

---

beforeFindAll()

Source:

• index.js, line 326

---

beforeUpdate()

Source:

• index.js, line 332

---

beforeUpdateAll()

Source:

• index.js, line 338

---

beforeUpdateMany()

Source:

• index.js, line 344

---

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	<optional>	Configuration options. Properties Name Type Argument Default Description insertOpts Object <optional> Options to pass to r#insert. raw boolean <optional> false Whether to return a more detailed response object. runOpts Object <optional> Options to pass to r#run.

Source:

• index.js, line 491

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	<optional>	Configuration options. Properties Name Type Argument Default Description insertOpts Object <optional> Options to pass to r#insert. raw boolean <optional> false Whether to return a more detailed response object. runOpts Object <optional> Options to pass to r#run.

Source:

• index.js, line 541

Returns:

Type

Promise

---

dbg()

Source:

• index.js, line 350

---

destroy(mapper, id, opts)

Destroy 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 destroy.
opts	Object	<optional>	Configuration options. Properties Name Type Argument Default Description deleteOpts Object <optional> Options to pass to r#delete. raw boolean <optional> false Whether to return a more detailed response object. runOpts Object <optional> Options to pass to r#run.

Source:

• index.js, line 593

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	<optional>	Selection query.
opts	Object	<optional>	Configuration options. Properties Name Type Argument Default Description deleteOpts Object <optional> Options to pass to r#delete. raw boolean <optional> false Whether to return a more detailed response object. runOpts Object <optional> Options to pass to r#run.

Source:

• index.js, line 632

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	<optional>	Configuration options. Properties Name Type Argument Default Description raw boolean <optional> false Whether to return a more detailed response object. runOpts Object <optional> Options to pass to r#run. with Array.<string> <optional> [] Relations to eager load.

Source:

• index.js, line 807

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	<optional>	Configuration options. Properties Name Type Argument Default Description raw boolean <optional> false Whether to return a more detailed response object. runOpts Object <optional> Options to pass to r#run. with Array.<string> <optional> [] Relations to eager load.

Source:

• index.js, line 916

Returns:

Type

Promise

---

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 1047

Returns:

The value of the specified option.

Type

*

---

loadBelongsTo()

Load a belongsTo relationship.

Source:

• index.js, line 767

Returns:

Type

Promise

---

loadHasMany()

Load a hasMany relationship.

Source:

• index.js, line 689

Returns:

Type

Promise

---

loadHasOne()

Load a hasOne relationship.

Source:

• index.js, line 735

Returns:

Type

Promise

---

log()

Logging utility method.

Source:

• index.js, line 1062

---

makeBelongsToForeignKey()

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

Source:

• index.js, line 756

Returns:

Type

*

---

makeHasManyForeignKey()

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

There may be 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 675

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	<optional>	Configuration options. Properties Name Type Argument Default Description updateOpts Object <optional> Options to pass to r#update. raw boolean <optional> false Whether to return a more detailed response object. runOpts Object <optional> Options to pass to r#run.

Source:

• index.js, line 1084

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	<optional>	Selection query.
opts	Object	<optional>	Configuration options. Properties Name Type Argument Default Description updateOpts Object <optional> Options to pass to r#update. raw boolean <optional> false Whether to return a more detailed response object. runOpts Object <optional> Options to pass to r#run.

Source:

• index.js, line 1138

Returns:

Type

Promise

---

updateMany(mapper, records, opts)

Update the given records in a single batch.

Parameters:

Name	Type	Argument	Description
mapper	Object		The mapper.
records	Array.<Object>		The records to update.
opts	Object	<optional>	Configuration options. Properties Name Type Argument Default Description insertOpts Object <optional> Options to pass to r#insert. raw boolean <optional> false Whether to return a more detailed response object. runOpts Object <optional> Options to pass to r#run.

Source:

• index.js, line 1190

Returns:

Type

Promise