Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devsu/condor-mongoose
Utils to work with mongoose and condor GRPC framework
https://github.com/devsu/condor-mongoose
condor-framework crud crud-generator grpc grpc-framework mongodb mongoose nodejs
Last synced: about 1 month ago
JSON representation
Utils to work with mongoose and condor GRPC framework
- Host: GitHub
- URL: https://github.com/devsu/condor-mongoose
- Owner: devsu
- License: mit
- Created: 2017-02-02T23:24:48.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-06T16:30:54.000Z (over 7 years ago)
- Last Synced: 2024-10-08T23:33:22.031Z (about 1 month ago)
- Topics: condor-framework, crud, crud-generator, grpc, grpc-framework, mongodb, mongoose, nodejs
- Language: JavaScript
- Size: 73.2 KB
- Stars: 7
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# condor-mongoose
This module allows you to create CRUD services over GRPC in less than 5 minutes.
[](https://travis-ci.org/devsu/condor-mongoose)
[](https://coveralls.io/github/devsu/condor-mongoose?branch=master)
## How to use (Summary)
- Just define your protos, and your mongoose models.
- Setup your service using [condor-framework](https://github.com/devsu/condor-framework) and extending the `CrudBaseService` class.
- Voilá, you have a working CRUD service over gRPC, connected to mongo (using mongoose).
## Features
- Automatic CRUD generation (list, insert, update, get, delete)
- Supports subdocuments and related models
- Allows queries (where, fields, limit, skip, sort)
- Allows automatic population of related models (populate)
## Installation
```bash
npm i --save condor-framework mongoose condor-mongoose
```
## How to use
1. Define the proto file.
```proto
syntax = "proto3";
package bussiness;
message Where {
string field = 1;
string value = 2;
Matcher matcher = 3;
}
message Sort {
string field = 1;
int32 value = 2;
}
enum Matcher {
STRING = 0;
REGEX = 1;
OBJECT = 2;
}
message QueryRequest {
repeated Where where = 1; // empty => all
repeated string fields = 2; // empty => all
int32 limit = 3; // 0 => unlimited
int32 skip = 4; // 0 => none
repeated Sort sort = 5;
}
message PersonUpdate {
string id = 1;
repeated string fields = 2;
Person data = 3;
}
message Empty {}
message IdRequest {
string id = 1;
}
message Person {
string id = 1;
string name = 2;
int32 age = 3;
}
service PersonsService {
rpc List (QueryRequest) returns (Person) {}
rpc Insert (Person) returns (Person) {}
rpc Update (PersonUpdate) returns (Person) {}
rpc Get (IdRequest) returns (Person) {}
rpc Delete (IdRequest) returns (Empty) {}
}
```
2. Create a service that extends from **CrudBaseService**.
```js
const CrudBaseService = require('condor-mongoose');
const mongoose = require('mongoose');
const personSchema = {
'name': String,
'age': Number,
};
const Person = mongoose.model('Person', new mongoose.Schema(personSchema));
module.exports = class extends CrudBaseService {
constructor() {
super(Person);
}
};
```
**Note:** **CrudBaseService** contains **base** methods (insert, update, delete, get, list),
**sub documents** methods (push, addToSet, remove, update and replace) and **related models**
methods (push, addToSet, remove and replace).
3. Initialize the service.
```js
const mongoose = require('mongoose');
const Condor = require('condor-framework');
const Promise = require('bluebird');
const PersonService = require('./models/personService');
mongoose.Promise = Promise;
mongoose.connect('mongodb://localhost/business');
const protoPath = './bussiness.proto';
condor = new Condor()
.addService(protoPath, 'business.PersonService', new PersonService())
.start();
```
## License and Credits
MIT License. Copyright 2017 *Devsu LLC*, a great [node development team](https://devsu.com)