https://github.com/devisjs/devis-mongo-client

a mongoDB plugin for Devis
https://github.com/devisjs/devis-mongo-client

Last synced: 6 months ago
JSON representation

a mongoDB plugin for Devis

• Host: GitHub
• URL: https://github.com/devisjs/devis-mongo-client
• Owner: Devisjs
• License: mit
• Created: 2017-11-09T12:33:04.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T17:07:15.000Z (over 3 years ago)
• Last Synced: 2025-08-14T09:57:50.157Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Devis mongo client

 

>A data storage plugin for Devisjs

This module supports the majority of necessary features for using your MongoDB database.

## Install

We should install Devis and the plugin :

```bash

$ npm install --save devis

$ npm install --save devis-mongo-client

```

## Supported functions 

* Connect to the database :

    * Syntax :

    ```javascript

    .call({role:"mongodb", action:"connect"},{url:mongodb_url},callback);

    ```

    * Example :

     ```javascript

    .call({

		role: "mongodb",

		action: "connect"

        }, { url: "mongodb://localhost:27017/foo" },callback);

    ``` 

    

* Create a collection : 

    * Syntax :

    ```javascript

    .call({role:"mongodb", action:"createCollection"},{collection:collection},callback);

    ```

* Drop a collection : 

    * Syntax :

    ```javascript

    .call({role:"mongodb", action:"dropCollection"},{collection:collection},callback);

    ``` 

    

* Find data :

    * Syntax :

    ```javascript

    .call({role:"mongodb", action:"find"},{collection:collection, type:type, query: query, options: options},callback);

    ```

    *type* : one or many (default : many);

   

    * Examples :  

        * Example 1 : 

        ```javascript

        //close is true by default, but if you don't wanan close the connection you should give false as argument 

        .call({role:"mongodb",action:"find"},{collection:"foo", type : "one", params:{"Acronym" : "L"},close:false},callback);

        ``` 

        * Example 2 : 

        ```javascript

        call({ role: "mongodb", action: "find" }, { type: "many", collection: "foo",query:{Name:"3"}, options: { fields: { "Acronym": 0, _id: 0 } } },callback);

        ```

* Indexes :

    * Create Index : 

        * Syntax :

        ```javascript

        .call({role:"mongodb", action:"index"},{collection:collection, type:type, indexFields: indexFields, params: params},callback);

        ```

        *type* : ensureIndex or createIndex.

    * check index if exist : 

        * Syntax :

        ```javascript

        .call({role:"mongodb", action:"index"},{collection:collection, type:"ifExist", index: index},callback);

        ```

    * get indexes of a given collection : 

        * Syntax : 

        ```javascript

        .call({role:"mongodb", action:"index"},{collection:collection, type:"getAllIndexes"},callback);

        ```

    * Example :

    ```javascript

    .call({role:"mongodb",action:"index"},{collection:"foo", type:"ifExist",index:["_id_","Acronym_1"],callback);

    ```

* Insert data :

    * Syntax :

    ```javascript

    .call({role:"mongodb", action:"insert"},{collection:collection, type:type, data: data, params: params},callback);

    ```

    *type* : one or many.

    * Example :

    ```javascript

    let data = [

        {Value: "1",Name: "foo", Acronym:"foo1"}, 

        {Value: "2",Name: "bar", Acronym:"bar1"}];

    .call({ role: "mongodb", action: "insert" },{ type: "many",collection: "foo", data: data },callback);

    ```

* Delete data :

    * Syntax :

    ```javascript

    .call({role:"mongodb", action:"delete"},{collection:collection, type:type, query: query},callback);

    ```

    *type* : one or many.

    * Example :

    ```javascript

    .call({role:"mongodb",action:"delete"},{type:"deleteOne", collection:"foo",params:{Value: "1"}},,callback);

    ```

* Update data :

    * Syntax :

    ```javascript

    .call({role:"mongodb", action:"update"},{collection:collection, type:type, query: query, data: data},callback);

    ```

    *type* : one or many.

    * Example :

    ```javascript

    let queryOr={

	    $or:[{Value: "1"},{Value:"2"}]};

    let newData={$set: { Name: "foobar"}};

    .call({role:"mongodb", action:"update"},{ type: "many", collection: "foo",query:queryOr, data:newData},callback);

    ```

* Aggregate functions :

    * Syntax :

    ```javascript

    .call({role:"mongodb", action:"aggregate"},{collection:collection, aggQuery: aggQuery},callback);

    ```

    * Example : 

    ```javascript

    let aggQuery = [

            { "$match": { "date": "29.05.2017"} },

            {

                "$group": {

                    "_id": { "Key": "$Key", "date": "$date"},

                    "count": { "$sum": 1 }

            }

        }];

    .call({ role: "mongodb", action: "aggregate" }, { collection: "Production",aggQuery:aggQuery },callback);

    ```

## Example : 

```javascript

//Initialize a Devis instance

let devisMongoClient = require("devis")

//use the devis-mongo-client plugin

        .plug("devis-mongo-client")

let promise = new Promise((resolve, reject) => {

        //connect to the database

    devis.call({

        role: "mongodb",

        action: "connect"

    }, {

        url: "mongodb://localhost:27017/prisma"

    }, (err, db) => {

        if (err) reject(err);

        else {

            resolve("success");

        }

    });

});

promise.then((res) => {

	//call find function of the plugin by giving the collection and search conditions 

	devisMongoClient.call({

		role: "mongodb",

		action: "find"

	    }, {

		collection: "foo",

		params: {

		    "Acronym": "L"

		}

	    }, (err, result) => {

		if (err) {

		    console.log(err);

		} else {

		    console.log(result);

		}

	}

});

```