1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00

Allow user to select collection in mongo nodes using msg.collection

This commit is contained in:
Anna Thomas 2014-09-19 10:06:15 +01:00
parent 4f2e4b58e4
commit 23b5ac4582
2 changed files with 109 additions and 54 deletions

View File

@ -40,21 +40,21 @@
</script> </script>
<script type="text/javascript"> <script type="text/javascript">
RED.nodes.registerType('mongodb',{ RED.nodes.registerType('mongodb', {
category: 'config', category: 'config',
color:"rgb(218, 196, 180)", color: "rgb(218, 196, 180)",
defaults: { defaults: {
hostname: { value:"127.0.0.1",required:true}, hostname: {value: "127.0.0.1", required: true},
port: { value: 27017,required:true}, port: {value: 27017, required: true},
db: { value:"",required:true}, db: {value: "", required: true},
name: { value:"" } name: {value: ""}
}, },
credentials: { credentials: {
user: {type:"text"}, user: {type: "text"},
password: {type: "password"} password: {type: "password"}
}, },
label: function() { label: function() {
return this.name||this.hostname+":"+this.port+"/"+this.db; return this.name || this.hostname + ":" + this.port + "/" + this.db;
} }
}); });
</script> </script>
@ -72,7 +72,7 @@
<div class="form-row"> <div class="form-row">
<label for="node-input-operation"><i class="fa fa-wrench"></i> Operation</label> <label for="node-input-operation"><i class="fa fa-wrench"></i> Operation</label>
<select type="text" id="node-input-operation" style="display: inline-block; vertical-align: top;"> <select type="text" id="node-input-operation" style="display: inline-block; vertical-align: top;">
<option value="save">save</option> <option value="store">save</option>
<option value="insert">insert</option> <option value="insert">insert</option>
<option value="update">update</option> <option value="update">update</option>
<option value="delete">remove</option> <option value="delete">remove</option>
@ -97,6 +97,8 @@
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label> <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Name"> <input type="text" id="node-input-name" placeholder="Name">
</div> </div>
<div class="form-tips" id="node-warning" style="display: none"><b> Tip:</b> If no collection is set, ensure <b>msg.collection</b> will contain the collection name
</div>
</script> </script>
<script type="text/x-red" data-help-name="mongodb out"> <script type="text/x-red" data-help-name="mongodb out">
@ -107,6 +109,7 @@
<p>Update will modify an existing object or objects. The query to select objects to update uses <b>msg.query</b> and the update to the element uses <b>msg.payload</b>.</p> <p>Update will modify an existing object or objects. The query to select objects to update uses <b>msg.query</b> and the update to the element uses <b>msg.payload</b>.</p>
<p>Update can add a 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 <b>msg.payload</b>. A blank query will delete <i>all of the objects</i> in the collection.</p> <p>Remove will remove objects that match the query passed in on <b>msg.payload</b>. 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 <b>msg.collection</b>. Setting it in the node will override <b>msg.collection</b>.</p>
<p>By default MongoDB creates an <i>_id</i> property as the primary key - so repeated injections of the same <b>msg</b> will result in many database entries.</p> <p>By default MongoDB creates an <i>_id</i> property as the primary key - so repeated injections of the same <b>msg</b> will result in many database entries.</p>
<p>If this is NOT the desired behaviour - ie. you want repeated entries to overwrite, then you must set the <b>msg._id</b> property to be a constant by the use of a previous function node.</p> <p>If this is NOT the desired behaviour - ie. you want repeated entries to overwrite, then you must set the <b>msg._id</b> 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>This could be a unique constant or you could create one based on some other msg property.</p>
@ -122,37 +125,45 @@
if (id === "update") { if (id === "update") {
$(".node-input-payonly").hide(); $(".node-input-payonly").hide();
$(".node-input-upsert, .node-input-multi").show(); $(".node-input-upsert, .node-input-multi").show();
} else if (id == "delete") { } else if (id === "delete") {
$(".node-input-payonly, .node-input-upsert, .node-input-multi").hide(); $(".node-input-payonly, .node-input-upsert, .node-input-multi").hide();
} else { } else {
$(".node-input-payonly").show(); $(".node-input-payonly").show();
$(".node-input-upsert, .node-input-multi").hide(); $(".node-input-upsert, .node-input-multi").hide();
} }
}); });
$("#node-input-collection").change(function () {
if($("#node-input-collection").val() === "") {
$("#node-warning").show();
} else {
$("#node-warning").hide();
}
});
} }
RED.nodes.registerType('mongodb out',{ RED.nodes.registerType('mongodb out', {
category: 'storage-output', category: 'storage-output',
color:"rgb(218, 196, 180)", color: "rgb(218, 196, 180)",
defaults: { defaults: {
mongodb: {type: "mongodb", required: true}, mongodb: {type: "mongodb", required: true},
name: {value: ""}, name: {value: ""},
collection: {value: "", required: true}, collection: {value: ""},
payonly: {value: false}, payonly: {value: false},
upsert: {value: false}, upsert: {value: false},
multi: {value: false}, multi: {value: false},
operation: {value: "save"} operation: {value: "store"}
}, },
inputs:1, inputs: 1,
outputs:0, outputs: 0,
icon: "mongodb.png", icon: "mongodb.png",
align: "right", align: "right",
label: function() { label: function() {
var mongoNode = RED.nodes.node(this.mongodb); 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() { labelStyle: function() {
return this.name?"node_label_italic":""; return this.name ? "node_label_italic" : "";
}, },
oneditprepare: oneditprepare oneditprepare: oneditprepare
}); });
@ -180,6 +191,8 @@
<label for="node-input-name"><i class="fa fa-tag"></i> Name</label> <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
<input type="text" id="node-input-name" placeholder="Name"> <input type="text" id="node-input-name" placeholder="Name">
</div> </div>
<div class="form-tips" id="node-warning" style="display: none"><b> Tip:</b> If no collection is set, ensure <b>msg.collection</b> will contain the collection name
</div>
</script> </script>
<script type="text/x-red" data-help-name="mongodb in"> <script type="text/x-red" data-help-name="mongodb in">
@ -187,29 +200,32 @@
<p>Find queries a collection using the <b>msg.payload</b> as the query statement as per the .find() function. Optionally, you may also (via a function) set a <b>msg.projection</b> object to constrain the returned fields, a <b>msg.sort</b> object and a <b>msg.limit</b> object.</p> <p>Find queries a collection using the <b>msg.payload</b> as the query statement as per the .find() function. Optionally, you may also (via a function) set a <b>msg.projection</b> object to constrain the returned fields, a <b>msg.sort</b> object and a <b>msg.limit</b> object.</p>
<p>Count returns a count of the number of documents in a collection or matching a query using the <b>msg.payload</b> as the query statement.</p> <p>Count returns a count of the number of documents in a collection or matching a query using the <b>msg.payload</b> as the query statement.</p>
<p>Aggregate provides access to the aggregation pipeline using the <b>msg.payload</b> as the pipeline array.</p> <p>Aggregate provides access to the aggregation pipeline using the <b>msg.payload</b> as the pipeline array.</p>
<p>You can override the collection the method is performed on by setting <b>msg.collection</b> to the desired collection name.</p>
<p>See the <a href="http://docs.mongodb.org/manual/reference/method/db.collection.find/" target="new"><i>MongoDB collection methods docs</i></a> for examples.</p> <p>See the <a href="http://docs.mongodb.org/manual/reference/method/db.collection.find/" target="new"><i>MongoDB collection methods docs</i></a> for examples.</p>
<p>The result is returned in <b>msg.payload</b>.</p> <p>The result is returned in <b>msg.payload</b>.</p>
</script> </script>
<script type="text/javascript"> <script type="text/javascript">
RED.nodes.registerType('mongodb in',{
RED.nodes.registerType('mongodb in', {
category: 'storage-input', category: 'storage-input',
color:"rgb(218, 196, 180)", color: "rgb(218, 196, 180)",
defaults: { defaults: {
mongodb: { type:"mongodb",required:true}, mongodb: {type: "mongodb", required: true},
name: {value:""}, name: {value: ""},
collection: {value:"",required:true}, collection: {value: ""},
operation: {value:"find"} operation: {value: "find"}
}, },
inputs:1, inputs: 1,
outputs:1, outputs: 1,
icon: "mongodb.png", icon: "mongodb.png",
label: function() { label: function() {
var mongoNode = RED.nodes.node(this.mongodb); 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() { labelStyle: function() {
return this.name?"node_label_italic":""; return this.name ? "node_label_italic" : "";
} },
oneditprepare: oneditprepare
}); });
</script> </script>

View File

@ -54,32 +54,64 @@ module.exports = function(RED) {
if (this.mongoConfig) { if (this.mongoConfig) {
var node = this; var node = this;
MongoClient.connect(this.mongoConfig.url, function(err,db) { MongoClient.connect(this.mongoConfig.url, function(err, db) {
if (err) { if (err) {
node.error(err); node.error(err);
} else { } else {
node.clientDb = db; node.clientDb = db;
var coll = db.collection(node.collection); var coll;
if (node.collection) {
coll = db.collection(node.collection);
}
node.on("input",function(msg) { node.on("input",function(msg) {
if (node.operation === "save") { if (!coll) {
delete msg._topic; if (msg.collection) {
if (node.payonly) { coll = db.collection(msg.collection);
if (typeof msg.payload !== "object") { msg.payload = {"payload":msg.payload}; }
coll.save(msg.payload,function(err,item){ if (err){node.error(err);} });
} else { } else {
coll.save(msg,function(err,item){if (err){node.error(err);}}); node.error("No collection defined");
return;
} }
} }
else if (node.operation === "insert") { delete msg._topic;
delete msg._topic; delete msg.collection;
if (node.operation === "store") {
if (node.payonly) { if (node.payonly) {
if (typeof msg.payload !== "object") { msg.payload = {"payload":msg.payload}; } if (typeof msg.payload !== "object") {
coll.insert(msg.payload,function(err,item){ if (err){node.error(err);} }); msg.payload = {"payload": msg.payload};
}
coll.save(msg.payload,function(err, item) {
if (err) {
node.error(err);
}
});
} else { } else {
coll.insert(msg,function(err,item){if (err){node.error(err);}}); coll.save(msg,function(err, item) {
if (err) {
node.error(err);
}
});
}
} else if (node.operation === "insert") {
if (node.payonly) {
if (typeof msg.payload !== "object") {
msg.payload = {"payload": msg.payload};
}
coll.insert(msg.payload, function(err, item) {
if (err) {
node.error(err);
}
});
} else {
coll.insert(msg, function(err,item) {
if (err) {
node.error(err);
}
});
}
} else if (node.operation === "update") {
if (typeof msg.payload !== "object") {
msg.payload = {"payload": msg.payload};
} }
}
else if (node.operation === "update") {
var query = msg.query || {}; var query = msg.query || {};
var payload = msg.payload || {}; var payload = msg.payload || {};
var options = { var options = {
@ -89,11 +121,10 @@ module.exports = function(RED) {
coll.update(query, payload, options, function(err, item) { coll.update(query, payload, options, function(err, item) {
if (err) { if (err) {
node.error(err); node.error(err + " " + payload);
} }
}); });
} } else if (node.operation === "delete") {
if (node.operation == "delete") {
coll.remove(msg.payload, function(err, items) { coll.remove(msg.payload, function(err, items) {
if (err) { if (err) {
node.error(err); node.error(err);
@ -115,7 +146,6 @@ module.exports = function(RED) {
} }
RED.nodes.registerType("mongodb out",MongoOutNode); RED.nodes.registerType("mongodb out",MongoOutNode);
function MongoInNode(n) { function MongoInNode(n) {
RED.nodes.createNode(this,n); RED.nodes.createNode(this,n);
this.collection = n.collection; this.collection = n.collection;
@ -130,8 +160,19 @@ module.exports = function(RED) {
node.error(err); node.error(err);
} else { } else {
node.clientDb = db; node.clientDb = db;
var coll = db.collection(node.collection); var coll;
node.on("input",function(msg) { if (node.collection) {
coll = db.collection(node.collection);
}
node.on("input", function(msg) {
if (!coll) {
if (msg.collection) {
coll = db.collection(msg.collection);
} else {
node.error("No collection defined");
return;
}
}
if (node.operation === "find") { if (node.operation === "find") {
msg.projection = msg.projection || {}; msg.projection = msg.projection || {};
coll.find(msg.payload,msg.projection).sort(msg.sort).limit(msg.limit).toArray(function(err, items) { coll.find(msg.payload,msg.projection).sort(msg.sort).limit(msg.limit).toArray(function(err, items) {
@ -145,8 +186,7 @@ module.exports = function(RED) {
node.send(msg); node.send(msg);
} }
}); });
} } else if (node.operation === "count") {
else if (node.operation === "count") {
coll.count(msg.payload, function(err, count) { coll.count(msg.payload, function(err, count) {
if (err) { if (err) {
node.error(err); node.error(err);
@ -155,8 +195,7 @@ module.exports = function(RED) {
node.send(msg); node.send(msg);
} }
}); });
} } else if (node.operation === "aggregate") {
else if (node.operation === "aggregate") {
msg.payload = (msg.payload instanceof Array) ? msg.payload : []; msg.payload = (msg.payload instanceof Array) ? msg.payload : [];
coll.aggregate(msg.payload, function(err, result) { coll.aggregate(msg.payload, function(err, result) {
if (err) { if (err) {