moleculerjs/moleculer-db

View on GitHub
README.md

Summary

Maintainability
Test Coverage
![Moleculer logo](https://moleculer.services/images/banner.png)

[![Build Status](https://travis-ci.org/moleculerjs/moleculer-db.svg?branch=master)](https://travis-ci.org/moleculerjs/moleculer-db)
[![Coverage Status](https://coveralls.io/repos/github/moleculerjs/moleculer-db/badge.svg?branch=master)](https://coveralls.io/github/moleculerjs/moleculer-db?branch=master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ea41176f5d764839969633e854b9905a)](https://www.codacy.com/app/mereg-norbert/moleculer-db?utm_source=github.com&utm_medium=referral&utm_content=moleculerjs/moleculer-db&utm_campaign=Badge_Grade)
[![Maintainability](https://api.codeclimate.com/v1/badges/0c7fa55afd189410eff3/maintainability)](https://codeclimate.com/github/moleculerjs/moleculer-db/maintainability)
[![Known Vulnerabilities](https://snyk.io/test/github/moleculerjs/moleculer-db/badge.svg)](https://snyk.io/test/github/moleculerjs/moleculer-db)
[![Join the chat at https://gitter.im/moleculerjs/moleculer](https://badges.gitter.im/moleculerjs/moleculer.svg)](https://gitter.im/moleculerjs/moleculer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

# Official DB addons for Moleculer framework

<!-- AUTO-GENERATED-CONTENT:START (RENDERLIST:folder=packages&title=Generals) -->
## Generals
| Name | Version | Description |
| ---- | ------- | ----------- |
| [moleculer-db](/packages/moleculer-db#readme) | [![NPM version](https://img.shields.io/npm/v/moleculer-db.svg)](https://www.npmjs.com/package/moleculer-db) | Moleculer service to store entities in database |
| [moleculer-db-adapter-couchdb-nano](/packages/moleculer-db-adapter-couchdb-nano#readme) | [![NPM version](https://img.shields.io/npm/v/moleculer-db-adapter-couchdb-nano.svg)](https://www.npmjs.com/package/moleculer-db-adapter-couchdb-nano) | CouchDB Nano adapter for Moleculer DB service. |
| [moleculer-db-adapter-mongo](/packages/moleculer-db-adapter-mongo#readme) | [![NPM version](https://img.shields.io/npm/v/moleculer-db-adapter-mongo.svg)](https://www.npmjs.com/package/moleculer-db-adapter-mongo) | MongoDB native adapter for Moleculer DB service. |
| [moleculer-db-adapter-mongoose](/packages/moleculer-db-adapter-mongoose#readme) | [![NPM version](https://img.shields.io/npm/v/moleculer-db-adapter-mongoose.svg)](https://www.npmjs.com/package/moleculer-db-adapter-mongoose) | Mongoose adapter for Moleculer DB service |
| [moleculer-db-adapter-sequelize](/packages/moleculer-db-adapter-sequelize#readme) | [![NPM version](https://img.shields.io/npm/v/moleculer-db-adapter-sequelize.svg)](https://www.npmjs.com/package/moleculer-db-adapter-sequelize) | SQL adapter (Postgres, MySQL, SQLite & MSSQL) for Moleculer DB service |
| [moleculer-db-adapter-prisma](/packages/moleculer-db-adapter-prisma#readme) | [![NPM version](https://img.shields.io/npm/v/moleculer-db-adapter-prisma.svg)](https://www.npmjs.com/package/moleculer-db-adapter-prisma) | Prisma adapter for Moleculer DB service |
<!-- AUTO-GENERATED-CONTENT:END -->

# Contribution

## Install dependencies
```bash
$ npm run setup
```

## Development
**Run the `simple` example in `moleculer-db` service with watching**
```bash
$ npm run dev moleculer-db
```

**Run the `full` example in `moleculer-db` service w/o watching**
```bash
$ npm run demo moleculer-db full
```

## Test
```bash
$ npm test
```

## Create a new addon
```bash
$ npm run init moleculer-<modulename>
```

## Publish new releases
```bash
$ npm run release
```

# License
The project is available under the [MIT license](https://tldrlegal.com/license/mit-license).

# Contact
Copyright (c) 2016-2022 MoleculerJS

[![@moleculerjs](https://img.shields.io/badge/github-moleculerjs-green.svg)](https://github.com/moleculerjs) [![@MoleculerJS](https://img.shields.io/badge/twitter-MoleculerJS-blue.svg)](https://twitter.com/MoleculerJS)