Skip to content

Commit 07d13a6

Browse files
t-kataymt-kataym
committed
First commit
1 parent b829060 commit 07d13a6

19 files changed

+4364
-199
lines changed

‎LICENSE

Lines changed: 10 additions & 198 deletions
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,13 @@
1-
Apache License
2-
Version 2.0, January 2004
3-
http://www.apache.org/licenses/
1+
Copyright 2023 Toshiba Corporation.
42

5-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
66

7-
1. Definitions.
7+
http://www.apache.org/licenses/LICENSE-2.0
88

9-
"License" shall mean the terms and conditions for use, reproduction,
10-
and distribution as defined by Sections 1 through 9 of this document.
11-
12-
"Licensor" shall mean the copyright owner or entity authorized by
13-
the copyright owner that is granting the License.
14-
15-
"Legal Entity" shall mean the union of the acting entity and all
16-
other entities that control, are controlled by, or are under common
17-
control with that entity. For the purposes of this definition,
18-
"control" means (i) the power, direct or indirect, to cause the
19-
direction or management of such entity, whether by contract or
20-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21-
outstanding shares, or (iii) beneficial ownership of such entity.
22-
23-
"You" (or "Your") shall mean an individual or Legal Entity
24-
exercising permissions granted by this License.
25-
26-
"Source" form shall mean the preferred form for making modifications,
27-
including but not limited to software source code, documentation
28-
source, and configuration files.
29-
30-
"Object" form shall mean any form resulting from mechanical
31-
transformation or translation of a Source form, including but
32-
not limited to compiled object code, generated documentation,
33-
and conversions to other media types.
34-
35-
"Work" shall mean the work of authorship, whether in Source or
36-
Object form, made available under the License, as indicated by a
37-
copyright notice that is included in or attached to the work
38-
(an example is provided in the Appendix below).
39-
40-
"Derivative Works" shall mean any work, whether in Source or Object
41-
form, that is based on (or derived from) the Work and for which the
42-
editorial revisions, annotations, elaborations, or other modifications
43-
represent, as a whole, an original work of authorship. For the purposes
44-
of this License, Derivative Works shall not include works that remain
45-
separable from, or merely link (or bind by name) to the interfaces of,
46-
the Work and Derivative Works thereof.
47-
48-
"Contribution" shall mean any work of authorship, including
49-
the original version of the Work and any modifications or additions
50-
to that Work or Derivative Works thereof, that is intentionally
51-
submitted to Licensor for inclusion in the Work by the copyright owner
52-
or by an individual or Legal Entity authorized to submit on behalf of
53-
the copyright owner. For the purposes of this definition, "submitted"
54-
means any form of electronic, verbal, or written communication sent
55-
to the Licensor or its representatives, including but not limited to
56-
communication on electronic mailing lists, source code control systems,
57-
and issue tracking systems that are managed by, or on behalf of, the
58-
Licensor for the purpose of discussing and improving the Work, but
59-
excluding communication that is conspicuously marked or otherwise
60-
designated in writing by the copyright owner as "Not a Contribution."
61-
62-
"Contributor" shall mean Licensor and any individual or Legal Entity
63-
on behalf of whom a Contribution has been received by Licensor and
64-
subsequently incorporated within the Work.
65-
66-
2. Grant of Copyright License. Subject to the terms and conditions of
67-
this License, each Contributor hereby grants to You a perpetual,
68-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69-
copyright license to reproduce, prepare Derivative Works of,
70-
publicly display, publicly perform, sublicense, and distribute the
71-
Work and such Derivative Works in Source or Object form.
72-
73-
3. Grant of Patent License. Subject to the terms and conditions of
74-
this License, each Contributor hereby grants to You a perpetual,
75-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76-
(except as stated in this section) patent license to make, have made,
77-
use, offer to sell, sell, import, and otherwise transfer the Work,
78-
where such license applies only to those patent claims licensable
79-
by such Contributor that are necessarily infringed by their
80-
Contribution(s) alone or by combination of their Contribution(s)
81-
with the Work to which such Contribution(s) was submitted. If You
82-
institute patent litigation against any entity (including a
83-
cross-claim or counterclaim in a lawsuit) alleging that the Work
84-
or a Contribution incorporated within the Work constitutes direct
85-
or contributory patent infringement, then any patent licenses
86-
granted to You under this License for that Work shall terminate
87-
as of the date such litigation is filed.
88-
89-
4. Redistribution. You may reproduce and distribute copies of the
90-
Work or Derivative Works thereof in any medium, with or without
91-
modifications, and in Source or Object form, provided that You
92-
meet the following conditions:
93-
94-
(a) You must give any other recipients of the Work or
95-
Derivative Works a copy of this License; and
96-
97-
(b) You must cause any modified files to carry prominent notices
98-
stating that You changed the files; and
99-
100-
(c) You must retain, in the Source form of any Derivative Works
101-
that You distribute, all copyright, patent, trademark, and
102-
attribution notices from the Source form of the Work,
103-
excluding those notices that do not pertain to any part of
104-
the Derivative Works; and
105-
106-
(d) If the Work includes a "NOTICE" text file as part of its
107-
distribution, then any Derivative Works that You distribute must
108-
include a readable copy of the attribution notices contained
109-
within such NOTICE file, excluding those notices that do not
110-
pertain to any part of the Derivative Works, in at least one
111-
of the following places: within a NOTICE text file distributed
112-
as part of the Derivative Works; within the Source form or
113-
documentation, if provided along with the Derivative Works; or,
114-
within a display generated by the Derivative Works, if and
115-
wherever such third-party notices normally appear. The contents
116-
of the NOTICE file are for informational purposes only and
117-
do not modify the License. You may add Your own attribution
118-
notices within Derivative Works that You distribute, alongside
119-
or as an addendum to the NOTICE text from the Work, provided
120-
that such additional attribution notices cannot be construed
121-
as modifying the License.
122-
123-
You may add Your own copyright statement to Your modifications and
124-
may provide additional or different license terms and conditions
125-
for use, reproduction, or distribution of Your modifications, or
126-
for any such Derivative Works as a whole, provided Your use,
127-
reproduction, and distribution of the Work otherwise complies with
128-
the conditions stated in this License.
129-
130-
5. Submission of Contributions. Unless You explicitly state otherwise,
131-
any Contribution intentionally submitted for inclusion in the Work
132-
by You to the Licensor shall be under the terms and conditions of
133-
this License, without any additional terms or conditions.
134-
Notwithstanding the above, nothing herein shall supersede or modify
135-
the terms of any separate license agreement you may have executed
136-
with Licensor regarding such Contributions.
137-
138-
6. Trademarks. This License does not grant permission to use the trade
139-
names, trademarks, service marks, or product names of the Licensor,
140-
except as required for reasonable and customary use in describing the
141-
origin of the Work and reproducing the content of the NOTICE file.
142-
143-
7. Disclaimer of Warranty. Unless required by applicable law or
144-
agreed to in writing, Licensor provides the Work (and each
145-
Contributor provides its Contributions) on an "AS IS" BASIS,
146-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147-
implied, including, without limitation, any warranties or conditions
148-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149-
PARTICULAR PURPOSE. You are solely responsible for determining the
150-
appropriateness of using or redistributing the Work and assume any
151-
risks associated with Your exercise of permissions under this License.
152-
153-
8. Limitation of Liability. In no event and under no legal theory,
154-
whether in tort (including negligence), contract, or otherwise,
155-
unless required by applicable law (such as deliberate and grossly
156-
negligent acts) or agreed to in writing, shall any Contributor be
157-
liable to You for damages, including any direct, indirect, special,
158-
incidental, or consequential damages of any character arising as a
159-
result of this License or out of the use or inability to use the
160-
Work (including but not limited to damages for loss of goodwill,
161-
work stoppage, computer failure or malfunction, or any and all
162-
other commercial damages or losses), even if such Contributor
163-
has been advised of the possibility of such damages.
164-
165-
9. Accepting Warranty or Additional Liability. While redistributing
166-
the Work or Derivative Works thereof, You may choose to offer,
167-
and charge a fee for, acceptance of support, warranty, indemnity,
168-
or other liability obligations and/or rights consistent with this
169-
License. However, in accepting such obligations, You may act only
170-
on Your own behalf and on Your sole responsibility, not on behalf
171-
of any other Contributor, and only if You agree to indemnify,
172-
defend, and hold each Contributor harmless for any liability
173-
incurred by, or claims asserted against, such Contributor by reason
174-
of your accepting any such warranty or additional liability.
175-
176-
END OF TERMS AND CONDITIONS
177-
178-
APPENDIX: How to apply the Apache License to your work.
179-
180-
To apply the Apache License to your work, attach the following
181-
boilerplate notice, with the fields enclosed by brackets "[]"
182-
replaced with your own identifying information. (Don't include
183-
the brackets!) The text should be enclosed in the appropriate
184-
comment syntax for the file format. We also recommend that a
185-
file or class name and description of purpose be included on the
186-
same "printed page" as the copyright notice for easier
187-
identification within third-party archives.
188-
189-
Copyright [yyyy] [name of copyright owner]
190-
191-
Licensed under the Apache License, Version 2.0 (the "License");
192-
you may not use this file except in compliance with the License.
193-
You may obtain a copy of the License at
194-
195-
http://www.apache.org/licenses/LICENSE-2.0
196-
197-
Unless required by applicable law or agreed to in writing, software
198-
distributed under the License is distributed on an "AS IS" BASIS,
199-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200-
See the License for the specific language governing permissions and
201-
limitations under the License.
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.

‎README.md

Lines changed: 132 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,132 @@
1-
# node-red-db2chart
1+
## Introduction
2+
3+
db2chart node is the Node-RED node to convert database data to the form that is compatible to Charts on Dashboard.
4+
5+
The input of db2chart node is the output of database node such as PostgreSQL node ([node-red-contrib-postgresql](https://flows.nodered.org/node/node-red-contrib-postgresql)), MySQL node ([node-red-node-mysql](https://flows.nodered.org/node/node-red-node-mysql)) and SQL Server node ([node-red-contrib-mssql-plus](https://flows.nodered.org/node/node-red-contrib-mssql-plus)).
6+
And the output of db2chart node is the input of Chart nodes ([node-red-dashboard](https://github.com/node-red/node-red-dashboard)).
7+
8+
Example Input/Output of db2chart in [Appendix](#appendix).
9+
10+
## Prerequisites
11+
12+
db2chart node requires the following items to be installed.
13+
14+
- [Node-RED](https://nodered.org/) version 1.0.0 or later (We confirmed on 3.2.0)
15+
16+
## Installation
17+
18+
### Using npm
19+
1. Check out the source code:
20+
```
21+
git clone https://github.com/pgspider/node-red-db2chart.git
22+
```
23+
1. Install db2chart to Node-RED environment:
24+
```
25+
npm install <path-to-node-red-db2chart>
26+
```
27+
28+
## Guidelines how to use db2chart
29+
30+
1. On the Node-RED flow editor, draw the following flow.
31+
![db2chart_flow](images/db2chart_flow.png)
32+
2. Double click on the PostgreSQL node to set configuration to connect to PostgreSQL database server and input a query to select data.
33+
![postgresql_node](images/postgresql_node.png)
34+
3. Double click on the db2chart node to set configuration if any, for example, set the first column as labels.
35+
![db2chart_node](images/db2chart_node.png)
36+
4. Double click on the chart node to set type of chart.
37+
![chart_node](images/chart_node.png)
38+
5. Click Deploy on the Node-RED editor.
39+
6. Click on the button of the Inject node "click me".
40+
7. Open the Dashboard to see the chart.
41+
![dashboard](images/dashboard.png)
42+
43+
## Error messages
44+
45+
In case of error, the db2chart node will report error to the runtime, user can use Catch node to catch the error messages.
46+
1. If the input message payload is neither array nor single object, the following error message will be reported.
47+
```
48+
Invalid input message payload, neither array nor single object.
49+
```
50+
2. In case the message payload is an array, if the item in the array is not an object, the following error message will be reported, N is the position of the object in the array.
51+
```
52+
Invalid object in the payload array at the index N.
53+
```
54+
3. If the object in the message payload has only one property (one column), and user marks it as label, the following error message will be reported.
55+
```
56+
Cannot mark the first column as label.
57+
```
58+
4. In case the message payload is an array, if the items in the array are not consistent, for example, different properties, the following error message will be reported. N is the position of the object in the array that different from the first object.
59+
```
60+
Object is inconsistent at the index N.
61+
```
62+
5. If column data in the object is not a Number, the following error message will be reported.
63+
```
64+
Invalid data type, only Number is valid.
65+
```
66+
67+
### Catch node
68+
69+
1. Create the following flow with the Catch node.
70+
![catch_node](images/catch_node.png)
71+
2. Double click on the Inject node to set an invalid message.
72+
![inject_node](images/inject_node.png)
73+
3. Double click on the Catch node to select db2chart node that Catch node will catch error message from.
74+
![edit_catch_node](images/edit_catch_node.png)
75+
4. Double click on the Debug node to change the output to the complete message object.
76+
![debug_node](images/debug_node.png)
77+
5. Click on the button Deploy on the editor, then click on the Inject node. The message object is shown on the Debug tab, then user can find the error message.
78+
![error_message](images/error_message.png)
79+
80+
## Testing
81+
82+
The test suite requires the following software installed in addition to db2chart. (Numbers are versions which we used)
83+
- [node-red-dashboard](https://flows.nodered.org/node/node-red-dashboard) (v3.5.0)
84+
- [node-red-contrib-postgreql](https://flows.nodered.org/node/node-red-contrib-postgresql) (v0.13.0)
85+
- [node-red-contrib-flowtest](https://github.com/steineey/node-red-contrib-flowtest) (v0.1.2)
86+
- [PostgreSQL database server](https://www.postgresql.org/) (v15.0)
87+
88+
### Steps
89+
1. Start PostgreSQL server
90+
2. On the Node-RED editor, import the test flow located at test/TestCode.json.
91+
2-1. Press Ctrl+i to open Import nodes interface.
92+
2-2. Select TestCode.json and click the button Import.
93+
3. On the flow editor, configure PostgreSQL node to connect to PostgreSQL DB server and do the following steps.
94+
3-1. Prepare test data on PostgreSQL.
95+
3-2. Execute each test by clicking on "click me" in each test case. The test result OK/Not OK is displayed on Assert node.
96+
97+
![test_suite](images/test_suite.png)
98+
99+
## Appendix
100+
101+
The input of db2chart is an array of rows. Each item in the array is a JSON object that represents a row in database, each object has the properties are columns. The format of the input message:
102+
```
103+
[{col1: col1_value_1, col2: col2_value_1}, {col1: col1_value_2, col2: col2_value_2}]
104+
```
105+
106+
The output of db2chart is an array that has only one JSON object and this object has 03 properties including series, data and labels. Each property is an array. The format of the output message like below:
107+
```
108+
[{"series": ["col1", "col2"], "data": [[col1_value_1,col1_value_2], [col2_value_1,col2_value_2]], "labels": [0,1]}]
109+
```
110+
111+
For example, the figure below will represent the table data on the bar chart. The horizontal axis represents labels, The vertical axis represents column data values, and when hovering mouse to the chart, series will be displayed.
112+
113+
| col1 | col2 |
114+
| :--- | :--- |
115+
| col1_value1 | col2_value1 |
116+
| col1_value2 | col2_value2 |
117+
118+
![map_data](images/map_data.png)
119+
120+
In case of using the first column as labels, the output message payload of db2chart is as follows.
121+
```
122+
[{"series": ["col2"], "data": [[col2_value_1, col2_value_2]], "labels": ["col1_value1", "col1_value2"]}]
123+
```
124+
125+
The bar chart will be displayed like this.
126+
127+
![map_data_first_col_label](images/map_data_first_col_label.png)
128+
129+
130+
## Copyright and license
131+
132+
Copyright Toshiba Corporation under [the Apache 2.0 license](LICENSE).

0 commit comments

Comments
 (0)