Package Health Score

69 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.8.26	\|	07/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.7.9	\|	04/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.6.3	\|	11/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.5.2	\|	08/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.4.5	\|	07/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (6,197)

GitHub Stars: 152
Forks: 122
Contributors: 50

Direct Usage Popularity

The npm package moleculer-db receives a total of 6,197 downloads a week. As such, we scored moleculer-db popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package moleculer-db, we found that it has been starred 152 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 50
Funding: No

With more than 10 contributors for the moleculer-db repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like moleculer-db is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 62
Open PR: 11
Last Release: 5 months ago
Last Commit: 3 months ago

Further analysis of the maintenance status of moleculer-db based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that moleculer-db demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 8.x.x

Age: 8 years
Dependencies: 4 Direct
Versions: 62
Install Size: 205 kB
Dist-tags: 2
# of Files: 26
Maintainers: 1
TS Typings: Yes

moleculer-db has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use moleculer-db?

To help you get started, we've collected the most common ways that moleculer-db is being used within popular public projects.

icebob / kantab / backend / mixins / database.js View on Github

schema.created = function() {
		this.adapter = adapter || new MemoryAdapter();

		this.adapter.init(this.broker, this);

		this.$fields = null;

		if (_.isObject(this.settings.fields)) {
			this.$fields = _.compact(_.map(this.settings.fields, (value, name) => {
				// Disabled field
				if (value === false)
					return;

				// Shorthand format { title: true } => { title: {} }
				if (value === true)
					value = {};

				// Shorthand format: { title: "string" } => { title: { type: "string" } }

View more ways to use moleculer-db

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

$ npm install moleculer-db --save

Usage

"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(() =&gt; broker.call("users.create", {
    username: "john",
    name: "John Doe",
    status: 1
}))

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

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

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

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

// Delete a user
.then(() =&gt; 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`

Find entities by query.

Parameters

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.

Results

Type: Array.

List of found entities.

`count`

Get count of entities by query.

Parameters

Property	Type	Default	Description
`search`	`String`	-	Search text.
`searchFields`	`String`, `Array.`	required	Fields list for searching.
`query`	`Object`	-	Query object. Passes to adapter.

Results

Type: Number

Count of found entities.

`list`

List entities by filters and pagination results.

Parameters

Property	Type	Default	Description
`populate`	`String`, `Array.`	required	Populated fields.
`fields`	`String`, `Array.`	required	Fields filter.
`page`	`Number`	-	Page number.
`pageSize`	`Number`	-	Size of a page.
`sort`	`String`	-	Sorted fields.
`search`	`String`	-	Search text.
`searchFields`	`String`, `Array.`	required	Fields for searching.
`query`	`Object`	-	Query object. Passes to adapter.

Results

Type: Object

List of found entities and count with pagination info.

`create`

Create a new entity.

Parameters

Property	Type	Default	Description
`params`	`Object`	required	Entity to save.

Results

Type: Object

Saved entity.

`insert`

Create many new entities.

Parameters

Property	Type	Default	Description
`entity`	`Object`	-	Entity to save.
`entities`	`Array.`	-	Entities to save.

Results

Type: Object, Array.

Saved entity(ies).

`get`

Get entity by ID.

Parameters

Property	Type	Default	Description
`id`	`any`, `Array.`	required	ID(s) of entity.
`populate`	`String`, `Array.`	required	Field list for populate.
`fields`	`String`, `Array.`	required	Fields filter.
`mapping`	`Boolean`	-	Convert the returned `Array` to `Object` where the key is the value of `id`.

Results

Type: Object, Array.

Found entity(ies).

`update`

Update an entity by ID. > After update, clear the cache & call lifecycle events.

Parameters

Property	Type	Default	Description
`id`	`any`	required	ID of entity.

Results

Type: Object

Updated entity.

`remove`

Remove an entity by ID.

Parameters

Property	Type	Default	Description
`id`	`any`	required	ID of entity.

Results

Type: Number

Count of removed entities.

Methods

`sanitizeParams`

Sanitize context parameters at find action.

Parameters

Property	Type	Default	Description
`ctx`	`Context`	required
`params`	`Object`	required

Results

Type: Object

`getById`

Get entity(ies) by ID(s).

Parameters

Property	Type	Default	Description
`id`	`any`, `Array.`	required	ID or IDs.
`decoding`	`Boolean`	-	Need to decode IDs.

Results

Type: Object, Array.

Found entity(ies).

`entityChanged`

Clear the cache & call entity lifecycle events

Parameters

Property	Type	Default
`type`	`String`	required
`json`	`Object`, `Array.`, `Number`	required
`ctx`	`Context`	required

Results

Type: Promise

`clearCache`

Clear cached entities

Parameters

Property	Type	Default	Description
No input parameters.

Results

Type: Promise

`transformDocuments`

Transform the fetched documents

Parameters

Property	Type	Default
`ctx`	`Context`	required
`params`	`Object`	required
`docs`	`Array`, `Object`	required

Results

Type: Array, Object

`validateEntity`

Validate an entity by validator.

Parameters

Property	Type	Default	Description
`entity`	`Object`	required

Results

Type: Promise

`encodeID`

Encode ID of entity.

Parameters

Property	Type	Default	Description
`id`	`any`	required

Results

Type: any

`decodeID`

Decode ID of entity.

Parameters

Property	Type	Default	Description
`id`	`any`	required

Results

Type: any

`_find`

Find entities by query.

Parameters

Property	Type	Default	Description
`ctx`	`Context`	required	Context instance.
`params`	`Object`	-	Parameters.

Results

Type: Array.

List of found entities.

`_count`

Get count of entities by query.

Parameters

Property	Type	Default	Description
`ctx`	`Context`	required	Context instance.
`params`	`Object`	-	Parameters.

Results

Type: Number

Count of found entities.

`_list`

List entities by filters and pagination results.

Parameters

Property	Type	Default	Description
`ctx`	`Context`	required	Context instance.
`params`	`Object`	-	Parameters.

Results

Type: Object

List of found entities and count.

`_create`

Create a new entity.

Parameters

Property	Type	Default	Description
`ctx`	`Context`	required	Context instance.
`params`	`Object`	-	Parameters.

Results

Type: Object

Saved entity.

`_insert`

Create many new entities.

Parameters

Property	Type	Default	Description
`ctx`	`Context`	required	Context instance.
`params`	`Object`	-	Parameters.

Results

Type: Object, Array.

Saved entity(ies).

`_get`

Get entity by ID.

Parameters

Property	Type	Default	Description
`ctx`	`Context`	required	Context instance.
`params`	`Object`	-	Parameters.

Results

Type: Object, Array.

Found entity(ies).

`_update`

Update an entity by ID. > After update, clear the cache & call lifecycle events.

Parameters

Property	Type	Default	Description
`ctx`	`Context`	required	Context instance.
`params`	`Object`	-	Parameters.

Results

Type: Object

Updated entity.

`_remove`

Remove an entity by ID.

Parameters

Property	Type	Default	Description
`ctx`	`Context`	required	Context instance.
`params`	`Object`	-	Parameters.

Populating

The service supports to populate fields from other services. E.g.: if you have an author field in post entity, you can populate it with users service by ID of author. If the field is an Array of IDs, it will populate all entities via only one request.

Example of populate schema

broker.createService({
    name: "posts",
    mixins: [DbService],
    settings: {
        populates: {
            // Shorthand populate rule. Resolve the `voters` values with `users.get` action.
            "voters": "users.get",

            // Define the params of action call. It will receive only with username &amp; full name of author.
            "author": {
                action: "users.get",
                params: {
                    fields: "username fullName"
                }
            },

            // Custom populator handler function
            "rate"(ids, docs, rule, ctx) {
                return Promise.resolve(...);
            }
        }
    }
});

// List posts with populated authors
broker.call("posts.find", { populate: ["author"]}).then(console.log);

> The populate parameter is available in find, list and get actions.

Lifecycle entity events

There are 3 lifecycle entity events which are called when entities are manipulated.

broker.createService({
    name: "posts",
    mixins: [DbService],
    settings: {},

    afterConnected() {
        this.logger.info("Connected successfully");
    },

    entityCreated(json, ctx) {
        this.logger.info("New entity created!");
    },

    entityUpdated(json, ctx) {
        // You can also access to Context
        this.logger.info(`Entity updated by '${ctx.meta.user.name}' user!`);
    },

    entityRemoved(json, ctx) {
        this.logger.info("Entity removed", json);
    },    
});

> Please note! If you manipulate multiple entities (updateMany, removeMany), the json parameter will be a Number instead of entities!

Extend with custom actions

Naturally you can extend this service with your custom actions.

const DbService = require("moleculer-db");

module.exports = {
    name: "posts",
    mixins: [DbService],

    settings: {
        fields: ["_id", "title", "content", "votes"]
    },

    actions: {
        // Increment `votes` field by post ID
        vote(ctx) {
            return this.adapter.updateById(ctx.params.id, { $inc: { votes: 1 } });
        },

        // List posts of an author
        byAuthors(ctx) {
            return this.find({
                query: {
                    author: ctx.params.authorID
                },
                limit: ctx.params.limit || 10,
                sort: "-createdAt"
            });
        }
    }
}

Remove default actions

According to moleculer documentation you can disable an action when override it with false

const DbService = require("moleculer-db");

module.exports = {
    name: "posts",
    mixins: [DbService],

    actions: {
        // Disable find default action
        find: false
    }
}

Test

$ npm test

In development with watching

$ npm run ci

License

The project is available under the MIT license.

Contact

moleculer-db dependencies

@seald-io/nedb bluebird flat lodash

moleculer-db development dependencies

coveralls eslint fakerator jest jest-cli kleur lolex moleculer moleculer-docgen nodemon

FAQs

What is moleculer-db?

Moleculer service to store entities in database. Visit Snyk Advisor to see a full health score report for moleculer-db, including popularity, security, maintenance & community analysis.

Is moleculer-db popular?

The npm package moleculer-db receives a total of 6,197 weekly downloads. As such, moleculer-db popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is moleculer-db well maintained?

We found indications that moleculer-db maintenance is sustainable demonstrating some project activity. We saw a total of 50 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is moleculer-db safe to use?

The npm package moleculer-db was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 11:21 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP