You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-13Lines changed: 17 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
# JDBC-component
2
+
2
3
## Description
3
4
This is an open source component for working with object-relational database management systems on [elastic.io platform](http://www.elastic.io"elastic.io platform").
4
5
@@ -27,8 +28,9 @@ Following actions are inside:
27
28
28
29
### Requirements
29
30
Before you can deploy any code into elastic.io **you must be a registered elastic.io platform user**. Please see our home page at [http://www.elastic.io](http://www.elastic.io) to learn how.
31
+
30
32
#### Environment variables
31
-
For unit-testing is needed to specify following environment variables:
33
+
For integration-testing is needed to specify following environment variables:
32
34
1. Connection to MSSQL:
33
35
-``CONN_USER_MSSQL`` - user login
34
36
-``CONN_PASSWORD_MSSQL`` - user password
@@ -55,29 +57,31 @@ For unit-testing is needed to specify following environment variables:
55
57
-``CONN_PORT_POSTGRESQL`` - DataBase port
56
58
#### Others
57
59
## Credentials
58
-
You may use following properties to configure a connection:
You can add the authorisation methods during the integration flow design or by going to your Settings > Security credentials > REST client and adding there.
60
+
You need to use following properties to configure credentials:
61
+
61
62
### DB Engine
62
-
You are able to choose one of existing database types:
In the Connection URI field please provide hostname of the server, e.g. ``acme.com``
67
+
Provide hostname of the server, e.g. ``acme.com``
67
68
### Connection port
68
-
In the Connection port field please provide port of the server instance, as by default:
69
+
Optional field. Provide port of the server instance, as by default:
69
70
-``3306`` - MySQL
70
71
-``5432`` - PostgreSQL
71
72
-``1521`` - Oracle
72
73
-``1433`` - MSSQL
73
74
### Database Name
74
-
In the Database Name field please provide name of database at the instance that you want to interact with.
75
+
Provide name of database at the instance that you want to interact with.
75
76
### User
76
-
In the User field please provide a username that has permissions to interact with the Database.
77
+
Provide a username that has permissions to interact with the Database.
77
78
### Password
78
-
In the Password field please provide a password of the user that has permissions to interact with the Database.
79
+
Provide a password of the user that has permissions to interact with the Database.
80
+
### Configuration properties
81
+
Optional field. Provide a configuration properties for connections to the Database, e.g. ``useUnicode=true&serverTimezone=UTC``
82
+
83
+
**Limitation:**`Configuration properties` value may not be checked during Credentials Verifacation, so in case of using this field make sure that it contains correct input.
79
84
80
-
Validation will start right after click on a Save button. You will be able to continue working with component after validation if all provided credentials will be valid.
81
85
## Triggers
82
86
### Select trigger
83
87
You are able to provide SELECT query with last execution timestamp as WHERE clause criteria.
@@ -113,7 +117,6 @@ The format of ``Start Polling From (optional)`` field should be like ``yyyy-mm-d
113
117
### SELECT trigger (Deprecated)
114
118
This action exists in JDBC component only for backward compatibility. New [**Select trigger**](#select-trigger) is recommended to use.
@@ -248,7 +251,8 @@ Component generates next metadata:
248
251
249
252
250
253
### Create or update record action (Deprecated)
251
-
This action exists in JDBC component only for backward compatibility. [**Upsert row by primary key**](#upsert-row-by-primary-key-action) Action is recommended to use.
254
+
This action exists in JDBC component only for backward compatibility.
255
+
Please use [**Upsert row by primary key**](#upsert-row-by-primary-key-action) instead.
252
256
253
257
## Current limitations
254
258
1. Only tables with one [PRIMARY KEY](https://en.wikipedia.org/wiki/Primary_key"PRIMARY KEY") is supported. You will see the message ``Table has not Primary Key. Should be one Primary Key
0 commit comments