@itentialopensource/adapter-db_mysql 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AUTH.md +2 -2
- package/CHANGELOG.md +8 -0
- package/SYSTEMINFO.md +13 -2
- package/TAB1.md +11 -0
- package/TAB2.md +73 -0
- package/compliance-report.json +9 -0
- package/compliance-report.txt +5 -0
- package/metadata.json +35 -7
- package/package.json +7 -8
- package/refs?service=git-upload-pack +0 -0
- package/sampleProperties.json +1 -1
package/AUTH.md
CHANGED
|
@@ -12,8 +12,7 @@ STEPS
|
|
|
12
12
|
```json
|
|
13
13
|
"authentication": {
|
|
14
14
|
"dbAuth": true,
|
|
15
|
-
"
|
|
16
|
-
"username": "sa",
|
|
15
|
+
"username": "username",
|
|
17
16
|
"password": "Password"
|
|
18
17
|
}
|
|
19
18
|
```
|
|
@@ -23,3 +22,4 @@ STEPS
|
|
|
23
22
|
- Make sure you copied over the correct username and password.
|
|
24
23
|
- Turn on debug level logs for the adapter in IAP Admin Essentials.
|
|
25
24
|
- Investigate the logs
|
|
25
|
+
- Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
|
package/CHANGELOG.md
CHANGED
|
@@ -1,4 +1,12 @@
|
|
|
1
1
|
|
|
2
|
+
## 0.2.1 [07-26-2024]
|
|
3
|
+
|
|
4
|
+
* manual migration updates
|
|
5
|
+
|
|
6
|
+
See merge request itentialopensource/adapters/persistence/adapter-db_mysql!16
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
2
10
|
## 0.2.0 [01-06-2024]
|
|
3
11
|
|
|
4
12
|
* Adapter Engine has been updated and the changes are being migrated to the adapter
|
package/SYSTEMINFO.md
CHANGED
|
@@ -4,8 +4,19 @@ Vendor: Oracle
|
|
|
4
4
|
Homepage: https://www.oracle.com/
|
|
5
5
|
|
|
6
6
|
Product: MySQL
|
|
7
|
-
Product Page: https://www.
|
|
7
|
+
Product Page: https://www.mysql.com/
|
|
8
8
|
|
|
9
9
|
## Introduction
|
|
10
|
+
We classify MySQL into the Data Storage domaina as MySQL is a database which provides the storage of information.
|
|
10
11
|
|
|
11
|
-
|
|
12
|
+
"MySQL powers the most demanding Web, E-commerce, SaaS and Online Transaction Processing (OLTP) applications"
|
|
13
|
+
|
|
14
|
+
## Why Integrate
|
|
15
|
+
The MySQL adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Oracle MySQL. With this adapter you have the ability to perform operations with MySQL on items such as:
|
|
16
|
+
|
|
17
|
+
- Storage of Information
|
|
18
|
+
- Retrieval of Information
|
|
19
|
+
|
|
20
|
+
## Additional Product Documentation
|
|
21
|
+
The [MySQL SQL Reference](https://dev.mysql.com/doc/refman/8.4/en/sql-statements.html)
|
|
22
|
+
The [MySQL Node Library Documentation](https://www.npmjs.com/package/mysql)
|
package/TAB1.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Overview
|
|
2
|
+
|
|
3
|
+
This adapter is used to integrate the Itential Automation Platform (IAP) with the MySQL System. The API that was used to build the adapter for MySQL is usually available in the report directory of this adapter. The adapter utilizes the MySQL API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
|
|
4
|
+
|
|
5
|
+
## Details
|
|
6
|
+
The MySQL adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Oracle MySQL. With this adapter you have the ability to perform operations with MySQL on items such as:
|
|
7
|
+
|
|
8
|
+
- Storage of Information
|
|
9
|
+
- Retrieval of Information
|
|
10
|
+
|
|
11
|
+
For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
|
package/TAB2.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# MySQL
|
|
2
|
+
|
|
3
|
+
## Table of Contents
|
|
4
|
+
|
|
5
|
+
- [Specific Adapter Information](#specific-adapter-information)
|
|
6
|
+
- [Authentication](#authentication)
|
|
7
|
+
- [Sample Properties](#sample-properties)
|
|
8
|
+
- [Swagger](#swagger)
|
|
9
|
+
- [Generic Adapter Information](#generic-adapter-information)
|
|
10
|
+
|
|
11
|
+
## Specific Adapter Information
|
|
12
|
+
### Authentication
|
|
13
|
+
|
|
14
|
+
This document will go through the steps for authenticating the MySQL adapter with. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>.
|
|
15
|
+
|
|
16
|
+
#### Database Library Authentication
|
|
17
|
+
The MySQL adapter requires Database Library Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
|
|
18
|
+
|
|
19
|
+
STEPS
|
|
20
|
+
1. Ensure you have access to a MySQL server and that it is running
|
|
21
|
+
2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
|
|
22
|
+
3. Use the properties below for the ```properties.authentication``` field
|
|
23
|
+
```json
|
|
24
|
+
"authentication": {
|
|
25
|
+
"dbAuth": true,
|
|
26
|
+
"username": "username",
|
|
27
|
+
"password": "Password"
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
4. Restart the adapter. If your properties were set correctly, the adapter should go online.
|
|
31
|
+
|
|
32
|
+
#### Troubleshooting
|
|
33
|
+
- Make sure you copied over the correct username and password.
|
|
34
|
+
- Turn on debug level logs for the adapter in IAP Admin Essentials.
|
|
35
|
+
- Investigate the logs
|
|
36
|
+
- Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
|
|
37
|
+
### Sample Properties
|
|
38
|
+
|
|
39
|
+
Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
|
|
40
|
+
|
|
41
|
+
```json
|
|
42
|
+
"properties": {
|
|
43
|
+
"database": "your database name",
|
|
44
|
+
"host": "localhost",
|
|
45
|
+
"port": 3306,
|
|
46
|
+
"authentication": {
|
|
47
|
+
"dbAuth": false,
|
|
48
|
+
"username": "your username",
|
|
49
|
+
"password": "your password"
|
|
50
|
+
},
|
|
51
|
+
"ssl": {
|
|
52
|
+
"enabled": false,
|
|
53
|
+
"accept_invalid_cert": false,
|
|
54
|
+
"ca_file": ""
|
|
55
|
+
},
|
|
56
|
+
"connectionOptions": {
|
|
57
|
+
"connectTimeout": 10000,
|
|
58
|
+
"acquireTimeout": 10000,
|
|
59
|
+
"waitForConnections": true,
|
|
60
|
+
"connectionLimit": 10,
|
|
61
|
+
"queueLimit": 0
|
|
62
|
+
},
|
|
63
|
+
"healthcheck": {
|
|
64
|
+
"type": "intermittent",
|
|
65
|
+
"frequency": 60000
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
### Swagger
|
|
70
|
+
|
|
71
|
+
Note: The content for this section may be missing as its corresponding .json file is unavailable. This sections will be updated once adapter-openapi.json file is added.
|
|
72
|
+
## [Generic Adapter Information](https://gitlab.com/itentialopensource/adapters/persistence/adapter-db_mysql/-/blob/master/README.md)
|
|
73
|
+
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
---------------------------------------------------------------------------------------------
|
|
2
|
+
**** Project Compliance Summary ****
|
|
3
|
+
0 project(s) are not valid
|
|
4
|
+
0 project(s) are valid
|
|
5
|
+
---------------------------------------------------------------------------------------------
|
package/metadata.json
CHANGED
|
@@ -16,26 +16,54 @@
|
|
|
16
16
|
"domains": [
|
|
17
17
|
"Data Storage"
|
|
18
18
|
],
|
|
19
|
-
"tags": [
|
|
20
|
-
|
|
19
|
+
"tags": [
|
|
20
|
+
"Database & Repository Operations"
|
|
21
|
+
],
|
|
22
|
+
"useCases": [
|
|
23
|
+
"CRUD Operations",
|
|
24
|
+
"Persist Data"
|
|
25
|
+
],
|
|
21
26
|
"deprecated": {
|
|
22
27
|
"isDeprecated": false
|
|
23
28
|
},
|
|
24
29
|
"brokerSince": "",
|
|
30
|
+
"authMethods": [
|
|
31
|
+
{
|
|
32
|
+
"type": "Database Auth",
|
|
33
|
+
"subtypes": [],
|
|
34
|
+
"primary": true
|
|
35
|
+
}
|
|
36
|
+
],
|
|
25
37
|
"documentation": {
|
|
26
38
|
"storeLink": "",
|
|
27
39
|
"npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-db_mysql",
|
|
28
|
-
"repoLink": "https://gitlab.com/itentialopensource/adapters/
|
|
40
|
+
"repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-db_mysql",
|
|
29
41
|
"docLink": "",
|
|
30
42
|
"demoLinks": [],
|
|
31
|
-
"trainingLinks": [
|
|
43
|
+
"trainingLinks": [
|
|
44
|
+
{
|
|
45
|
+
"title": "Itential Academy",
|
|
46
|
+
"link": "https://www.itential.com/itential-academy/"
|
|
47
|
+
}
|
|
48
|
+
],
|
|
32
49
|
"faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
|
|
33
50
|
"contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
|
|
34
51
|
"issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
|
|
35
52
|
"webLink": "https://www.itential.com/adapters/mysql/",
|
|
36
|
-
"vendorLink": "",
|
|
37
|
-
"productLink": "",
|
|
38
|
-
"apiLinks": [
|
|
53
|
+
"vendorLink": "https://www.oracle.com/",
|
|
54
|
+
"productLink": "https://www.mysql.com/",
|
|
55
|
+
"apiLinks": [
|
|
56
|
+
{
|
|
57
|
+
"title": "MySQL SQL Reference",
|
|
58
|
+
"link": "https://dev.mysql.com/doc/refman/8.4/en/sql-statements.html",
|
|
59
|
+
"public": true
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"title": "MySQL Node Library Documentation",
|
|
63
|
+
"link": "https://www.npmjs.com/package/mysql",
|
|
64
|
+
"public": true
|
|
65
|
+
}
|
|
66
|
+
]
|
|
39
67
|
},
|
|
40
68
|
"assets": [],
|
|
41
69
|
"relatedItems": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itentialopensource/adapter-db_mysql",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "Itential adapter to connect to mysql",
|
|
5
5
|
"main": "adapter.js",
|
|
6
6
|
"wizardVersion": "2.44.7",
|
|
@@ -14,7 +14,6 @@
|
|
|
14
14
|
"lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
|
|
15
15
|
"test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
|
|
16
16
|
"test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
|
|
17
|
-
"test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
|
|
18
17
|
"test": "npm run test:unit && npm run test:integration",
|
|
19
18
|
"deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
|
|
20
19
|
"build": "npm run deploy"
|
|
@@ -32,14 +31,15 @@
|
|
|
32
31
|
],
|
|
33
32
|
"license": "Apache-2.0",
|
|
34
33
|
"engines": {
|
|
35
|
-
"node": ">=
|
|
34
|
+
"node": ">=14.0.0",
|
|
35
|
+
"npm": ">=6.0.0"
|
|
36
36
|
},
|
|
37
37
|
"repository": {
|
|
38
38
|
"type": "git",
|
|
39
|
-
"url": "git@gitlab.com:itentialopensource/adapters/
|
|
39
|
+
"url": "git@gitlab.com:itentialopensource/adapters/adapter-db_mysql.git"
|
|
40
40
|
},
|
|
41
41
|
"author": "Itential",
|
|
42
|
-
"homepage": "https://gitlab.com/itentialopensource/adapters/
|
|
42
|
+
"homepage": "https://gitlab.com/itentialopensource/adapters/adapter-db_mysql#readme",
|
|
43
43
|
"dependencies": {
|
|
44
44
|
"ajv": "^8.12.0",
|
|
45
45
|
"fs-extra": "^11.1.1",
|
|
@@ -53,10 +53,9 @@
|
|
|
53
53
|
"eslint-config-airbnb-base": "^15.0.0",
|
|
54
54
|
"eslint-plugin-import": "^2.27.5",
|
|
55
55
|
"eslint-plugin-json": "^3.1.0",
|
|
56
|
-
"mocha": "^
|
|
57
|
-
"nyc": "^15.1.0",
|
|
56
|
+
"mocha": "^10.7.0",
|
|
58
57
|
"testdouble": "^3.18.0",
|
|
59
|
-
"winston": "^3.
|
|
58
|
+
"winston": "^3.13.1"
|
|
60
59
|
},
|
|
61
60
|
"private": false
|
|
62
61
|
}
|
|
Binary file
|