Class: RethinkDBAdapter

import {DS} from 'js-data'
import RethinkDBAdapter from 'js-data-rethinkdb'
const store = new DS()
const adapter = new RethinkDBAdapter()
store.registerAdapter('rethinkdb', adapter, { 'default': true })

Members

---

authKey :string

TODO

Type:

• string

Source:

• index.js, line 55

---

bufferSize :number

TODO

Type:

• number

Default Value:

• 10

Source:

• index.js, line 63

---

db :string

TODO

Type:

• string

Default Value:

• "test"

Source:

• index.js, line 72

---

debug :boolean

TODO

Type:

• boolean

Default Value:

• false

Source:

• index.js, line 81

---

host :string

TODO

Type:

• string

Default Value:

• "localhost"

Source:

• index.js, line 90

---

max :number

TODO

Type:

• number

Default Value:

• 50

Source:

• index.js, line 108

---

min :number

TODO

Type:

• number

Default Value:

• 10

Source:

• index.js, line 99

---

port :number

TODO

Type:

• number

Default Value:

• 10

Source:

• index.js, line 117

---

raw :boolean

TODO

Type:

• boolean

Default Value:

• false

Source:

• index.js, line 126

---

returnDeletedIds :boolean

TODO

Type:

• boolean

Default Value:

• false

Source:

• index.js, line 135

Methods

---

afterCreate()

Source:

• index.js, line 185

---

afterCreateMany()

Source:

• index.js, line 191

---

afterDestroy()

Source:

• index.js, line 197

---

afterDestroyAll()

Source:

• index.js, line 203

---

afterFind()

Source:

• index.js, line 209

---

afterFindAll()

Source:

• index.js, line 215

---

afterUpdate()

Source:

• index.js, line 221

---

afterUpdateAll()

Source:

• index.js, line 227

---

afterUpdateMany()

Source:

• index.js, line 233

---

beforeCreate()

Source:

• index.js, line 239

---

beforeCreateMany()

Source:

• index.js, line 245

---

beforeDestroy()

Source:

• index.js, line 251

---

beforeDestroyAll()

Source:

• index.js, line 257

---

beforeFind()

Source:

• index.js, line 263

---

beforeFindAll()

Source:

• index.js, line 269

---

beforeUpdate()

Source:

• index.js, line 275

---

beforeUpdateAll()

Source:

• index.js, line 281

---

beforeUpdateMany()

Source:

• index.js, line 287

---

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 raw boolean <optional> false TODO

Source:

• index.js, line 434

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 raw boolean <optional> false TODO

Source:

• index.js, line 479

Returns:

Type

Promise

---

dbg()

Source:

• index.js, line 293

---

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 raw boolean <optional> false TODO returnDeletedIds boolean <optional> false Whether to return the primary keys of any deleted records.

Source:

• index.js, line 526

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 raw boolean <optional> false TODO returnDeletedIds boolean <optional> false Whether to return the primary keys of any deleted records.

Source:

• index.js, line 571

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 TODO with Array.<string> <optional> [] TODO

Source:

• index.js, line 763

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 TODO with Array.<string> <optional> [] TODO

Source:

• index.js, line 871

Returns:

Type

Promise

---

getRaw()

TODO

Source:

• index.js, line 1001

---

loadBelongsTo()

TODO

Source:

• index.js, line 723

Returns:

Type

Promise

---

loadHasMany()

TODO

Source:

• index.js, line 645

Returns:

Type

Promise

---

loadHasOne()

TODO

Source:

• index.js, line 691

Returns:

Type

Promise

---

log()

TODO

Source:

• index.js, line 1012

---

makeBelongsToForeignKey()

TODO

Source:

• index.js, line 712

Returns:

Type

*

---

makeHasManyForeignKey()

TODO

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 631

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 raw boolean <optional> false TODO

Source:

• index.js, line 1034

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 raw boolean <optional> false TODO

Source:

• index.js, line 1083

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 raw boolean <optional> false TODO

Source:

• index.js, line 1130

Returns:

Type

Promise