Dobo

Initialize plugin and performing the following tasks:

• Collecting all drivers
• Collecting all connections
• Collecting all features
• Collecting all schemas

Create a new model:

• read corresponding schema
• attempt to create table/database/collection accordingly

Drop database model

Check if model exists already

Pick only fields defined from a record

Prepare records pagination:

• making sure records limit is obeyed
• making sure page is a positive value
• if skip is given, recalculate limit to use skip instead of page number
• Build sort info

Return the number of records found by given filter

Create a new record

Example:

const { recordCreate } = this.app.dobo
const { body } = {
  id: 'ID',
  name: 'Indonesia',
  iso3: 'IDN'
}
const result = await recordCreate('CdbCountry', body)

Find records by model's name and given filter

Example: find records from model CdbCountry where its id is 'ID' or 'MY', sorted by name in ascending order and return only its id, name and iso3

const { recordFind } = this.app.dobo
const query = { id: { $in: ['ID', 'MY'] } }
const sort = { name: 1 }
const fields = ['id', 'name', 'iso3']
const result = await recordFind('CdbCountry', { query, sort }, { fields })

Find all records by model's name and given filter.

The total number of records returned is limited by hardLimit value set in config file.

Find the first record by model's name and given filter.

Get record by model's name and record ID

Example:

const { recordGet } = this.app.dobo
const fields = ['id', 'name', 'iso3']
const result = await recordGet('CdbCountry', 'ID', { fields })

Remove existing record by it's ID. All attachments bound to this record will also be removed forever.

Example:

const { recordRemove } = this.app.dobo
const result = await recordRemove('CdbCountry', 'ID')

Update a record by it's ID and body payload

Example:

const { recordUpdate } = this.app.dobo
const { body } = {
  name: 'Republic of Indonesia',
  phoneCode: '+62'
}
const result = await recordUpdate('CdbCountry', 'ID', body)

Update a record by payload's ID. If no record is found by given ID, a new one will be created instead.

Missing ID in payload always results a new record creation.

Start plugin

Sanitize payload body against schema

Sanitize value as a date/time value. Parse/format string using dayjs format

Sanitize id according it's schema

Validate value against JOI schema