mirror of
https://github.com/node-red/node-red-nodes.git
synced 2025-03-01 10:37:43 +00:00
added i18n help files (#766)
This commit is contained in:
heikokue
GitHub
@@ -6,7 +6,7 @@
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-config-input-encoding"><i class="fa fa-random"></i> Values are</label>
|
||||
|
||||
|
||||
<select type="text" id="node-config-input-encoding">
|
||||
<option value="utf8">text</option>
|
||||
<option value="json">JSON</option>
|
||||
@@ -39,13 +39,6 @@
|
||||
</div>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="leveldb in">
|
||||
<p>Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></a> for a simple key value pair database.</p>
|
||||
<p>Use this node to <b>get</b>, or retrieve the data already saved in the database.</p>
|
||||
<p><code>msg.topic</code> must hold the <i>key</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
|
||||
<p>If nothing is found for the key then <code>msg.payload</code> is set to the <i>null</i> object.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
RED.nodes.registerType('leveldb in',{
|
||||
category: 'storage-input',
|
||||
@@ -67,7 +60,6 @@
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
<script type="text/html" data-template-name="leveldb out">
|
||||
<div class="form-row node-input-level">
|
||||
<label for="node-input-level"><i class="fa fa-briefcase"></i> Database</label>
|
||||
@@ -86,13 +78,6 @@
|
||||
</div>
|
||||
</script>
|
||||
|
||||
|
||||
<script type="text/html" data-help-name="leveldb out">
|
||||
<p>Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></a> for a simple key value pair database.</p>
|
||||
<p>Use this node to either <b>put</b> (store) the <code>msg.payload</code> to the named database file, using <code>msg.topic</code> as the key.</p>
|
||||
<p>To <b>delete</b> information select delete in the properties dialogue and again use <code>msg.topic</code> as the key.</b>.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
RED.nodes.registerType('leveldb out',{
|
||||
category: 'storage-output',
|
||||
|
||||
13
storage/leveldb/locales/en-US/67-leveldb.html
Normal file
13
storage/leveldb/locales/en-US/67-leveldb.html
Normal file
@@ -0,0 +1,13 @@
|
||||
|
||||
<script type="text/html" data-help-name="leveldb in">
|
||||
<p>Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></a> for a simple key value pair database.</p>
|
||||
<p>Use this node to <b>get</b>, or retrieve the data already saved in the database.</p>
|
||||
<p><code>msg.topic</code> must hold the <i>key</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
|
||||
<p>If nothing is found for the key then <code>msg.payload</code> is set to the <i>null</i> object.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="leveldb out">
|
||||
<p>Uses <a href="https://code.google.com/p/leveldb/" target="_new"><i>LevelDB</i></a> for a simple key value pair database.</p>
|
||||
<p>Use this node to either <b>put</b> (store) the <code>msg.payload</code> to the named database file, using <code>msg.topic</code> as the key.</p>
|
||||
<p>To <b>delete</b> information select delete in the properties dialogue and again use <code>msg.topic</code> as the key.</b>.</p>
|
||||
</script>
|
||||
@@ -74,44 +74,6 @@
|
||||
});
|
||||
</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/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>
|
||||
@@ -152,27 +114,6 @@
|
||||
<div class="form-tips" id="node-warning" style="display: none"><span data-i18n="[html]mongodb.tip"></span></div>
|
||||
</script>
|
||||
|
||||
<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>
|
||||
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 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
|
||||
same <code>msg</code> 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 <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 at all... this may well change.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
function oneditprepare() {
|
||||
$("#node-input-operation").change(function () {
|
||||
@@ -225,7 +166,6 @@
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
<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>
|
||||
@@ -250,21 +190,6 @@
|
||||
<div class="form-tips" id="node-warning" style="display: none"><span data-i18n="[html]mongodb.tip"></span></div>
|
||||
</script>
|
||||
|
||||
<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 (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
|
||||
the node will override <code>msg.collection</code>.</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 <code>msg.payload</code>.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
RED.nodes.registerType('mongodb in', {
|
||||
category: 'storage-input',
|
||||
|
||||
74
storage/mongodb/locales/en-US/66-mongodb.html
Normal file
74
storage/mongodb/locales/en-US/66-mongodb.html
Normal file
@@ -0,0 +1,74 @@
|
||||
|
||||
<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/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>
|
||||
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 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
|
||||
same <code>msg</code> 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 <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 at all... this may well change.</p>
|
||||
</script>
|
||||
|
||||
<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 (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
|
||||
the node will override <code>msg.collection</code>.</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 <code>msg.payload</code>.</p>
|
||||
</script>
|
||||
@@ -55,13 +55,6 @@
|
||||
});
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="MySQLdatabase">
|
||||
<p>Add the credentials for accessing your database here.</p>
|
||||
<p>Timezone can be set like GMT, EST5EDT, UTC, etc</p>
|
||||
<p>The Charset defaults to the "old" 3 byte Mysql UTF8. If you need support for emojis etc then use UTF8MB4.</p>
|
||||
</script>
|
||||
|
||||
|
||||
<script type="text/html" data-template-name="mysql">
|
||||
<div class="form-row">
|
||||
<label for="node-input-mydb"><i class="fa fa-database"></i> Database</label>
|
||||
@@ -73,18 +66,6 @@
|
||||
</div>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="mysql">
|
||||
<p>Allows basic access to a MySQL database.</p>
|
||||
<p>This node uses the <b>query</b> operation against the configured database. This does allow both INSERTS and DELETES.
|
||||
By its very nature it allows SQL injection... so <i>be careful out there...</i></p>
|
||||
<p><code>msg.topic</code> must hold the <i>query</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
|
||||
<p><code>msg.payload</code> can contain an array of values to bind to the topic.</p>
|
||||
<p>Typically the returned payload will be an array of the result rows.</p>
|
||||
<p>If nothing is found for the key then <i>null</i> is returned,</p>
|
||||
<p>The reconnect timeout in milliseconds can be changed by adding a line to <b>settings.js</b>
|
||||
<pre>mysqlReconnectTime: 30000,</pre></p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
RED.nodes.registerType('mysql',{
|
||||
category: 'storage-input',
|
||||
|
||||
18
storage/mysql/locales/en-US/68-mysql.html
Normal file
18
storage/mysql/locales/en-US/68-mysql.html
Normal file
@@ -0,0 +1,18 @@
|
||||
|
||||
<script type="text/html" data-help-name="MySQLdatabase">
|
||||
<p>Add the credentials for accessing your database here.</p>
|
||||
<p>Timezone can be set like GMT, EST5EDT, UTC, etc</p>
|
||||
<p>The Charset defaults to the "old" 3 byte Mysql UTF8. If you need support for emojis etc then use UTF8MB4.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/html" data-help-name="mysql">
|
||||
<p>Allows basic access to a MySQL database.</p>
|
||||
<p>This node uses the <b>query</b> operation against the configured database. This does allow both INSERTS and DELETES.
|
||||
By its very nature it allows SQL injection... so <i>be careful out there...</i></p>
|
||||
<p><code>msg.topic</code> must hold the <i>query</i> for the database, and the result is returned in <code>msg.payload</code>.</p>
|
||||
<p><code>msg.payload</code> can contain an array of values to bind to the topic.</p>
|
||||
<p>Typically the returned payload will be an array of the result rows.</p>
|
||||
<p>If nothing is found for the key then <i>null</i> is returned,</p>
|
||||
<p>The reconnect timeout in milliseconds can be changed by adding a line to <b>settings.js</b>
|
||||
<pre>mysqlReconnectTime: 30000,</pre></p>
|
||||
</script>
|
||||
@@ -26,11 +26,6 @@
|
||||
<div class="form-tips"><span data-i18n="[html]redisout.tip"></span></div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="redis out">
|
||||
<p>A Redis output node. Options include Hash, Set, List and String.</p>
|
||||
<p>To run this you need a local Redis server running. For details see <a href="http://redis.io/" target="_new">the Redis site</a>.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
RED.nodes.registerType('redis out',{
|
||||
category: 'storage-output',
|
||||
|
||||
5
storage/redis/locales/en-US/65-redisout.html
Normal file
5
storage/redis/locales/en-US/65-redisout.html
Normal file
@@ -0,0 +1,5 @@
|
||||
|
||||
<script type="text/x-red" data-help-name="redis out">
|
||||
<p>A Redis output node. Options include Hash, Set, List and String.</p>
|
||||
<p>To run this you need a local Redis server running. For details see <a href="http://redis.io/" target="_new">the Redis site</a>.</p>
|
||||
</script>
|
||||
Reference in New Issue
Block a user