js-data-rethinkdb

Class: RethinkDBAdapter

RethinkDBAdapter

new RethinkDBAdapter(opts)

RethinkDBAdapter class.

Method parameters:
Name Type Argument Description
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
authKey String <optional>
 ""

See RethinkDBAdapter#authKey.
bufferSize Number <optional>
 10

See RethinkDBAdapter#bufferSize.
db String <optional>
 "test"

Default database.
debug Boolean <optional>
 false

See Adapter#debug.
deleteOpts Object <optional>
 {}

See RethinkDBAdapter#deleteOpts.
host String <optional>
 "localhost"

See RethinkDBAdapter#host.
insertOpts Object <optional>
 {}

See RethinkDBAdapter#insertOpts.
max Number <optional>
 50

See RethinkDBAdapter#max.
min Number <optional>
 10

See RethinkDBAdapter#min.
operators Object <optional>

See RethinkDBAdapter#operators.
port Number <optional>
 28015

See RethinkDBAdapter#port.
raw Boolean <optional>
 false

See Adapter#raw.
runOpts Object <optional>
 {}

See RethinkDBAdapter#runOpts.
updateOpts Object <optional>
 {}

See RethinkDBAdapter#updateOpts.
Details
Source
src/index.js, line 151
Example 
// Use Container instead of DataStore on the server
import {Container} from 'js-data'
import RethinkDBAdapter from 'js-data-rethinkdb'

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

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

// 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')

Extends

This class extends the Adapter class.

Members

authKey

RethinkDB authorization key.

Details
Type Source
String src/index.js, line 13

bufferSize

Buffer size for connection pool.

Details
Type Default value Source
Number 
10
 src/index.js, line 21

db

Default database.

Details
Type Default value Source
String 
"test"
 src/index.js, line 30

debug

Whether to log debugging information.

Details
Type Default value Source
Boolean 
false
 node_modules/js-data-adapter/src/index.js, line 36
Inherited From:

deleteOpts

Default options to pass to r#delete.

Details
Type Default value Source
Object 
{}
 src/index.js, line 216

host

RethinkDB host.

Details
Type Default value Source
String 
"localhost"
 src/index.js, line 39

insertOpts

Default options to pass to r#insert.

Details
Type Default value Source
Object 
{}
 src/index.js, line 196

max

Maximum connections in pool.

Details
Type Default value Source
Number 
50
 src/index.js, line 57

min

Minimum connections in pool.

Details
Type Default value Source
Number 
10
 src/index.js, line 48

operators

Override the default predicate functions for specified operators.

Details
Type Default value Source
Object 
{}
 src/index.js, line 236

port

RethinkDB port.

Details
Type Default value Source
Number 
28015
 src/index.js, line 66

r

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

Details
Type Source
Object src/index.js, line 247

raw

Whether to return a more detailed response object.

Details
Type Default value Source
Boolean 
false
 node_modules/js-data-adapter/src/index.js, line 45
Inherited From:

runOpts

Default options to pass to r#run.

Details
Type Default value Source
Object 
{}
 src/index.js, line 226

updateOpts

Default options to pass to r#update.

Details
Type Default value Source
Object 
{}
 src/index.js, line 206

Methods

<static> extend(instanceProps, classProps)

Alternative to ES6 class syntax for extending RethinkDBAdapter.

Method parameters:
Name Type Argument Description
instanceProps Object <optional>

Properties that will be added to the prototype of the Subclass.
classProps Object <optional>

Properties that will be added as static properties to the Subclass itself.
Return value:
Type Description
Constructor

Subclass of RethinkDBAdapter.
Details
Source
src/index.js, line 275
Examples

Using the ES2015 class syntax.

class MyRethinkDBAdapter extends RethinkDBAdapter {...}
const adapter = new MyRethinkDBAdapter()

Using RethinkDBAdapter.extend.

var instanceProps = {...}
var classProps = {...}

var MyRethinkDBAdapter = RethinkDBAdapter.extend(instanceProps, classProps)
var adapter = new MyRethinkDBAdapter()

afterCount(mapper, props, opts, response)

Lifecycle method method called by count.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes count to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the count.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by count.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to count.
props Object

The props argument passed to count.
opts Object

The opts argument passed to count.
response Object | Response

Count or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 124
Properties:
Name Type Description
opts.op String

afterCount
Inherited From:

afterCreate(mapper, props, opts, response)

Lifecycle method method called by create.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes create to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the created record.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by create.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to create.
props Object

The props argument passed to create.
opts Object

The opts argument passed to create.
response Object | Response

Created record or Response, depending on the value of opts.raw.
Details
Source Overrides
node_modules/js-data-adapter/src/index.js, line 147 Adapter#afterCreate
Properties:
Name Type Description
opts.op String

afterCreate
Inherited From:

afterDestroy(mapper, id, opts, response)

Lifecycle method method called by destroy.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes destroy to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be undefined.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by destroy.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to destroy.
id String | Number

The id argument passed to destroy.
opts Object

The opts argument passed to destroy.
response undefined | Response

undefined or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 193
Properties:
Name Type Description
opts.op String

afterDestroy
Inherited From:

afterDestroyAll(mapper, query, opts, response)

Lifecycle method method called by destroyAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes destroyAll to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be undefined.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by destroyAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to destroyAll.
query Object

The query argument passed to destroyAll.
opts Object

The opts argument passed to destroyAll.
response undefined | Response

undefined or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 216
Properties:
Name Type Description
opts.op String

afterDestroyAll
Inherited From:

afterFind(mapper, id, opts, response)

Lifecycle method method called by find.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes find to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the found record, if any.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by find.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to find.
id String | Number

The id argument passed to find.
opts Object

The opts argument passed to find.
response Object | Response

The found record or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 239
Properties:
Name Type Description
opts.op String

afterFind
Inherited From:

afterFindAll(mapper, query, opts, response)

Lifecycle method method called by findAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes findAll to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the found records, if any.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by findAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to findAll.
query Object

The query argument passed to findAll.
opts Object

The opts argument passed to findAll.
response Array.<Object> | Response

The found records or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 262
Properties:
Name Type Description
opts.op String

afterFindAll
Inherited From:

afterSum(mapper, field, query, opts, response)

Lifecycle method method called by sum.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes sum to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the sum.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by sum.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to sum.
field String

The field argument passed to sum.
query Object

The query argument passed to sum.
opts Object

The opts argument passed to sum.
response Object | Response

Count or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 285
Properties:
Name Type Description
opts.op String

afterSum
Inherited From:

afterUpdate(mapper, id, props, opts, response)

Lifecycle method method called by update.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes update to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the updated record.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by update.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to update.
id String | Number

The id argument passed to update.
props Object

The props argument passed to update.
opts Object

The opts argument passed to update.
response Object | Response

The updated record or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 309
Properties:
Name Type Description
opts.op String

afterUpdate
Inherited From:

afterUpdateAll(mapper, props, query, opts, response)

Lifecycle method method called by updateAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes updateAll to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the updated records, if any.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by updateAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to updateAll.
props Object

The props argument passed to updateAll.
query Object

The query argument passed to updateAll.
opts Object

The opts argument passed to updateAll.
response Array.<Object> | Response

The updated records or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 333
Properties:
Name Type Description
opts.op String

afterUpdateAll
Inherited From:

afterUpdateMany(mapper, records, opts, response)

Lifecycle method method called by updateMany.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes updateMany to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the updated records, if any.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by updateMany.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to updateMany.
records Array.<Object>

The records argument passed to updateMany.
opts Object

The opts argument passed to updateMany.
response Array.<Object> | Response

The updated records or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 357
Properties:
Name Type Description
opts.op String

afterUpdateMany
Inherited From:

beforeCount(mapper, query, opts)

Lifecycle method method called by count.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes count to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by count.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to count.
query Object

The query argument passed to count.
opts Object

The opts argument passed to count.
Details
Source
node_modules/js-data-adapter/src/index.js, line 380
Properties:
Name Type Description
opts.op String

beforeCount
Inherited From:

beforeCreate(mapper, props, opts)

Lifecycle method method called by create.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes create to wait for the Promise to resolve before continuing.

props may be modified. You can also re-assign props to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by create.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to create.
props Object

The props argument passed to create.
opts Object

The opts argument passed to create.
Details
Source
node_modules/js-data-adapter/src/index.js, line 398
Properties:
Name Type Description
opts.op String

beforeCreate
Inherited From:

beforeCreateMany(mapper, props, opts)

Lifecycle method method called by createMany.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes createMany to wait for the Promise to resolve before continuing.

props may be modified. You can also re-assign props to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by createMany.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to createMany.
props Array.<Object>

The props argument passed to createMany.
opts Object

The opts argument passed to createMany.
Details
Source
node_modules/js-data-adapter/src/index.js, line 418
Properties:
Name Type Description
opts.op String

beforeCreateMany
Inherited From:

beforeDestroy(mapper, id, opts)

Lifecycle method method called by destroy.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes destroy to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by destroy.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to destroy.
id String | Number

The id argument passed to destroy.
opts Object

The opts argument passed to destroy.
Details
Source
node_modules/js-data-adapter/src/index.js, line 438
Properties:
Name Type Description
opts.op String

beforeDestroy
Inherited From:

beforeDestroyAll(mapper, query, opts)

Lifecycle method method called by destroyAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes destroyAll to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by destroyAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to destroyAll.
query Object

The query argument passed to destroyAll.
opts Object

The opts argument passed to destroyAll.
Details
Source
node_modules/js-data-adapter/src/index.js, line 456
Properties:
Name Type Description
opts.op String

beforeDestroyAll
Inherited From:

beforeFind(mapper, id, opts)

Lifecycle method method called by find.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes find to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by find.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to find.
id String | Number

The id argument passed to find.
opts Object

The opts argument passed to find.
Details
Source
node_modules/js-data-adapter/src/index.js, line 474
Properties:
Name Type Description
opts.op String

beforeFind
Inherited From:

beforeFindAll(mapper, query, opts)

Lifecycle method method called by findAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes findAll to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by findAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to findAll.
query Object

The query argument passed to findAll.
opts Object

The opts argument passed to findAll.
Details
Source
node_modules/js-data-adapter/src/index.js, line 492
Properties:
Name Type Description
opts.op String

beforeFindAll
Inherited From:

beforeSum(mapper, query, opts)

Lifecycle method method called by sum.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes sum to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by sum.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to sum.
query Object

The query argument passed to sum.
opts Object

The opts argument passed to sum.
Details
Source
node_modules/js-data-adapter/src/index.js, line 510
Properties:
Name Type Description
opts.op String

beforeSum
Inherited From:

beforeUpdate(mapper, id, props, opts)

Lifecycle method method called by update.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes update to wait for the Promise to resolve before continuing.

props may be modified. You can also re-assign props to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by update.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to update.
id String | Number

The id argument passed to update.
props Object

The props argument passed to update.
opts Object

The opts argument passed to update.
Details
Source
node_modules/js-data-adapter/src/index.js, line 528
Properties:
Name Type Description
opts.op String

beforeUpdate
Inherited From:

beforeUpdateAll(mapper, props, query, opts)

Lifecycle method method called by updateAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes updateAll to wait for the Promise to resolve before continuing.

props may be modified. You can also re-assign props to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by updateAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to updateAll.
props Object

The props argument passed to updateAll.
query Object

The query argument passed to updateAll.
opts Object

The opts argument passed to updateAll.
Details
Source
node_modules/js-data-adapter/src/index.js, line 549
Properties:
Name Type Description
opts.op String

beforeUpdateAll
Inherited From:

beforeUpdateMany(mapper, props, opts)

Lifecycle method method called by updateMany.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes updateMany to wait for the Promise to resolve before continuing.

props may be modified. You can also re-assign props to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by updateMany.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to updateMany.
props Array.<Object>

The props argument passed to updateMany.
opts Object

The opts argument passed to updateMany.
Details
Source
node_modules/js-data-adapter/src/index.js, line 570
Properties:
Name Type Description
opts.op String

beforeUpdateMany
Inherited From:

count(mapper, query, opts)

Return the number of records that match the selection query.

Method parameters:
Name Type Argument Description
mapper Object

the mapper.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
operators Object <optional>

Override the default predicate functions for specified operators.
raw Boolean <optional>
 false

Whether to return a more detailed response object.
runOpts Object <optional>

Options to pass to r#run.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 649 Adapter#count

create(mapper, props, opts)

Create a new record.

Method 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.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 680 Adapter#create

createMany(mapper, props, opts)

Create multiple records in a single batch.

Method 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.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 704 Adapter#createMany

dbg()

Shortcut for #log('debug'[, arg1[, arg2[, argn]]]).

Details
Source
node_modules/js-data-adapter/src/index.js, line 590
Inherited From:

destroy(mapper, id, opts)

Destroy the record with the given primary key.

Method 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.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 728 Adapter#destroy

destroyAll(mapper, query, opts)

Destroy the records that match the selection query.

Method parameters:
Name Type Argument Description
mapper Object

the mapper.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
deleteOpts Object <optional>

Options to pass to r#delete.
operators Object <optional>

Override the default predicate functions for specified operators.
raw Boolean <optional>
 false

Whether to return a more detailed response object.
runOpts Object <optional>

Options to pass to r#run.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 751 Adapter#destroyAll

filterSequence(mapper, query, opts)

Apply the specified selection query to the provided RQL sequence.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Description
operators Object <optional>

Override the default predicate functions for specified operators.
Details
Source
src/index.js, line 500

find(mapper, id, opts)

Retrieve the record with the given primary key.

Method 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.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 783 Adapter#find

findAll(mapper, query, opts)

Retrieve the records that match the selection query.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
operators Object <optional>

Override the default predicate functions for specified operators.
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.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 824 Adapter#findAll

getOperator(operator, opts)

Resolve the predicate function for the specified operator based on the given options and this adapter's settings.

Method parameters:
Name Type Argument Description
operator String

The name of the operator.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Description
operators Object <optional>

Override the default predicate functions for specified operators.
Return value:
Type Description
*

The predicate function for the specified operator.
Details
Source
src/index.js, line 874

getOpt(opt, opts)

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

Method parameters:
Name Type Argument Description
opt String

The name of the option.
opts Object <optional>

Configuration options.
Return value:
Type Description
*

The value of the specified option.
Details
Source
node_modules/js-data-adapter/src/index.js, line 1013
Inherited From:

loadBelongsTo()

Load a belongsTo relationship.

Override with care.

Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 821
Inherited From:

loadHasMany()

Load a hasMany relationship.

Override with care.

Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1028
Inherited From:

loadHasOne()

Load a hasOne relationship.

Override with care.

Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1171
Inherited From:

log(level, values)

Logging utility method. Override this method if you want to send log messages to something other than the console.

Method parameters:
Name Type Argument Description
level String

Log level.
values * <repeatable>

Values to log.
Details
Source
node_modules/js-data-adapter/src/index.js, line 1194
Inherited From:

makeBelongsToForeignKey()

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

Override with care.

Return value:
Type Description
* Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1265
Inherited From:

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.

Override with care.

Return value:
Type Description
* Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1219
Inherited From:

makeHasManyForeignKeys()

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

Override with care.

Return value:
Type Description
* Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1252
Inherited From:

makeHasManyLocalKeys()

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

Override with care.

Return value:
Type Description
* Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1235
Inherited From:

respond(response, opts)

Method parameters:
Name Type Description
response Object

Response object.
opts Object

Configuration options. return {Object} If opts.raw == true then return response, else return response.data.
Details
Source
node_modules/js-data-adapter/src/index.js, line 1329
Inherited From:

sum(mapper, field, query, opts)

Return the sum of the specified field of records that match the selection query.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
field String

The field to sum.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
operators Object <optional>

Override the default predicate functions for specified operators.
raw Boolean <optional>
 false

Whether to return a more detailed response object.
runOpts Object <optional>

Options to pass to r#run.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 893 Adapter#sum

update(mapper, id, props, opts)

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

Method 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.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 926 Adapter#update

updateAll(mapper, props, query, opts)

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

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
props Object

The update to apply to the selected records.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
operators Object <optional>

Override the default predicate functions for specified operators.
raw Boolean <optional>
 false

Whether to return a more detailed response object.
runOpts Object <optional>

Options to pass to r#run.
updateOpts Object <optional>

Options to pass to r#update.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 951 Adapter#updateAll

updateMany(mapper, records, opts)

Update the given records in a single batch.

Method 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.
Return value:
Type Description
Promise Unspecified
Details
Source Overrides
src/index.js, line 985 Adapter#updateMany