Helper

model:find(name, opts)

Find records from DAB that matched your query.

See this for details.

Usage:

helper('model:find')(name, opts)

name <string> Required.
body <Object> Required.
opts <Object> Default: {}
- query <object> DAB query. Default: {}
- limit <integer> Limit number of results. Defaults to common.default.limit from your model.json
- page <integer> Page number. Default: 1
- sort <Object> Default: {}

Object like this:

{
  "success": true,
  "total": 100,
  "data": [{
    "_id": "james-bond",
    "first_name": "James",
    "last_name": "Bond",
    "age": 38
  }, {
    "_id": "jack-bauer",
    "first_name": "Jack",
    "last_name": "Bauer",
    "age": null
  }]
}

More info here

model:findOne(name, id)

Usage:

helper('model:findOne')(name, id, opts)

name <string> Required.
id <string | integer> Required.
opts <Object> Default: {}
- dab <object> DAB options. Default: {}

model:create

Usage:

helper('model:create')(name, body, opts)

name <string> Required.
body <Object> Required.
opts <Object> Default: {}
- dab <object> DAB options. Default: {}
- skipValidation <Object> Default: {}
- skipHook: <Object> Default: {}
  - beforeValidate <boolean> Default: false
  - afterValidate <boolean> Default: false
  - beforeCreate <boolean> Default: false
  - afterCreate <boolean> Default: false
  - all <boolean> Skip all hooks altogether. Default: false

model:update

Usage:

helper('model:update')(name, id, body, opts)

name <string> Required.
id <string | integer> Required.
body <Object> Required.
opts <Object> Default: {}
- dab <object> DAB options. Default: {}
- skipValidation <Object> Default: {}
- skipHook <Object> Default: {}
  - beforeValidate <boolean> Default: false
  - afterValidate <boolean> Default: false
  - beforeUpdate <boolean> Default: false
  - afterUpdate <boolean> Default: false
  - all <boolean> Skip all hooks altogether. Default: false

model:remove

Usage:

helper('model:remove')(name, id, opts)

name <string> Required.
id <string | integer> Required.
opts <Object> Default: {}
- dab <object> DAB options. Default: {}
- skipValidation <Object> Default: {}
- skipHook <Object> Default: {}
  - beforeValidate <boolean> Default: false
  - afterValidate <boolean> Default: false
  - beforeRemove <boolean> Default: false
  - afterRemove <boolean> Default: false
  - all <boolean> Skip all hooks altogether. Default: false

model:bulkCreate

Usage:

helper('model:bulkCreate')(name, body, opts)

name <string> Required.
body <Object> Required.
opts <Object> Default: {}
- dab <object> DAB options. Default: {}
- skipHook <Object> Default: {}
- - beforeBulkCreate <boolean> Default: false
  - afterBulkCreate <boolean> Default: false
  - all <boolean> Skip all hooks altogether. Default: false

model:bulkUpdate

Usage:

helper('model:bulkUpdate')(name, body, opts)

name <string> Required.
body <Object> Required.
opts <Object> Default: {}
- dab <object> DAB options. Default: {}
- skipHook <Object> Default: {}
- - beforeBulkUpdate <boolean> Default: false
  - afterBulkUpdate <boolean> Default: false
  - all <boolean> Skip all hooks altogether. Default: false

model:bulkRemove

Usage:

helper('model:bulkRemove')(name, body, opts)

name <string> Required.
body <Object> Required.
opts <Object> Default: {}
- dab <object> DAB options. Default: {}
- skipHook <Object> Default: {}
- - beforeBulkRemove <boolean> Default: false
  - afterBulkRemove <boolean> Default: false
  - all <boolean> Skip all hooks altogether. Default: false

model:copyFrom(name, src, opts)

Usage:

helper('model:copyFrom')(name, src, opts)

model:copyTo(name, dest, opts)

Usage:

helper('model:copyTo')(name, dest, opts)

model:validate(name, ...args)

model:get(name)

Object of the following convenient proxy helpers & instance or throws error if something isn't right:

dab: convenient helper of getDab
schema: convenient proxy of getSchema
hook: convenient proxy of getHook
find: convenient proxy of find
findOne: convenient proxy of findOne
create: convenient proxy of create
update: convenient proxy of update
remove: convenient proxy of remove
bulkCreate: convenient proxy of bulkCreate
bulkUpdate: convenient proxy of bulkUpdate
bulkRemove: convenient proxy of bulkRemove
copyFrom: convenient proxy of copyFrom
copyTo: convenient proxy of copyTo

...
const model = helper('model:get')('app:myModel')
model.create({ first_name: 'James', last_name: 'Blondy' })
.then(result => {
  return model.update(result.data.id, { last_name: 'Bond' })
})
.then(result => {
  return model.find()
})
.then(result => {
  console.log(result)
  /* result is object of something like this:
  { 
    success: true,
    total: 1,
    data: [{
      _id: '<auto_generated_id>',
      first_name: 'James',
      last_name: 'Bond'
    }]
  }
  */
})
.catch(err => {
  console.log(err.message)
})

CUK

Helper

model:find(name, opts)

model:findOne(name, id)

model:create

model:update

model:remove

model:bulkCreate

model:bulkUpdate

model:bulkRemove

model:copyFrom(name, src, opts)

model:copyTo(name, dest, opts)

model:validate(name, ...args)

model:get(name)

model:getConnector(name, follow)

model:getDab(name)

model:getHook(name, hook)

model:getSchema(name)