{"list":[{"title":"Dobo","link":"Dobo"},{"title":"Dobo#connections","link":"connections"},{"title":"Dobo#drivers","link":"drivers"},{"title":"Dobo#features","link":"features"},{"title":"Dobo#init","link":"init","description":"

Initialize plugin and performing the following tasks:

\n"},{"title":"Dobo#modelCreate","link":"modelCreate","description":"

Create a new model:

\n"},{"title":"Dobo#modelDrop","link":"modelDrop","description":"

Drop database model

"},{"title":"Dobo#modelExists","link":"modelExists","description":"

Check if model exists already

"},{"title":"Dobo#pickRecord","link":"pickRecord","description":"

Pick only fields defined from a record

"},{"title":"Dobo#prepPagination","link":"prepPagination","description":"

Prepare records pagination:

\n"},{"title":"Dobo#recordCount","link":"recordCount","description":"

Return the number of records found by given filter

"},{"title":"Dobo#recordCreate","link":"recordCreate","description":"

Create a new record

\n

Example:

\n
const { recordCreate } = this.app.dobo\nconst { body } = {\n  id: 'ID',\n  name: 'Indonesia',\n  iso3: 'IDN'\n}\nconst result = await recordCreate('CdbCountry', body)\n
"},{"title":"Dobo#recordFind","link":"recordFind","description":"

Find records by model's name and given filter

\n

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

\n
const { recordFind } = this.app.dobo\nconst query = { id: { $in: ['ID', 'MY'] } }\nconst sort = { name: 1 }\nconst fields = ['id', 'name', 'iso3']\nconst result = await recordFind('CdbCountry', { query, sort }, { fields })\n
"},{"title":"Dobo#recordFindAll","link":"recordFindAll","description":"

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

\n

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

"},{"title":"Dobo#recordFindOne","link":"recordFindOne","description":"

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

"},{"title":"Dobo#recordGet","link":"recordGet","description":"

Get record by model's name and record ID

\n

Example:

\n
const { recordGet } = this.app.dobo\nconst fields = ['id', 'name', 'iso3']\nconst result = await recordGet('CdbCountry', 'ID', { fields })\n
"},{"title":"Dobo#recordRemove","link":"recordRemove","description":"

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

\n

Example:

\n
const { recordRemove } = this.app.dobo\nconst result = await recordRemove('CdbCountry', 'ID')\n
"},{"title":"Dobo#recordUpdate","link":"recordUpdate","description":"

Update a record by it's ID and body payload

\n

Example:

\n
const { recordUpdate } = this.app.dobo\nconst { body } = {\n  name: 'Republic of Indonesia',\n  phoneCode: '+62'\n}\nconst result = await recordUpdate('CdbCountry', 'ID', body)\n
"},{"title":"Dobo#recordUpsert","link":"recordUpsert","description":"

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

\n

Missing ID in payload always results a new record creation.

\n
"},{"title":"Dobo#schemas","link":"schemas"},{"title":"Dobo#start","link":"start","description":"

Start plugin

"},{"title":"Dobo.aggregateTypes","link":"aggregateTypes"},{"title":"Dobo.alias","link":"alias"},{"title":"Dobo.propType","link":"propType"},{"title":"Dobo.sanitizeBody","link":"sanitizeBody","description":"

Sanitize payload body against schema

"},{"title":"Dobo.sanitizeDate","link":"sanitizeDate","description":"

Sanitize value as a date/time value. Parse/format string using {@link https://day.js.org/docs/en/display/format|dayjs format}

"},{"title":"Dobo.sanitizeId","link":"sanitizeId","description":"

Sanitize id according it's schema

"},{"title":"Dobo.validate","link":"validate","description":"

Validate value against JOI schema

"},{"title":"TPropType","link":"TPropType"},{"title":"TRecordCountOptions","link":"TRecordCountOptions"},{"title":"TRecordCreateOptions","link":"TRecordCreateOptions"},{"title":"TRecordFilter","link":"TRecordFilter"},{"title":"TRecordFindOptions","link":"TRecordFindOptions"},{"title":"TRecordFindResult","link":"TRecordFindResult"},{"title":"TRecordGetOptions","link":"TRecordGetOptions"},{"title":"TRecordGetResult","link":"TRecordGetResult"},{"title":"TRecordPagination","link":"TRecordPagination"},{"title":"TRecordRemoveOptions","link":"TRecordRemoveOptions"},{"title":"TRecordSort","link":"TRecordSort","description":"

Key value pairs used as sort information:

\n\n

Example: to sort by firstName (ascending) and lastName (descending)

\n
const sort = {\n  firstName: 1,\n  lastName: -1\n}\n
"},{"title":"TRecordSortKey","link":"TRecordSortKey"},{"title":"TRecordUpdateOptions","link":"TRecordUpdateOptions"},{"title":"TValidator","link":"TValidator"},{"title":"TValidatorBoolean","link":"TValidatorBoolean"},{"title":"TValidatorDate","link":"TValidatorDate"},{"title":"TValidatorNumber","link":"TValidatorNumber"},{"title":"TValidatorString","link":"TValidatorString"},{"title":"TValidatorTimestamp","link":"TValidatorTimestamp"},{"title":"factory","link":"factory","description":"

Plugin factory

"},{"title":"module:Lib","link":"Lib"},{"title":"module:Lib.collectConnections","link":"collectConnections","description":"

Collect all database connections from {@tutorial config}.

"},{"title":"module:Lib.collectDrivers","link":"collectDrivers","description":"

Collect all database drivers from loaded plugins

"},{"title":"module:Lib.collectFeatures","link":"collectFeatures","description":"

Collect all database features from all loaded plugins

"},{"title":"module:Lib.collectSchemas","link":"collectSchemas","description":"

Collect all database schemas from loaded plugins

"}]}