Skip to content

Commit bad3fb3

Browse files
committed
improved README
1 parent 2b81cd6 commit bad3fb3

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ In the Password field please provide a password of the user that has permissions
7373

7474
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.
7575
## Triggers
76-
### SELECT
76+
### Select trigger
7777
You are able to provide SELECT query with last execution timestamp as WHERE clause criteria.
7878
![image](https://user-images.githubusercontent.com/40201204/43591075-2a032dcc-967b-11e8-968d-851355c2646e.png)
7979
Before executing the the statement %%EIO_LAST_POLL%% will be replaced with ISO Date of the last execution or max value of the last pooled datetime, for example ``2018-08-01T00:00:00.000``.
@@ -87,7 +87,7 @@ The format of ``Start Polling From (optional)`` field should be like ``yyyy-mm-d
8787
- ``mi`` - minute
8888
- ``ss`` - second
8989
- ``sss`` - millisecond (optional)
90-
### GET ROWS POLLING
90+
### Get Rows Polling trigger
9191
This trigger can polling data from provided table. As WHERE clause you can use column, which has datatype like DATE or TIMESTAMP.
9292
![image](https://user-images.githubusercontent.com/40201204/43591332-c99f6b3e-967b-11e8-8a77-bf8386e83d51.png)
9393
Before executing the the statement %%EIO_LAST_POLL%% will be replaced with ISO Date of the last execution or max value of the last pooled datetime, for example ``2018-08-01T00:00:00.000``.
@@ -101,8 +101,13 @@ The format of ``Start Polling From (optional)`` field should be like ``yyyy-mm-d
101101
- ``mi`` - minute
102102
- ``ss`` - second
103103
- ``sss`` - millisecond (optional)
104+
105+
### SELECT trigger (Deprecated)
106+
This action exists in JDBC component only for backward compatibility. New [**Select trigger**](#select-trigger) is recommended to use.
107+
108+
104109
## Actions
105-
### SELECT
110+
### Select action
106111
![image](https://user-images.githubusercontent.com/40201204/43592439-39ec5738-967e-11e8-8632-3655b08982d3.png)
107112
The action will execute an [SQL](https://en.wikipedia.org/wiki/SQL "SQL") query that can return multiple results, it has limitations on the query and suited only for SELECT type of queries.
108113
In SQL query you can use clause variables with specific data types.
@@ -141,7 +146,7 @@ Checkbox ``Don't throw Error on an Empty Result`` allows to emit an empty respon
141146
#### Input fields description
142147
Component supports dynamic incoming metadata - as soon as your query is in place it will be parsed and incoming metadata will be generated accordingly.
143148

144-
### LOOKUP BY PRIMARY KEY
149+
### Lookup Row By Primary Key
145150
![image](https://user-images.githubusercontent.com/40201204/43592505-5b6bbfe8-967e-11e8-845e-2ce8ac707357.png)
146151

147152
The action will execute select query from a ``Table`` dropdown field, as criteria can be used only [PRIMARY KEY](https://en.wikipedia.org/wiki/Primary_key "PRIMARY KEY"). The action returns only one result (a primary key is unique).
@@ -150,7 +155,7 @@ Checkbox ``Don't throw Error on an Empty Result`` allows to emit an empty respon
150155
![image](https://user-images.githubusercontent.com/40201204/43644579-f593d1c8-9737-11e8-9b97-ee9e575a19f7.png)
151156
As an input metadata you will get a Primary Key field to provide the data inside as a clause value.
152157

153-
### UPSERT BY PRIMARY KEY
158+
### Upsert Row By Primary Key action
154159
The action will execute ``SELECT`` command from a ``Tables`` dropdown field, as search criteria can be used only [PRIMARY KEY](https://en.wikipedia.org/wiki/Primary_key "PRIMARY KEY"), and execute ``INSERT`` command by PRIMARY KEY with specified field, if result does not found, else - action will execute ``UPDATE`` command by PRIMARY KEY with specified field. The action returns only one result row (a primary key is unique).
155160
1. Find and select jdbc-component in the component repository
156161
![image](https://user-images.githubusercontent.com/16806832/44981615-c70a9d80-af7b-11e8-8055-3b553abe8212.png)
@@ -183,14 +188,17 @@ The action will execute ``SELECT`` command from a ``Tables`` dropdown field, as
183188
As an input metadata you will get all fields of selected table. [PRIMARY KEY](https://en.wikipedia.org/wiki/Primary_key "PRIMARY KEY") is required field (will mark as asterisk) and other input fields are optional.
184189
![image](https://user-images.githubusercontent.com/16806832/44397461-1a76f780-a549-11e8-8247-9a6f9aa3f3b4.png)
185190

186-
### DELETE BY PRIMARY KEY
191+
### Delete Row By Primary Key action
187192
![image](https://user-images.githubusercontent.com/40201204/43592505-5b6bbfe8-967e-11e8-845e-2ce8ac707357.png)
188193
The action will execute delete query from a ``Table`` dropdown field, as criteria can be used only [PRIMARY KEY](https://en.wikipedia.org/wiki/Primary_key "PRIMARY KEY"). The action returns count of affected rows.
189194
Checkbox ``Don't throw Error on an Empty Result`` allows to emit an empty response, otherwise you will get an error on empty response.
190195
#### Input fields description
191196
![image](https://user-images.githubusercontent.com/40201204/43644579-f593d1c8-9737-11e8-9b97-ee9e575a19f7.png)
192197
As an input metadata you will get a Primary Key field to provide the data inside as a clause value.
193198

199+
### Create or update record action (Deprecated)
200+
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.
201+
194202
## Current limitations
195203
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
196204
``, if the selected table doesn't have a primary key. Also, you will see the message ``Composite Primary Key is not supported

0 commit comments

Comments
 (0)