functionInvoked when an async operation has finished.
13 |Promise
26 |
27 |
28 |
29 | ### new Connection()
30 | This class holds all the extended capabilities added the oracledb connection.
31 |
32 |
33 |
34 | ### Connection.upsert(sqls, bindParams, [options], [callback]) ⇒ Promise
35 | The UPSERT oracledb extension gets 3 SQL statements.Connection](#Connection)
41 | **Returns**: Promise - In case of no callback provided in input and promise is supported, this function will return a promise
42 | **Access**: public
43 |
44 | | Param | Type | Description |
45 | | --- | --- | --- |
46 | | sqls | Object | Holds all required SQLs to support the UPSERT capability |
47 | | sqls.query | String | The SELECT SQL statement |
48 | | sqls.insert | String | The INSERT SQL statement |
49 | | sqls.update | String | The UPDATE SQL statement |
50 | | bindParams | Object | The bind parameters used to specify the values for the columns, used by all execute operations (arrays not supported, only named bind params) |
51 | | [options] | Object | Used by all execute operations |
52 | | [callback] | [AsyncCallback](#AsyncCallback) | Invoked once the UPSERT is done with either an error or the output |
53 |
54 | **Example**
55 | ```js
56 | connection.upsert({
57 | query: 'SELECT ID FROM MY_DATA WHERE ID = :id',
58 | insert: 'INSERT INTO MY_DATA (ID, NAME) VALUES (:id, :name)',
59 | update: 'UPDATE MY_DATA SET NAME = :name WHERE ID = :id'
60 | }, {
61 | id: 110,
62 | name: 'new name'
63 | }, {
64 | autoCommit: false
65 | }, function onUpsert(error, results) {
66 | if (error) {
67 | //handle error...
68 | } else {
69 | console.log('rows affected: ', results.rowsAffected);
70 |
71 | //continue flow...
72 | }
73 | });
74 | ```
75 |
76 |
77 | ## AsyncCallback : function
78 | Invoked when an async operation has finished.
79 |
80 | **Kind**: global typedef
81 |
82 | | Param | Type | Description |
83 | | --- | --- | --- |
84 | | [error] | Error | Any possible error |
85 | | [output] | Object | The operation output |
86 |
87 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # oracledb-upsert
2 |
3 | [](https://www.npmjs.org/package/oracledb-upsert) [](https://github.com/sagiegurari/oracledb-upsert/actions) [](https://coveralls.io/r/sagiegurari/oracledb-upsert) [](https://snyk.io/test/github/sagiegurari/oracledb-upsert) [](http://inch-ci.org/github/sagiegurari/oracledb-upsert) [](https://github.com/sagiegurari/oracledb-upsert/blob/master/LICENSE) [](https://www.npmjs.org/package/oracledb-upsert)
4 |
5 | > UPSERT (insert/update) extension to oracledb.
6 |
7 | * [Overview](#overview)
8 | * [Usage](#usage)
9 | * [Installation](#installation)
10 | * [API Documentation](docs/api.md)
11 | * [Contributing](.github/CONTRIBUTING.md)
12 | * [Release History](#history)
13 | * [License](#license)
14 |
15 |
16 | ## Overview
17 | This library extends the oracledb connection object with a new upsert function to enable to run UPDATE or INSERT based on the
18 | data currently in the DB.
19 |
20 |
21 | ## Usage
22 | In order to use this library, you need to extend the main oracledb object as follows:
23 |
24 | ```js
25 | //load the oracledb library
26 | var oracledb = require('oracledb');
27 |
28 | //load the simple oracledb
29 | var SimpleOracleDB = require('simple-oracledb');
30 |
31 | //modify the original oracledb library
32 | SimpleOracleDB.extend(oracledb);
33 |
34 | //load the extension
35 | require('oracledb-upsert');
36 |
37 | //from this point connections fetched via oracledb.getConnection(...) or pool.getConnection(...)
38 | //have access to the UPSERT function.
39 | oracledb.getConnection(function onConnection(error, connection) {
40 | if (error) {
41 | //handle error
42 | } else {
43 | //work with new capabilities or original oracledb capabilities
44 | connection.upsert({
45 | query: 'SELECT ID FROM MY_DATA WHERE ID = :id',
46 | insert: 'INSERT INTO MY_DATA (ID, NAME) VALUES (:id, :name)',
47 | update: 'UPDATE MY_DATA SET NAME = :name WHERE ID = :id'
48 | }, {
49 | id: 110,
50 | name: 'new name'
51 | }, {
52 | autoCommit: false
53 | }, function onUpsert(error, results) {
54 | if (error) {
55 | //handle error...
56 | } else {
57 | console.log('rows affected: ', results.rowsAffected);
58 |
59 | //continue flow...
60 | }
61 | });
62 | }
63 | });
64 | ```
65 |
66 |
67 |
68 | ### 'connection.upsert(sqls, bindParams, [options], [callback]) ⇒ [Promise]'
69 | The UPSERT oracledb extension gets 3 SQL statements.