Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
simple-oracledb
Advanced tools
simple-oracledb - npm Package Compare versions
Comparing version 0.1.10 to 0.1.11
@@ -8,3 +8,3 @@ 'use strict'; | ||
| index: true, | ||
| private: true | ||
| private: false | ||
| }, | ||
@@ -11,0 +11,0 @@ src: '<%=BuildConfig.libDirectory%>/**/*.js', |
170
docs/api.md
@@ -49,3 +49,2 @@ ## Classes | ||
| * [.simplified](#Connection.simplified) : <code>boolean</code> | ||
| * [#noop()](#Connection+noop) ⇒ <code>undefined</code> ℗ | ||
| * [#execute(sql, [bindParams], [options], callback)](#Connection+execute) | ||
@@ -55,3 +54,2 @@ * [#query(sql, [bindParams], [options], [callback])](#Connection+query) ⇒ <code>[ResultSetReadStream](#ResultSetReadStream)</code> | ||
| * [#update(sql, bindParams, options, callback)](#Connection+update) | ||
| * [#insertOrUpdate(insert, argumentsArray)](#Connection+insertOrUpdate) ℗ | ||
| * [#release([callback])](#Connection+release) | ||
@@ -63,7 +61,3 @@ * [#commit(callback)](#Connection+commit) | ||
| * [#batchUpdate(sql, bindParamsArray, options, callback)](#Connection+batchUpdate) | ||
| * [#batchInsertOrUpdate(insert, sql, bindParamsArray, options, callback)](#Connection+batchInsertOrUpdate) ℗ | ||
| * [#transaction(actions, callback)](#Connection+transaction) | ||
| * [#modifyParams(argumentsArray)](#Connection+modifyParams) ⇒ <code>object</code> ℗ | ||
| * [#createQueryCallback(callback, [options], handleType, [stream])](#Connection+createQueryCallback) ⇒ <code>function</code> ℗ | ||
| * [#createModifyCallback(callback, commit, [output])](#Connection+createModifyCallback) ⇒ <code>function</code> ℗ | ||
| * _static_ | ||
@@ -82,8 +76,2 @@ * [.wrapOnConnection(callback)](#Connection.wrapOnConnection) ⇒ <code>function</code> | ||
| **Access:** public | ||
| <a name="Connection+noop"></a> | ||
| ### Connection#noop() ⇒ <code>undefined</code> ℗ | ||
| Empty function. | ||
| **Returns**: <code>undefined</code> - Empty return | ||
| **Access:** private | ||
| <a name="Connection+execute"></a> | ||
@@ -229,13 +217,2 @@ ### Connection#execute(sql, [bindParams], [options], callback) | ||
| ``` | ||
| <a name="Connection+insertOrUpdate"></a> | ||
| ### Connection#insertOrUpdate(insert, argumentsArray) ℗ | ||
| Internal function which handles both INSERT and UPDATE commands. | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | insert | <code>boolean</code> | True for insert, false for update | | ||
| | argumentsArray | <code>Array</code> | The original arguments array | | ||
| <a name="Connection+release"></a> | ||
@@ -420,18 +397,2 @@ ### Connection#release([callback]) | ||
| ``` | ||
| <a name="Connection+batchInsertOrUpdate"></a> | ||
| ### Connection#batchInsertOrUpdate(insert, sql, bindParamsArray, options, callback) ℗ | ||
| Internal function to run batch INSERT/UPDATE commands. | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | insert | <code>boolean</code> | True for insert, false for update | | ||
| | sql | <code>string</code> | The SQL to execute | | ||
| | bindParamsArray | <code>object</code> | An array of instances of object/Array bind parameters used to specify the values for the columns per row | | ||
| | options | <code>object</code> | Any execute options | | ||
| | [options.autoCommit] | <code>object</code> | If you wish to commit after the insert/update, this property must be set to true in the options (oracledb.autoCommit is not checked) | | ||
| | [options.lobMetaInfo] | <code>object</code> | For LOB support this object must hold a mapping between DB column name and bind variable name | | ||
| | callback | <code>[AsyncCallback](#AsyncCallback)</code> | Invoked with an error or the insert/update results (if LOBs are provided, the callback will be triggered after they have been fully written to the DB) ``` | | ||
| <a name="Connection+transaction"></a> | ||
@@ -478,42 +439,2 @@ ### Connection#transaction(actions, callback) | ||
| ``` | ||
| <a name="Connection+modifyParams"></a> | ||
| ### Connection#modifyParams(argumentsArray) ⇒ <code>object</code> ℗ | ||
| Internal function used to modify the INSERT/UPDATE SQL arguments.<br> | ||
| This function will add the RETURNING clause to the SQL to support LOBs modification after the INSERT/UPDATE finished.<br> | ||
| In addition it will modify the bind variables to specify the OUT bind to enable access to the LOB object. | ||
| **Returns**: <code>object</code> - LOB information used for SQL execution processing | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | argumentsArray | <code>Array</code> | Array of arguments provided in the insert/update functions | | ||
| <a name="Connection+createQueryCallback"></a> | ||
| ### Connection#createQueryCallback(callback, [options], handleType, [stream]) ⇒ <code>function</code> ℗ | ||
| Internal function used to wrap the original callback. | ||
| **Returns**: <code>function</code> - A wrapper callback | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | callback | <code>function</code> | The callback function to invoke | | ||
| | [options] | <code>object</code> | Optional execute options | | ||
| | handleType | <code>number</code> | 1 to split results, 2 to stream results, else default behaviour | | ||
| | [stream] | <code>[ResultSetReadStream](#ResultSetReadStream)</code> | The stream to read the results from (if streamResults=true in options) | | ||
| <a name="Connection+createModifyCallback"></a> | ||
| ### Connection#createModifyCallback(callback, commit, [output]) ⇒ <code>function</code> ℗ | ||
| Internal function used to wrap the original callback. | ||
| **Returns**: <code>function</code> - A wrapper callback | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | callback | <code>function</code> | The callback function to invoke | | ||
| | commit | <code>boolean</code> | True to run commit | | ||
| | [output] | <code>object</code> | Optional output to pass to the callback | | ||
| <a name="Connection.wrapOnConnection"></a> | ||
@@ -552,3 +473,2 @@ ### Connection.wrapOnConnection(callback) ⇒ <code>function</code> | ||
| * [.simplified](#Pool.simplified) : <code>boolean</code> | ||
| * [#noop()](#Pool+noop) ⇒ <code>undefined</code> ℗ | ||
| * [#getConnection(callback)](#Pool+getConnection) | ||
@@ -568,8 +488,2 @@ * [#terminate([callback])](#Pool+terminate) | ||
| **Access:** public | ||
| <a name="Pool+noop"></a> | ||
| ### Pool#noop() ⇒ <code>undefined</code> ℗ | ||
| Empty function. | ||
| **Returns**: <code>undefined</code> - Empty return | ||
| **Access:** private | ||
| <a name="Pool+getConnection"></a> | ||
@@ -638,4 +552,2 @@ ### Pool#getConnection(callback) | ||
| * [new RecordReader()](#new_RecordReader_new) | ||
| * [#getValue(field, callback)](#RecordReader+getValue) ℗ | ||
| * [#createFieldHandler(jsObject, columnName, value)](#RecordReader+createFieldHandler) ⇒ <code>function</code> ℗ | ||
| * [#read(columnNames, row, callback)](#RecordReader+read) | ||
@@ -648,26 +560,2 @@ * [#readJSON(jsRow, column)](#RecordReader+readJSON) ⇒ <code>object</code> | ||
| <a name="RecordReader+getValue"></a> | ||
| ### RecordReader#getValue(field, callback) ℗ | ||
| Returns the value of the field from the row. | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | field | <code>object</code> | The field value | | ||
| | callback | <code>[AsyncCallback](#AsyncCallback)</code> | called when the value is fully read or in case of an error | | ||
| <a name="RecordReader+createFieldHandler"></a> | ||
| ### RecordReader#createFieldHandler(jsObject, columnName, value) ⇒ <code>function</code> ℗ | ||
| Returns a handler function. | ||
| **Returns**: <code>function</code> - The handler function | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | jsObject | <code>object</code> | The result object holder to populate | | ||
| | columnName | <code>string</code> | The field name | | ||
| | value | <code>object</code> | The field value | | ||
| <a name="RecordReader+read"></a> | ||
@@ -741,10 +629,2 @@ ### RecordReader#read(columnNames, row, callback) | ||
| **Author:** Sagie Gur-Ari | ||
| * [ResultSetReadStream](#ResultSetReadStream) | ||
| * [new ResultSetReadStream()](#new_ResultSetReadStream_new) | ||
| * [.nextRow(streamCallback)](#ResultSetReadStream.nextRow(2)) ℗ | ||
| * [.nextRow.set(nextRow)](#ResultSetReadStream.nextRow.set) ℗ | ||
| * [#_read()](#ResultSetReadStream+_read) ℗ | ||
| * [.nextRow(streamCallback)](#ResultSetReadStream.nextRow(1)) ℗ | ||
| <a name="new_ResultSetReadStream_new"></a> | ||
@@ -754,37 +634,2 @@ ### new ResultSetReadStream() | ||
| <a name="ResultSetReadStream.nextRow(2)"></a> | ||
| ### ResultSetReadStream.nextRow(streamCallback) ℗ | ||
| Pushes error event to the stream. | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | streamCallback | <code>function</code> | The callback function | | ||
| <a name="ResultSetReadStream.nextRow.set"></a> | ||
| ### ResultSetReadStream.nextRow.set(nextRow) ℗ | ||
| Sets the nextRow value. | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | nextRow | <code>function</code> | The next row callback function | | ||
| <a name="ResultSetReadStream+_read"></a> | ||
| ### ResultSetReadStream#_read() ℗ | ||
| The stream _read implementation which fetches the next row from the resultset. | ||
| **Access:** private | ||
| <a name="ResultSetReadStream.nextRow(1)"></a> | ||
| ### ResultSetReadStream.nextRow(streamCallback) ℗ | ||
| Reads the next rows from the resultset and pushes via events. | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | streamCallback | <code>function</code> | The callback function | | ||
| <a name="ResultSetReader"></a> | ||
@@ -799,3 +644,2 @@ ## ResultSetReader | ||
| * [#readNextRows(columnNames, resultSet, [options], callback)](#ResultSetReader+readNextRows) | ||
| * [#readAllRows(columnNames, resultSet, options, callback, [jsRowsBuffer])](#ResultSetReader+readAllRows) ℗ | ||
| * [#readFully(columnNames, resultSet, options, callback)](#ResultSetReader+readFully) | ||
@@ -823,16 +667,2 @@ * [#readBulks(columnNames, resultSet, options, callback)](#ResultSetReader+readBulks) | ||
| <a name="ResultSetReader+readAllRows"></a> | ||
| ### ResultSetReader#readAllRows(columnNames, resultSet, options, callback, [jsRowsBuffer]) ℗ | ||
| Reads all data from the provided oracle ResultSet object into the provided buffer. | ||
| **Access:** private | ||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | columnNames | <code>Array</code> | Array of strings holding the column names of the results | | ||
| | resultSet | <code>Array</code> | The oracle ResultSet object | | ||
| | options | <code>object</code> | Any options | | ||
| | callback | <code>[AsyncCallback](#AsyncCallback)</code> | called when all rows are fully read or in case of an error | | ||
| | [jsRowsBuffer] | <code>Array</code> | The result buffer, if not provided, the callback will be called for each bulk | | ||
| <a name="ResultSetReader+readFully"></a> | ||
@@ -839,0 +669,0 @@ ### ResultSetReader#readFully(columnNames, resultSet, options, callback) |
| { | ||
| "name": "simple-oracledb", | ||
| "version": "0.1.10", | ||
| "version": "0.1.11", | ||
| "description": "Extend capabilities of oracledb with simplified API for quicker development.", | ||
@@ -5,0 +5,0 @@ "author": { |
@@ -459,3 +459,3 @@ # simple-oracledb | ||
| | ----------- | ------- | ----------- | | ||
| | 2016-01-12 | v0.1.10 | Maintenance | | ||
| | 2016-01-13 | v0.1.11 | Maintenance | | ||
| | 2016-01-12 | v0.1.8 | Avoid issues with oracledb stream option which is based on this library | | ||
@@ -462,0 +462,0 @@ | 2016-01-07 | v0.1.7 | connection.query with streamResults=true returns a readable stream | |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-1.9%
400981
No dependency changes