!Moleculer logo

moleculer-db 

Moleculer service to store entities in database.

Features

- default CRUD actions
- cached actions
- pagination support
- pluggable adapter (NeDB is the default memory adapter for testing & prototyping)
- official adapters for MongoDB, PostgreSQL, SQLite, MySQL, MSSQL.
- fields filtering
- populating
- encode/decode IDs
- entity lifecycle events for notifications

Install

``bash
$ npm install moleculer-db --save
`

Usage

`js
"use strict";

const { ServiceBroker } = require("moleculer");
const DbService = require("moleculer-db");

const broker = new ServiceBroker();

// Create a DB service for user entities
broker.createService({
name: "users",
mixins: [DbService],

settings: {
fields: ["_id", "username", "name"]
},

afterConnected() {
// Seed the DB with ˙this.create
}
});

broker.start()

// Create a new user
.then(() => broker.call("users.create", {
username: "john",
name: "John Doe",
status: 1
}))

// Get all users
.then(() => broker.call("users.find").then(console.log));

// List users with pagination
.then(() => broker.call("users.list", { page: 2, pageSize: 10 }).then(console.log));

// Get a user
.then(() => broker.call("users.get", { id: 2 }).then(console.log));

// Update a user
.then(() => broker.call("users.update", { id: 2, name: "Jane Doe" }).then(console.log));

// Delete a user
.then(() => broker.call("users.remove", { id: 2 }).then(console.log));

``

Settings


| Property | Type | Default | Description |
|-------------------|----------------------|--------------|---------------------------------------------------------------------------------------------------------------------------|
| idField | String | required | Name of ID field. |
| fields | Array. | null | Field filtering list. It must be an Array. If the value is null or undefined doesn't filter the fields of entities. |
| excludeFields | Array. | null | Exclude fields from list. It must be an Array. |
| populates | Array | null | Schema for population. Read more. |
| pageSize | Number | required | Default page size in list action. |
| maxPageSize | Number | required | Maximum page size in list action. |
| maxLimit | Number | required | Maximum value of limit in find action. Default: -1 (no limit) |
| entityValidator | Object, function | null | Validator schema or a function to validate the incoming entity in create & 'insert' actions. |

>Note: idField does not work with Sequelize adapter as you can freely set your own ID while creating the model.

Actions




find !Cached action

Find entities by query.

$3


| Property | Type | Default | Description |
| -------- | ---- | ------- | ----------- |
| populate | String, Array. | required | Populated fields. |
| fields | String, Array. | required | Fields filter. |
| limit | Number | - | Max count of rows. |
| offset | Number | - | Count of skipped rows. |
| sort | String | - | Sorted fields. |
| search | String | - | Search text. |
| searchFields | String, Array. | required | Fields for searching. |
| query | Object | - | Query object. Passes to adapter. |

$3

Type: Array.