Define a model class

Register a property for the model class

Define single property named propertyName on model

Extend existing model with bunch of properties

Get the schema name

Resolve the type string to be a function, for example, 'String' to String

Build models from schema definitions

schemas can be one of the following:

1. An array of named schema definition JSON objects
2. A schema definition JSON object
3. A list of property definitions (anonymous)

Introspect the json document to build a corresponding model

Export public API

Schema types

Determine the spherical distance between two geo points.

Determine the spherical distance to the given point.

Simple serialization.

Export the GeoPoint class.

Model class - base class for all persist objects provides common API to access any database connector. This class describes only abstract behavior layer, refer to lib/connectors/*.js to learn more about specific connector implementations

ModelBaseClass mixes Validatable and Hookable classes methods

Return string representation of class

Convert instance to Object

Checks is property changed based on current property and initial value

Reset dirty attributes

this method does not perform any database operation it just reset object to it's initial state

Module exports class Model

DataSource - connector-specific classes factory.

All classes in single dataSource shares same connector type and one database connection

Define a model class

Mixin DataAccessObject methods.

Attach an existing model to a data source.

Define single property named prop on model

Drop each model table and re-create. This method make sense only for sql connectors.

Update existing database tables. This method make sense only for sql connectors.

Discover existing database tables. This method returns an array of model objects, including {type, name, onwer}

options

 all: true - Discovering all models, false - Discovering the models owned by the current user
 views: true - Including views, false - only tables
 limit: The page size
 offset: The starting index

The synchronous version of discoverModelDefinitions

Discover properties for a given model.

property description

 owner {String} The database owner or schema
 tableName {String} The table/view name
 columnName {String} The column name
 dataType {String} The data type
 dataLength {Number} The data length
 dataPrecision {Number} The numeric data precision
 dataScale {Number} The numeric data scale
 nullable {Boolean} If the data can be null

options

 owner/schema The database owner/schema

The synchronous version of discoverModelProperties

Discover primary keys for a given owner/modelName

Each primary key column description has the following columns:

 owner {String} => table schema (may be null)
 tableName {String} => table name
 columnName {String} => column name
 keySeq {Number} => sequence number within primary key( a value of 1 represents the first column of the primary key, a value of 2 would represent the second column within the primary key).
 pkName {String} => primary key name (may be null)

 The owner, default to current user

options

 owner/schema The database owner/schema

The synchronous version of discoverPrimaryKeys

Discover foreign keys for a given owner/modelName

foreign key description

 fkOwner String => foreign key table schema (may be null)
 fkName String => foreign key name (may be null)
 fkTableName String => foreign key table name
 fkColumnName String => foreign key column name
 keySeq Number => sequence number within a foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
 pkOwner String => primary key table schema being imported (may be null)
 pkName String => primary key name (may be null)
 pkTableName String => primary key table name being imported
 pkColumnName String => primary key column name being imported

options

 owner/schema The database owner/schema

The synchronous version of discoverForeignKeys

Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table). They are ordered by fkTableOwner, fkTableName, and keySeq.

foreign key description

 fkOwner {String} => foreign key table schema (may be null)
 fkName {String} => foreign key name (may be null)
 fkTableName {String} => foreign key table name
 fkColumnName {String} => foreign key column name
 keySeq {Number} => sequence number within a foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
 pkOwner {String} => primary key table schema being imported (may be null)
 pkName {String} => primary key name (may be null)
 pkTableName {String} => primary key table name being imported
 pkColumnName {String} => primary key column name being imported

options

 owner/schema The database owner/schema

The synchronous version of discoverExportedForeignKeys

Discover one schema from the given model without following the relations

Discover schema from a given modelName/view

options

 {String} owner/schema - The database owner/schema name
 {Boolean} relations - If relations (primary key/foreign key) are navigated
 {Boolean} all - If all owners are included
 {Boolean} views - If views are included

Discover schema from a given table/view synchronously

options

 {String} owner/schema - The database owner/schema name
 {Boolean} relations - If relations (primary key/foreign key) are navigated
 {Boolean} all - If all owners are included
 {Boolean} views - If views are included

Discover and build models from the given owner/modelName

options

 {String} owner/schema - The database owner/schema name
 {Boolean} relations - If relations (primary key/foreign key) are navigated
 {Boolean} all - If all owners are included
 {Boolean} views - If views are included

Discover and build models from the given owner/modelName synchronously

options

 {String} owner/schema - The database owner/schema name
 {Boolean} relations - If relations (primary key/foreign key) are navigated
 {Boolean} all - If all owners are included
 {Boolean} views - If views are included

Check whether migrations needed This method make sense only for sql connectors.

Freeze dataSource. Behavior depends on connector

Return table name for specified modelName

Return column name for specified modelName and propertyName

Return column metadata for specified modelName and propertyName

Return column names for specified modelName

Find the ID column name

Find the ID property name

Find the ID property names sorted by the index

Define foreign key to another model

Close database connection

Enable a data source operation to be remote.

Disable a data source operation to be remote.

Get an operation's metadata.

Get all operations.

Define an operation to the data source

Check if the backend is a relational DB

Check if the data source is ready

Define a hidden property

Define readonly property on object

Export public API

DAO class - base class for all persist objects provides common API to access any database connector. This class describes only abstract behavior layer, refer to lib/connectors/*.js to learn more about specific connector implementations

DataAccessObject mixes Inclusion classes methods

Create new instance of Model class, saved in database

Update or insert a model instance

Find one record, same as all, limited by 1 and return object, not collection, if not found, create using data provided as second argument

Check whether a model instance exists in database

Find object by id

Find all instances of Model, matched by query make sure you have marked as index: true fields for filter or sort

Find one record, same as all, limited by 1 and return object, not collection

Destroy all matching records

Destroy a record by id

Return count of matched records

Save instance. When instance haven't id, create method called instead. Triggers: validate, save, update | create

Update single attribute

equals to `updateAttributes({name: value}, cb)

Update set of attributes

this method performs validation before updating

Reload object from persistence

Define readonly property on object

Define scope

Module exports class Model

Delete object from persistence

Hooks mixins

Module exports

List of hooks available

Allows you to load relations of several objects and optimize numbers of requests.

Include mixin for ./model.js

Declare hasMany relation

Declare belongsTo relation

Many-to-many relation

Post.hasAndBelongsToMany('tags'); creates connection model 'PostTag'

Presence validator

Length validator

Numericality validator

Inclusion validator

Exclusion validator

Format validator

Custom validator

Uniqueness validator

This method performs validation, triggers validation hooks. Before validation obj.errors collection cleaned. Each validation can add errors to obj.errors collection. If collection is not blank, validation failed.

Return true when v is undefined, blank array, null or empty string otherwise returns false

Module exports

Validation mixins for model.js

Basically validation configurators is just class methods, which adds validations configs to AbstractClass._validations. Each of this validations run when obj.isValid() method called.

Each configurator can accept n params (n-1 field names and one config). Config is {Object} depends on specific validation, but all of them has one common part: message member. It can be just string, when only one situation possible, e.g. Post.validatesPresenceOf('title', { message: 'can not be blank' });

In more complicated cases it can be {Hash} of messages (for each case): User.validatesLengthOf('password', { min: 6, max: 20, message: {min: 'too short', max: 'too long'}});

Validate presence. This validation fails when validated field is blank.

Default error message "can't be blank"

Validate length. Three kinds of validations: min, max, is.

Default error messages:

• min: too short
• max: too long
• is: length is wrong

Validate numericality.

Validate inclusion in set

Validate exclusion

Validate format

Default error message: is invalid

Validate using custom validator

Default error message: is invalid

Example:

User.validate('name', customValidator, {message: 'Bad name'});
function customValidator(err) {
    if (this.name === 'bad') err();
});
var user = new User({name: 'Peter'});
user.isValid(); // true
user.name = 'bad';
user.isValid(); // false

Validate using custom async validator

Default error message: is invalid

Example:

User.validateAsync('name', customValidator, {message: 'Bad name'});
function customValidator(err, done) {
    process.nextTick(function () {
        if (this.name === 'bad') err();
        done();
    });
});
var user = new User({name: 'Peter'});
user.isValid(); // false (because async validation setup)
user.isValid(function (isValid) {
    isValid; // true
})
user.name = 'bad';
user.isValid(); // false
user.isValid(function (isValid) {
    isValid; // false
})

Validate uniqueness

Default error message: is not unique