mirror of
https://github.com/node-red/node-red-nodes.git
synced 2023-10-10 13:36:58 +02:00
use mongodb 3.6.1 client, add clustering support (#685)
This commit is contained in:
Ross Cruickshank
GitHub
parent
7e8571af42
commit
4becf68848
@ -1,11 +1,24 @@
|
||||
|
||||
|
||||
<script type="text/x-red" data-template-name="mongodb">
|
||||
<div class="form-row">
|
||||
<label for="node-config-input-hostname"><i class="fa fa-bookmark"></i> <span data-i18n="mongodb.label.host"></span></label>
|
||||
<input class="input-append-left" type="text" id="node-config-input-hostname" placeholder="localhost" style="width: 40%;" >
|
||||
<label for="node-config-input-port" style="margin-left: 10px; width: 35px; "> <span data-i18n="mongodb.label.port"></span></label>
|
||||
<input type="text" id="node-config-input-port" style="width:45px">
|
||||
<label for="node-config-input-hostname"><i class="fa fa-bookmark"></i><span data-i18n="mongodb.label.host"></span></label>
|
||||
<input class="input-append-left" type="text" id="node-config-input-hostname" placeholder="localhost">
|
||||
</div>
|
||||
|
||||
<div class="form-row node-config-input-clustered">
|
||||
<label for="node-config-input-clustered"><i class="fa fa-sitemap"></i><span data-i18n="mongodb.label.clustered"></span></label>
|
||||
<input type="checkbox" id="node-config-input-clustered" style="width:20px;">
|
||||
</div>
|
||||
<div class="form-row node-config-input-port">
|
||||
<label for="node-config-input-port"><i class="fa fa-plug"></i><span data-i18n="mongodb.label.port"></span></label>
|
||||
<input type="text" id="node-config-input-port" style="width:55px;">
|
||||
</div>
|
||||
<div class="form-row node-config-clusterVersion">
|
||||
<label> </label>
|
||||
<span data-i18n="mongodb.label.clusteredVersion"></span>
|
||||
</div>
|
||||
|
||||
<div class="form-row">
|
||||
<label for="node-config-input-db"><i class="fa fa-database"></i> <span data-i18n="mongodb.label.database"></span></label>
|
||||
<input type="text" id="node-config-input-db">
|
||||
@ -30,6 +43,7 @@
|
||||
color: "rgb(218, 196, 180)",
|
||||
defaults: {
|
||||
hostname: {value: "127.0.0.1", required: true},
|
||||
clustered: {value: true, required: true},
|
||||
port: {value: 27017, required: true},
|
||||
db: {value: "", required: true},
|
||||
name: {value: ""}
|
||||
@ -39,8 +53,19 @@
|
||||
password: {type: "password"}
|
||||
},
|
||||
label: function() {
|
||||
return this.name || this.hostname + ":" + this.port + "/" + this.db;
|
||||
}
|
||||
return this.name || this.db + "@" + this.hostname;
|
||||
},
|
||||
oneditprepare: function() {
|
||||
$("#node-config-input-clustered").on("change",function () {
|
||||
if ( $("#node-config-input-clustered").is(":checked") ) {
|
||||
$(".node-config-input-port").hide();
|
||||
$(".node-config-clusterVersion").show();
|
||||
} else {
|
||||
$(".node-config-input-port").show();
|
||||
$(".node-config-clusterVersion").hide();
|
||||
}
|
||||
})
|
||||
},
|
||||
});
|
||||
</script>
|
||||
|
||||
@ -90,20 +115,20 @@
|
||||
<p>Save will update an existing object or insert a new object if one does not already exist.</p>
|
||||
<p>Insert will insert a new object.</p>
|
||||
<p>Save and insert either store <code>msg</code> or <code>msg.payload</code>.</p>
|
||||
<p>Update will modify an existing object or objects. The query to select objects to update uses <code>msg.query</code>,
|
||||
<p>Update will modify an existing object or objects. The query to select objects to update uses <code>msg.query</code>
|
||||
and the update to the element uses <code>msg.payload</code>. If <code>msg.query._id</code> is
|
||||
a valid mongo ObjectId string it will be converted to an ObjectId type.</p>
|
||||
<p>Update can add an object if it does not exist or update multiple objects.</p>
|
||||
<p>Update can add a object if it does not exist or update multiple objects.</p>
|
||||
<p>Remove will remove objects that match the query passed in on <code>msg.payload</code>. A blank query will delete
|
||||
<i>all of the objects</i> in the collection.</p>
|
||||
<p>You can either set the collection method in the node config or on <code>msg.collection</code>. Setting it in the
|
||||
node will override <code>msg.collection</code>.</p>
|
||||
<p>By default, MongoDB creates an <i>_id</i> property as the primary key, so repeated injections of the
|
||||
<p>By default MongoDB creates an <i>_id</i> property as the primary key - so repeated injections of the
|
||||
same <code>msg</code> will result in many database entries.</p>
|
||||
<p>If this is NOT the desired behaviour, i.e., you want repeated entries to overwrite, then you must set
|
||||
<p>If this is NOT the desired behaviour - ie. you want repeated entries to overwrite, then you must set
|
||||
the <code>msg._id</code> property to be a constant by the use of a previous function node.</p>
|
||||
<p>This could be a unique constant or you could create one based on some other msg property.</p>
|
||||
<p>Currently we do not limit or cap the collection size, however this may well change.</p>
|
||||
<p>Currently we do not limit or cap the collection size at all... this may well change.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
@ -150,7 +175,7 @@
|
||||
align: "right",
|
||||
label: function() {
|
||||
var mongoNode = RED.nodes.node(this.mongodb);
|
||||
return this.name || (mongoNode ? mongoNode.label() + " " + this.collection: "mongodb");
|
||||
return this.name || (mongoNode ? mongoNode.label() + " " + this.collection : "mongodb");
|
||||
},
|
||||
labelStyle: function() {
|
||||
return this.name ? "node_label_italic" : "";
|
||||
@ -187,9 +212,9 @@
|
||||
<script type="text/x-red" data-help-name="mongodb in">
|
||||
<p>Calls a MongoDB collection method based on the selected operator.</p>
|
||||
<p>Find queries a collection using the <code>msg.payload</code> as the query statement as per the .find() function.
|
||||
Optionally, you may also set a <code>msg.projection</code> object (via a function) to constrain the returned
|
||||
fields. You can also set a <code>msg.sort</code> object, a <code>msg.limit</code> number and a <code>msg.skip</code> number.</p>
|
||||
<p>Count returns a count of the number of documents in a collection, or matches a query using the
|
||||
Optionally, you may also (via a function) set a <code>msg.projection</code> object to constrain the returned
|
||||
fields, a <code>msg.sort</code> object, a <code>msg.limit</code> number and a <code>msg.skip</code> number.</p>
|
||||
<p>Count returns a count of the number of documents in a collection or matching a query using the
|
||||
<code>msg.payload</code> as the query statement.</p>
|
||||
<p>Aggregate provides access to the aggregation pipeline using the <code>msg.payload</code> as the pipeline array.</p>
|
||||
<p>You can either set the collection method in the node config or on <code>msg.collection</code>. Setting it in
|
||||
@ -215,7 +240,7 @@
|
||||
icon: "mongodb.png",
|
||||
label: function() {
|
||||
var mongoNode = RED.nodes.node(this.mongodb);
|
||||
return this.name || (mongoNode ? mongoNode.label() + " " + this.collection: "mongodb");
|
||||
return this.name || (mongoNode ? mongoNode.label() + " " + this.collection : "mongodb");
|
||||
},
|
||||
labelStyle: function() {
|
||||
return this.name ? "node_label_italic" : "";
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
|
||||
|
||||
module.exports = function(RED) {
|
||||
"use strict";
|
||||
var mongo = require('mongodb');
|
||||
@ -11,13 +12,37 @@ module.exports = function(RED) {
|
||||
this.port = n.port;
|
||||
this.db = n.db;
|
||||
this.name = n.name;
|
||||
this.clustered = n.clustered;
|
||||
|
||||
var url = "mongodb://";
|
||||
if (this.credentials && this.credentials.user && this.credentials.password) {
|
||||
url += this.credentials.user+":"+this.credentials.password+"@";
|
||||
// if(n.user && n.password){
|
||||
// this.credentials.user = n.user;
|
||||
// this.credentials.password= n.password;
|
||||
// }
|
||||
|
||||
//console.log(this);
|
||||
//console.log("\n\n\n\n\n",n);
|
||||
|
||||
var url = "mongodb+srv://";
|
||||
if (!this.clustered) {
|
||||
url = "mongodb://";
|
||||
}
|
||||
if (this.credentials && this.credentials.user && this.credentials.password) {
|
||||
this.user = this.credentials.user;
|
||||
this.password = this.credentials.password;
|
||||
} else {
|
||||
this.user = n.user;
|
||||
this.password = n.password;
|
||||
}
|
||||
if (this.user) {
|
||||
url += this.user+":"+this.password+"@";
|
||||
}
|
||||
if (this.clustered) {
|
||||
url += this.hostname + "/" + this.db + "?retryWrites=true&w=majority";
|
||||
} else {
|
||||
url += this.hostname + ":" + this.port + "/" + this.db;
|
||||
}
|
||||
url += this.hostname+":"+this.port+"/"+this.db;
|
||||
|
||||
console.log(url);
|
||||
this.url = url;
|
||||
}
|
||||
|
||||
@ -49,7 +74,7 @@ module.exports = function(RED) {
|
||||
var noerror = true;
|
||||
|
||||
var connectToDB = function() {
|
||||
MongoClient.connect(node.mongoConfig.url, function(err, db) {
|
||||
MongoClient.connect(node.mongoConfig.url, function(err, client) {
|
||||
if (err) {
|
||||
node.status({fill:"red",shape:"ring",text:RED._("mongodb.status.error")});
|
||||
if (noerror) { node.error(err); }
|
||||
@ -58,9 +83,12 @@ module.exports = function(RED) {
|
||||
}
|
||||
else {
|
||||
node.status({fill:"green",shape:"dot",text:RED._("mongodb.status.connected")});
|
||||
node.clientDb = db;
|
||||
node.clientDb = client.db();
|
||||
var db = client.db();
|
||||
console.log( db);
|
||||
noerror = true;
|
||||
var coll;
|
||||
|
||||
if (node.collection) {
|
||||
coll = db.collection(node.collection);
|
||||
}
|
||||
@ -174,7 +202,8 @@ module.exports = function(RED) {
|
||||
var noerror = true;
|
||||
|
||||
var connectToDB = function() {
|
||||
MongoClient.connect(node.mongoConfig.url, function(err,db) {
|
||||
console.log("connecting:" + node.mongoConfig.url);
|
||||
MongoClient.connect(node.mongoConfig.url, function(err,client) {
|
||||
if (err) {
|
||||
node.status({fill:"red",shape:"ring",text:RED._("mongodb.status.error")});
|
||||
if (noerror) { node.error(err); }
|
||||
@ -183,7 +212,8 @@ module.exports = function(RED) {
|
||||
}
|
||||
else {
|
||||
node.status({fill:"green",shape:"dot",text:RED._("mongodb.status.connected")});
|
||||
node.clientDb = db;
|
||||
node.clientDb = client.db();
|
||||
var db = client.db();
|
||||
noerror = true;
|
||||
var coll;
|
||||
node.on("input", function(msg) {
|
||||
|
||||
@ -16,13 +16,23 @@ Install
|
||||
-------
|
||||
|
||||
Run the following command in your Node-RED user directory - typically `~/.node-red`
|
||||
|
||||
```
|
||||
npm install node-red-node-mongodb
|
||||
```
|
||||
Note that this package requires a MongoDB client package at least version 3.6.1 - if you have an older (version 2) client,
|
||||
you may need to remove that before installing this
|
||||
```
|
||||
npm remove mongodb
|
||||
npm install node-red-node-mongodb
|
||||
```
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Nodes to save and retrieve data in a local MongoDB instance.
|
||||
Nodes to save and retrieve data in a MongoDB instance - the database server can be local (mongodb//:localhost:27017), remote (mongodb://hostname.network:27017),
|
||||
and sharded cluster (mongodb+srv://clustername.network).
|
||||
|
||||
Reference [MongoDB docs](https://docs.mongodb.com/manual/reference/connection-string/) to see which connection method (host or clustered) to use for your MongoDB instance.
|
||||
|
||||
### Input
|
||||
|
||||
|
||||
@ -2,6 +2,8 @@
|
||||
"mongodb": {
|
||||
"label": {
|
||||
"host": "Host",
|
||||
"clustered": "Clustered",
|
||||
"clusteredVersion":"MongoDB databases in sharded cluster (>=3.4)",
|
||||
"port": "Port",
|
||||
"database": "Database",
|
||||
"username": "Username",
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
{
|
||||
"name" : "node-red-node-mongodb",
|
||||
"version" : "0.0.14",
|
||||
"version" : "0.1.0",
|
||||
"description" : "Node-RED nodes to talk to an Mongo database",
|
||||
"dependencies" : {
|
||||
"mongodb" : "^2.2.34"
|
||||
"mongodb" : "^3.6.1"
|
||||
},
|
||||
"repository" : {
|
||||
"type":"git",
|
||||
@ -20,5 +20,11 @@
|
||||
"name": "Dave Conway-Jones",
|
||||
"email": "ceejay@vnet.ibm.com",
|
||||
"url": "http://nodered.org"
|
||||
},
|
||||
"contributors": [
|
||||
{
|
||||
"name": "Ross Cruickshank",
|
||||
"email": "ross@vnet.ibm.com"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user