Skip to content
Utils to work with mongoose and condor GRPC framework
JavaScript Protocol Buffer
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib fix test, to work with condor 1.5.1 Jun 6, 2017
spec Remove TestUtils May 16, 2017
.editorconfig scaffold Feb 3, 2017
.eslintignore scaffold Feb 3, 2017
.eslintrc.json Feature #10877 (#7) Apr 17, 2017
.gitignore scaffold Feb 3, 2017
.istanbul.yml scaffold Feb 3, 2017
.travis.yml add travis and coveralls configuration Apr 27, 2017
LICENSE Initial commit Feb 2, 2017
README.md improve documentation Apr 27, 2017
index.js Remove TestUtils May 16, 2017
index.spec.js Remove TestUtils May 16, 2017
package.json fix test, to work with condor 1.5.1 Jun 6, 2017

README.md

condor-mongoose

This module allows you to create CRUD services over GRPC in less than 5 minutes.

Build Status Coverage Status

How to use (Summary)

  • Just define your protos, and your mongoose models.
  • Setup your service using 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

npm i --save condor-framework mongoose condor-mongoose

How to use

  1. Define the proto file.
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) {}
}
  1. Create a service that extends from CrudBaseService.
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).

  1. Initialize the service.
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

You can’t perform that action at this time.