Dobo

Dobo Database Framework for Bajo.

See ecosystem for available adapters & tools

Constructor

new Dobo()

Source

Members

adapters :Array.<Object>

Type:
  • Array.<Object>
Source

connections :Array.<Object>

Type:
  • Array.<Object>
Source

features :Array.<Object>

Type:
  • Array.<Object>
Source

getAdapter

Get adapter by name. It returns the first adapter named after "{name}"

Also support NsPath format for those who load the same named adapter but from different provider/plugin.

Source

getAllPropertyKeys

Get all allowed property keys

Source

getConnection

Get connection by name. It returns the first connection named after "{name}"

Source

getFeature

Get feature by name. It returns the first adapter named after "{name}"

Also support NsPath format for those who load the same named adapter but from different provider/plugin.

Source

getModel

Get model by name

Source

getModelsByConnection

Get all models that bound to connection name

Source

getPropertyKeysByType

Get allowed property keys by field type

Source

models :Array.<Object>

Type:
  • Array.<Object>
Source

(static, constant) aggregateTypes :Array.<string>

Type:
  • Array.<string>
Default Value
  • ['count', 'avg', 'min', 'max', 'sum']
Source

(static, constant) histogramTypes :Array.<string>

Type:
  • Array.<string>
Default Value
  • ['daily', 'monthly', 'annually']
Source

(static, constant) idTypes :Array.<string>

Type:
  • Array.<string>
Default Value
  • ['string', 'integer', 'smallint']
Source

(static, constant) indexTypes :Array.<string>

Type:
  • Array.<string>
Default Value
  • ['index', 'unique', 'primary', 'fulltext']
Source

(static, constant) propertyType :TPropertyType

Type:
  • TPropertyType
Source

Methods

(async) init()

Initialize plugin and performing the following tasks:

  • Collecting all adapters
  • Collecting all connections
  • Collecting all features
  • Collecting all models
Source

(async) start(connsopt, noRebuildopt)

Start plugin

Parameters:
NameTypeAttributesDefaultDescription
connsstring | Array<optional>
all

Which connections should be run on start

noRebuildboolean<optional>
true

Set false to not rebuild model on start. Yes, only set it to false if you REALLY know what you're doing!!!

Source

(static) sanitizeDate(value, optionsopt) → {string|Date}

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

Parameters:
NameTypeAttributesDefaultDescription
valuenumber | string

Value to sanitize

optionsObject<optional>
{}

Options object

Properties
NameTypeAttributesDefaultDescription
silentboolean<optional>
true

If true (default) and value isn't valid, returns empty

inputFormatstring<optional>

If provided, parse value using this option

outputFormatstring<optional>

If not provided or native, returns Javascript Date. Otherwise returns formatted date/time string

Source
Returns:
Type: 
string | Date