mirror of
https://github.com/node-red/node-red-nodes.git
synced 2025-03-01 10:37:43 +00:00
Merge remote-tracking branch 'upstream/master'
This commit is contained in:
Kévin Michelet
@@ -1,10 +1,29 @@
|
||||
<script type="text/x-red" data-template-name="mongodb">
|
||||
|
||||
<script type="text/html" 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-topology">
|
||||
<label for="node-config-input-topology"><span data-i18n="mongodb.label.topology"></span></label>
|
||||
<select id="node-config-input-topology">
|
||||
<option type="button" class="red-ui-button toggle topology-group" selected value="direct">Direct (mongodb://)</button>
|
||||
<option type="button" class="red-ui-button toggle topology-group" value="replicaset">RelicaSet/Cluster (mongodb://)</button>
|
||||
<option type="button" class="red-ui-button toggle topology-group" value="dnscluster">DNS Cluster (mongodb+srv://)</button>
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div class="form-row node-config-connectOptions">
|
||||
<label for="node-config-input-connectOptions"><i class="fa fa-wrench"></i><span data-i18n="mongodb.label.connectOptions"></span></label>
|
||||
<input type="text" id="node-config-input-connectOptions">
|
||||
</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">
|
||||
<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">
|
||||
@@ -28,23 +47,72 @@
|
||||
category: 'config',
|
||||
color: "rgb(218, 196, 180)",
|
||||
defaults: {
|
||||
hostname: { value: "127.0.0.1", required: true },
|
||||
port: { value: 27017, required: true },
|
||||
db: { value: "", required: true },
|
||||
name: { value: "" }
|
||||
hostname: {value: "127.0.0.1", required: true},
|
||||
topology: {value: "direct", required: true},
|
||||
connectOptions: {value: "", required: false},
|
||||
port: {value: 27017, required: true},
|
||||
db: {value: "", required: true},
|
||||
name: {value: ""}
|
||||
},
|
||||
credentials: {
|
||||
user: { type: "text" },
|
||||
password: { type: "password" }
|
||||
},
|
||||
label: function () {
|
||||
return this.name || this.hostname + ":" + this.port + "/" + this.db;
|
||||
}
|
||||
label: function() {
|
||||
return this.name || this.db + "@" + this.hostname;
|
||||
},
|
||||
oneditprepare: function() {
|
||||
$("#node-config-input-topology").on("change", function() {
|
||||
var topology = $("#node-config-input-topology option:selected").val();
|
||||
if (topology === "direct") {
|
||||
$(".node-config-input-port").show();
|
||||
} else {
|
||||
$(".node-config-input-port").hide();
|
||||
}
|
||||
});
|
||||
},
|
||||
});
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="mongodb">
|
||||
<p>Define a connection method to your MongoDB server instance.</p>
|
||||
<p>There are 3 supported options:
|
||||
<details><summary>Standard/direct</summary>
|
||||
For databases that request connections in the form
|
||||
<code>
|
||||
mongodb://[username]:[password]@[hostname]:[port]/[dbname]
|
||||
</code>
|
||||
Most often used for local MongoDB instances (localhost:27017), and other stand-alone instances.
|
||||
</details>
|
||||
<details><summary>Standard/replicaset</summary>
|
||||
For databases that request connections in the form
|
||||
<code>
|
||||
mongodb://[username]:[password]@[hostnameA]:[port],[hostnameB]:[port]/[dbname]?replicaSet=[replsetname]
|
||||
</code>
|
||||
Often used with <q>database as a service</q> offerings,
|
||||
or on-premises instances that have been configured for availability and resilience
|
||||
</details>
|
||||
<details><summary>Clustered by DNS seedlist</summary>
|
||||
For databases that request connections in the form
|
||||
<code>
|
||||
mongodb+srv://[username]:[password]@[clustername]/[dbname]?retryWrites=true&w=majority
|
||||
</code>
|
||||
A configuration of MongoDB instances that provide availability and performance
|
||||
through replication and sharding, accessed through a cluster alias name, rather than
|
||||
by specific host:port connections. This is the default for MongoDB instances in the
|
||||
<a href="https://www.mongodb.com/cloud/atlas" target="_blank">Atlas cloud service</a>.
|
||||
</details>
|
||||
<p><strong>Connect options</strong> is where you add the optional parameters required by your MongoDB instance.
|
||||
This might include:
|
||||
<ul><li>w=majority</li><li>replicaSet=replset</li><li>authSource=admin</li></ul> and any other options appropriate -
|
||||
full set available at <a href="https://docs.mongodb.com/manual/reference/connection-string/" target="_blank">
|
||||
Connection String URI Format — MongoDB Manual</a>.
|
||||
<p>If you are connecting to <a href="https://cloud.ibm.com/catalog/services/databases-for-mongodb-group" target="_blank">
|
||||
IBM Databases for MongoDB</a>, as a replica-set, be sure to append <code>ssl=true&tlsAllowInvalidCertificates=true </code>
|
||||
to the <strong>Connect options</strong>.
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-template-name="mongodb out">
|
||||
<script type="text/html" data-template-name="mongodb out">
|
||||
<div class="form-row">
|
||||
<label for="node-input-mongodb"><i class="fa fa-bookmark"></i> <span data-i18n="mongodb.label.server"></span></label>
|
||||
<input type="text" id="node-input-mongodb">
|
||||
@@ -84,29 +152,28 @@
|
||||
<div class="form-tips" id="node-warning" style="display: none"><span data-i18n="[html]mongodb.tip"></span></div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="mongodb out">
|
||||
<script type="text/html" data-help-name="mongodb out">
|
||||
<p>A simple MongoDB output node. Can save, insert, update and remove objects from a chosen collection.</p>
|
||||
<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">
|
||||
|
||||
function oneditprepare() {
|
||||
$("#node-input-operation").change(function () {
|
||||
var id = $("#node-input-operation option:selected").val();
|
||||
@@ -159,7 +226,7 @@
|
||||
</script>
|
||||
|
||||
|
||||
<script type="text/x-red" data-template-name="mongodb in">
|
||||
<script type="text/html" data-template-name="mongodb in">
|
||||
<div class="form-row">
|
||||
<label for="node-input-mongodb"><i class="fa fa-bookmark"></i> <span data-i18n="mongodb.label.server"></span></label>
|
||||
<input type="text" id="node-input-mongodb">
|
||||
@@ -183,12 +250,12 @@
|
||||
<div class="form-tips" id="node-warning" style="display: none"><span data-i18n="[html]mongodb.tip"></span></div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="mongodb in">
|
||||
<script type="text/html" 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
|
||||
@@ -199,7 +266,6 @@
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
|
||||
RED.nodes.registerType('mongodb in', {
|
||||
category: 'storage-input',
|
||||
color: "rgb(218, 196, 180)",
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
|
||||
module.exports = function (RED) {
|
||||
|
||||
module.exports = function(RED) {
|
||||
"use strict";
|
||||
var mongo = require('mongodb');
|
||||
var ObjectID = require('mongodb').ObjectID;
|
||||
@@ -11,13 +12,37 @@ module.exports = function (RED) {
|
||||
this.port = n.port;
|
||||
this.db = n.db;
|
||||
this.name = n.name;
|
||||
this.connectOptions= n.connectOptions;
|
||||
this.topology = n.topology;
|
||||
|
||||
//console.log(this);
|
||||
|
||||
var clustered = (this.topology !== "direct") || false;
|
||||
|
||||
var url = "mongodb://";
|
||||
if (this.credentials && this.credentials.user && this.credentials.password) {
|
||||
url += this.credentials.user + ":" + this.credentials.password + "@";
|
||||
if (this.topology === "dnscluster") {
|
||||
url = "mongodb+srv://";
|
||||
}
|
||||
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 (clustered) {
|
||||
url += this.hostname + "/" + this.db
|
||||
} else {
|
||||
url += this.hostname + ":" + this.port + "/" + this.db;
|
||||
}
|
||||
if (this.connectOptions){
|
||||
url += "?" + this.connectOptions;
|
||||
}
|
||||
url += this.hostname + ":" + this.port + "/" + this.db;
|
||||
|
||||
console.log("MongoDB URL: " + url);
|
||||
this.url = url;
|
||||
}
|
||||
|
||||
@@ -44,12 +69,12 @@ module.exports = function (RED) {
|
||||
this.multi = n.multi || false;
|
||||
this.operation = n.operation;
|
||||
this.mongoConfig = RED.nodes.getNode(this.mongodb);
|
||||
this.status({ fill: "grey", shape: "ring", text: RED._("mongodbstatus.connecting") });
|
||||
this.status({fill:"grey",shape:"ring",text:RED._("mongodb.status.connecting")});
|
||||
var node = this;
|
||||
var noerror = true;
|
||||
|
||||
var connectToDB = function () {
|
||||
MongoClient.connect(node.mongoConfig.url, function (err, db) {
|
||||
var connectToDB = function() {
|
||||
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); }
|
||||
@@ -57,10 +82,13 @@ module.exports = function (RED) {
|
||||
node.tout = setTimeout(connectToDB, 10000);
|
||||
}
|
||||
else {
|
||||
node.status({ fill: "green", shape: "dot", text: RED._("mongodb.status.connected") });
|
||||
node.clientDb = db;
|
||||
node.status({fill:"green",shape:"dot",text:RED._("mongodb.status.connected")});
|
||||
node.clientDb = client.db();
|
||||
var db = client.db();
|
||||
//console.log( db);
|
||||
noerror = true;
|
||||
var coll;
|
||||
|
||||
if (node.collection) {
|
||||
coll = db.collection(node.collection);
|
||||
}
|
||||
@@ -118,8 +146,9 @@ module.exports = function (RED) {
|
||||
var node = this;
|
||||
var noerror = true;
|
||||
|
||||
var connectToDB = function () {
|
||||
MongoClient.connect(node.mongoConfig.url, function (err, db) {
|
||||
var connectToDB = function() {
|
||||
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); }
|
||||
@@ -127,8 +156,9 @@ module.exports = function (RED) {
|
||||
node.tout = setTimeout(connectToDB, 10000);
|
||||
}
|
||||
else {
|
||||
node.status({ fill: "green", shape: "dot", text: RED._("mongodb.status.connected") });
|
||||
node.clientDb = db;
|
||||
node.status({fill:"green",shape:"dot",text:RED._("mongodb.status.connected")});
|
||||
node.clientDb = client.db();
|
||||
var db = client.db();
|
||||
noerror = true;
|
||||
var coll;
|
||||
node.on("input", function (msg) {
|
||||
@@ -161,10 +191,10 @@ module.exports = function (RED) {
|
||||
skip = 0;
|
||||
}
|
||||
|
||||
coll.find(selector, msg.projection).sort(msg.sort).limit(limit).skip(skip).toArray(function (err, items) {
|
||||
coll.find(selector).project(msg.projection).sort(msg.sort).limit(limit).skip(skip).toArray(function(err, items) {
|
||||
if (err) {
|
||||
node.error(err);
|
||||
}
|
||||
> }
|
||||
else {
|
||||
msg.payload = items;
|
||||
delete msg.projection;
|
||||
@@ -189,13 +219,21 @@ module.exports = function (RED) {
|
||||
}
|
||||
else if (node.operation === "aggregate") {
|
||||
msg.payload = (Array.isArray(msg.payload)) ? msg.payload : [];
|
||||
coll.aggregate(msg.payload, function (err, result) {
|
||||
coll.aggregate(msg.payload, function(err, cursor) {
|
||||
if (err) {
|
||||
node.error(err);
|
||||
}
|
||||
else {
|
||||
msg.payload = result;
|
||||
node.send(msg);
|
||||
cursor.toArray(function(cursorError, cursorDocs) {
|
||||
//console.log(cursorDocs);
|
||||
if (cursorError) {
|
||||
node.error(cursorError);
|
||||
}
|
||||
else {
|
||||
msg.payload = cursorDocs;
|
||||
node.send(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),
|
||||
replica-set or cluster (mongodb://hostnameA.network:27017,hostnameB.network:27017), and DNS seedlist 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",
|
||||
"topology":"Connection topology",
|
||||
"connectOptions":"Connect options",
|
||||
"port": "Port",
|
||||
"database": "Database",
|
||||
"username": "Username",
|
||||
|
||||
38
storage/mongodb/locales/ja/66-mongodb.json
Normal file
38
storage/mongodb/locales/ja/66-mongodb.json
Normal file
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"mongodb": {
|
||||
"label": {
|
||||
"host": "ホスト",
|
||||
"topology":"接続トポロジ",
|
||||
"connectOptions":"接続オプション",
|
||||
"port": "ポート",
|
||||
"database": "データベース",
|
||||
"username": "ユーザ",
|
||||
"password": "パスワード",
|
||||
"server": "サーバ",
|
||||
"collection": "コレクション",
|
||||
"operation": "操作",
|
||||
"onlystore": "msg.payloadオブジェクトのみ保存",
|
||||
"createnew": "一致しなければ新しいドキュメントを作成",
|
||||
"updateall": "合致する全ドキュメントを更新"
|
||||
},
|
||||
"operation": {
|
||||
"save": "save",
|
||||
"insert": "insert",
|
||||
"update": "update",
|
||||
"remove": "remove",
|
||||
"find": "find",
|
||||
"count": "count",
|
||||
"aggregate": "aggregate"
|
||||
},
|
||||
"status": {
|
||||
"connecting": "接続中",
|
||||
"connected": "接続しました",
|
||||
"error": "エラー"
|
||||
},
|
||||
"tip": "<b> Tip:</b> コレクションが設定されていない場合、 <code>msg.collection</code>がコレクション名として使われます。",
|
||||
"errors": {
|
||||
"nocollection": "コレクションが定義されていません",
|
||||
"missingconfig": "mongodbの設定がみつかりません"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,9 +1,9 @@
|
||||
{
|
||||
"name" : "node-red-node-mongodb",
|
||||
"version" : "0.0.14",
|
||||
"version" : "0.2.4",
|
||||
"description" : "Node-RED nodes to talk to an Mongo database",
|
||||
"dependencies" : {
|
||||
"mongodb" : "^2.2.34"
|
||||
"mongodb" : "^3.6.2"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user