dnrops
/
node-oracledb
mirror of https://github.com/oracle/node-oracledb
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SODA can be used with Oracle Client 18.5 or 19.3

This commit is contained in:
Christopher Jones 2019-05-07 14:46:36 +10:00 committed by Christopher Jones
parent 69341bf0ff
commit 29d4b92650
2 changed files with 62 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
CHANGELOG.md
View File

@ -29,11 +29,6 @@
- CQN support and message type constants were added for database - CQN support and message type constants were added for database
startup and shutdown events. startup and shutdown events.
- Added SODA bulk insert methods
[`sodaCollection.insertMany()`](https://oracle.github.io/node-oracledb/doc/api.html#sodacollinsertmany)
and
[`sodaCollection.insertManyAndGet()`](https://oracle.github.io/node-oracledb/doc/api.html#sodacollinsertmanyandget).
- Added a `connection.currentSchema` attribute for setting the schema - Added a `connection.currentSchema` attribute for setting the schema
qualifier to be used when a qualifier is omitted in SQL statements. qualifier to be used when a qualifier is omitted in SQL statements.
This is an efficient alternative to `ALTER SESSION SET This is an efficient alternative to `ALTER SESSION SET
@ -52,19 +47,10 @@
- Fixed a crash occuring when draining the connection pool ([ODPI-C - Fixed a crash occuring when draining the connection pool ([ODPI-C
change](https://github.com/oracle/odpi/commit/https://github.com/oracle/odpi/commit/7666dc3208087383f7f0f5e49c1ee423cb154997)) change](https://github.com/oracle/odpi/commit/https://github.com/oracle/odpi/commit/7666dc3208087383f7f0f5e49c1ee423cb154997))
- Corrected processing of the `force` option in SODA `dropIndex()`.
- Corrected the type of
[`sodaCollection.metaData`](https://oracle.github.io/node-oracledb/doc/api.html#sodacollectionpropmetadata).
It is now an Object, as was documented.
- Corrected `pool.status` to be read-only, as was documented. - Corrected `pool.status` to be read-only, as was documented.
- Error handling changes: - Error handling changes:
- Corrected the error message parameter number for SODA
`getCollectionNames()`.
- Corrected the error message returned when invalid types are used for - Corrected the error message returned when invalid types are used for
boolean options. boolean options.
@ -78,6 +64,28 @@
- The NJS-014 error when setting a read-only property was replaced - The NJS-014 error when setting a read-only property was replaced
with a standard JavaScript message. with a standard JavaScript message.
- SODA changes:
- Added SODA bulk insert methods
[`sodaCollection.insertMany()`](https://oracle.github.io/node-oracledb/doc/api.html#sodacollinsertmany)
and
[`sodaCollection.insertManyAndGet()`](https://oracle.github.io/node-oracledb/doc/api.html#sodacollinsertmanyandget).
- Document that the general SODA API is out of Preview status when
using Oracle Client 18.5 or Oracle Client 19.3, or later. The
new node-oracledb 4.0 methods `sodaCollection.insertMany()` and
`sodaCollection.insertManyAndGet()` are in Preview status and
should not be used in production
- Corrected the type of
[`sodaCollection.metaData`](https://oracle.github.io/node-oracledb/doc/api.html#sodacollectionpropmetadata).
It is now an Object, as was documented.
- Corrected processing of the `force` option in SODA [`sodaCollection.dropIndex()`](https://oracle.github.io/node-oracledb/doc/api.html#sodacolldropindex).
- Corrected the error message parameter number for SODA
[`sodaDatabase.getCollectionNames()`](https://oracle.github.io/node-oracledb/doc/api.html#sodadbgetcollectionnames).
- Updated documentation. - Updated documentation.
- Added new tests. - Added new tests.

66
doc/api.md
View File

@ -529,11 +529,12 @@ With Oracle's sample HR schema, the output is:
#### <a name="examplesodaawait"></a> 1.1.2 Example: Simple Oracle Document Access (SODA) in Node.js #### <a name="examplesodaawait"></a> 1.1.2 Example: Simple Oracle Document Access (SODA) in Node.js
Oracle Database 18c users who have been granted the SODA_APP role can Oracle Database 18c or 19c users who have been granted the SODA_APP
use [node-oracledb's SODA API](#sodaoverview) to store content such role can use [node-oracledb's SODA API](#sodaoverview) to store
as JSON. SODA support in node-oracledb is in Preview status and content such as JSON.
should not be used in production. It will be supported with a future
version of Oracle Client libraries. SODA can be used with Oracle Client 18.5 and Oracle Client 19.3, or
later.
```javascript ```javascript
// mysoda.js // mysoda.js
@ -3323,9 +3324,11 @@ This synchronous method returns a [SodaDatabase](#sodadatabaseclass).
Returns a parent SodaDatabase object for use with Simple Oracle Returns a parent SodaDatabase object for use with Simple Oracle
Document Access (SODA). Document Access (SODA).
SODA support in node-oracledb is in Preview status and should not be SODA can be used with Oracle Client 18.5 and Oracle Client 19.3, or
used in production. It will be supported with a future version of later. The SODA bulk insert methods
Oracle Client libraries. [`sodaCollection.insertMany()`](#sodacollinsertmany) and
[`sodaCollection.insertManyAndGet()`](#sodacollinsertmanyandget)
remain in Preview status.
See [Simple Oracle Document Access (SODA)](#sodaoverview) for more See [Simple Oracle Document Access (SODA)](#sodaoverview) for more
information about using SODA in node-oracledb. information about using SODA in node-oracledb.
@ -4649,9 +4652,11 @@ for Node.js version 8 Stream `destroy()` method was added in node-oracledb 2.1.
## <a name="sodacollectionclass"></a> 9. SodaCollection Class ## <a name="sodacollectionclass"></a> 9. SodaCollection Class
SODA support in node-oracledb is in Preview status and should not be SODA can be used with Oracle Client 18.5 and Oracle Client 19.3, or
used in production. It will be supported with a future version of later. The SODA bulk insert methods
Oracle Client libraries. [`sodaCollection.insertMany()`](#sodacollinsertmany) and
[`sodaCollection.insertManyAndGet()`](#sodacollinsertmanyandget)
remain in Preview status.
#### <a name="sodacollectionproperties"></a> 9.1 SodaCollection Properties #### <a name="sodacollectionproperties"></a> 9.1 SodaCollection Properties
@ -5516,6 +5521,8 @@ objects](#errorobj) will contain the number of documents that were
successfully inserted. Subsequent documents in the input array will successfully inserted. Subsequent documents in the input array will
not be inserted. not be inserted.
This method is in Preview status and should not be used in production.
This method was added in node-oracledb 4.0. It requires Oracle Client 18.5 or higher. This method was added in node-oracledb 4.0. It requires Oracle Client 18.5 or higher.
#### <a name="sodacollinsertmanyandget"></a> 9.2.7 `sodaCollection.insertManyAndGet()` #### <a name="sodacollinsertmanyandget"></a> 9.2.7 `sodaCollection.insertManyAndGet()`
@ -5540,6 +5547,8 @@ properties, such as the keys (in default collections), can be found.
When inserting multiple documents, using `insertManyAndGet()` is When inserting multiple documents, using `insertManyAndGet()` is
recommended in preference to `insertOneAndGet()`. recommended in preference to `insertOneAndGet()`.
This method is in Preview status and should not be used in production.
This method was added in node-oracledb 4.0. It requires Oracle Client 18.5 or higher. This method was added in node-oracledb 4.0. It requires Oracle Client 18.5 or higher.
#### <a name="sodacollinsertone"></a> 9.2.8 `sodaCollection.insertOne()` #### <a name="sodacollinsertone"></a> 9.2.8 `sodaCollection.insertOne()`
@ -5702,15 +5711,17 @@ Callback function parameter | Description
## <a name="sodadatabaseclass"></a> 10. SodaDatabase Class ## <a name="sodadatabaseclass"></a> 10. SodaDatabase Class
SODA support in node-oracledb is in Preview status and should not be
used in production. It will be supported with a future version of
Oracle Client libraries.
The SodaDatabase class is the top level object for node-oracledb SODA The SodaDatabase class is the top level object for node-oracledb SODA
operations. A 'SODA database' is an abstraction, allowing access to operations. A 'SODA database' is an abstraction, allowing access to
SODA collections in that 'SODA database', which then allow access to SODA collections in that 'SODA database', which then allow access to
documents in those collections. documents in those collections.
SODA can be used with Oracle Client 18.5 and Oracle Client 19.3, or
later. The SODA bulk insert methods
[`sodaCollection.insertMany()`](#sodacollinsertmany) and
[`sodaCollection.insertManyAndGet()`](#sodacollinsertmanyandget)
remain in Preview status.
A SODA database is equivalent to an Oracle Database user, see A SODA database is equivalent to an Oracle Database user, see
[Overview of SODA][117] in the Introduction to SODA manual. [Overview of SODA][117] in the Introduction to SODA manual.
@ -6012,13 +6023,15 @@ Callback function parameter | Description
## <a name="sodadocumentclass"></a> 11. SodaDocument Class ## <a name="sodadocumentclass"></a> 11. SodaDocument Class
Note SODA support in node-oracledb is in Preview status and should not
be used in production. It will be supported with a future version of
Oracle Client libraries.
SodaDocuments represents the document for SODA read and write SodaDocuments represents the document for SODA read and write
operations. operations.
SODA can be used with Oracle Client 18.5 and Oracle Client 19.3, or
later. The SODA bulk insert methods
[`sodaCollection.insertMany()`](#sodacollinsertmany) and
[`sodaCollection.insertManyAndGet()`](#sodacollinsertmanyandget)
remain in Preview status.
SodaDocument objects can be created in three ways: SodaDocument objects can be created in three ways:
- The result of - The result of
@ -11970,14 +11983,15 @@ that connection.
## <a name="sodaoverview"></a> 27. Simple Oracle Document Access (SODA) ## <a name="sodaoverview"></a> 27. Simple Oracle Document Access (SODA)
Oracle Database Simple Oracle Document Access (SODA) access is Oracle Database Simple Oracle Document Access (SODA) access is
available in node-oracledb version 3 through a set of NoSQL-style available in node-oracledb through a set of NoSQL-style APIs.
APIs. Documents can be inserted, queried, and retrieved from Oracle Documents can be inserted, queried, and retrieved from Oracle Database
Database using node-oracledb methods. By default, documents are JSON using node-oracledb methods. By default, documents are JSON strings.
strings.
SODA support in node-oracledb is in Preview status and should not be SODA can be used with Oracle Client 18.5 and Oracle Client 19.3, or
used in production. It will be supported with a future version of later. The SODA bulk insert methods
Oracle Client libraries. [`sodaCollection.insertMany()`](#sodacollinsertmany) and
[`sodaCollection.insertManyAndGet()`](#sodacollinsertmanyandget)
remain in Preview status.
The [Oracle Database Introduction to SODA][103] manual contains much The [Oracle Database Introduction to SODA][103] manual contains much
information relevant to using SODA. You can use Oracle SODA information relevant to using SODA. You can use Oracle SODA