schema.md

Schema

Schema is optional mechanism to define field data type, filter/validation, or observable behaviors.

Schema defined as part of connection options for each data collection schema. You can see collection as table in DBMS world.

What schema define:

• Name of collection
• Fields
• Observers

How to use

const manager = new Manager({
  connections: [
    // this is one of connection option
    {
      adapter: //...
      schemas: [
        // this is collection schema
        {
          name: 'cute_collection',
          fields: [
            // field schemas
          ],
          observers: [
            // observers
          ],
        }
      ],
    }
  ]
});

Fields

Field schema are optional also. We need schema only if we want to enforce field to act as specific data type or implement filter/validation.

Every field extends from NField class.

const NField = require('node-norm/schemas/nfield');

Built-in field schema:

• NBoolean
• NDateTime
• NDouble
• NInteger
• NList
• NMap
• NReference
• NString

Filters

new NString('fieldName').filter(
  'required',
  ['default', '1'],
);

Built-in field filters:

• are
• default
• email
• enum
• exists
• notEmpty
• required
• requiredIf
• unique

Observers

Schema observer is an object which has methods,

• async #insert ({ query }, next)
• async #update ({ query }, next)