Abstract
Abstract
countReturns the number of documents matching the given SodaOperation query criteria. If skip() or limit() are set, then an exception will be thrown.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclasscount
a result object with a count field containing the number of matching documents.
an exception if skip() or limit() are set.
Abstract
fetchSets the size of an internal buffer used for fetching documents from a collection with the terminal SodaOperation methods getCursor() and getDocuments().
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclassfetcharraysize
the SodaOperation object.
the buffer size to use.
Abstract
filterSets a filter specification for the operation, allowing for complex document queries and ordering of JSON documents.
the SodaOperation object.
the filter specification to use.
Abstract
getReturns a SodaDocumentCursor for documents that match the SodaOperation query criteria.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclassgetcursor
a cursor that can be used to iterate over the matched documents.
Abstract
getGets an array of SodaDocuments matching the SodaOperation query criteria.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#-824123-sodaoperationgetdocuments
an array of documents, empty if none match.
Abstract
getObtains one document matching the SodaOperation query criteria. If more than one document is matched, then only the first is returned.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclassgetone
the first matching document, or undefined if none match.
Abstract
keySets the key value to be used to match a document for the operation. Any previous calls made to this method or keys() will be ignored.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclasskey
the SodaOperation object.
the search key to use.
Abstract
keysSets the keys to be used to match multiple documents for the operation. Any previous calls made to this method or key() will be ignored.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclasskeys
the SodaOperation object.
the search keys to use.
Abstract
limitSets the maximum number of documents that a terminal method will apply to.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclasslimit
the SodaOperation object.
the maximum number of documents to return. Must be greater than 0.
Abstract
removeRemoves a set of documents matching the SodaOperation query criteria. If skip() or limit() are set they are ignored.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclassremove
a result object with a count field containing the number of removed documents.
Abstract
replaceReplaces a document in a collection. The input document can be either a JavaScript object representing the data content, or it can be an existing SodaDocument. The key() non-terminal must be used when using replaceOne().
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclassreplaceone
a result object with a boolean replaced field which will be true if the document was replaced successfully and false otherwise.
the new content or SodaDocument.
Abstract
replaceReplaces a document in a collection and return the result document which contains all SodaDocument components except for the content.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclassreplaceoneandget
The updated SodaDocument if replacement was successful, otherwise undefined.
the new content or SodaDocument.
Abstract
skipSets the number of documents that will be skipped before the terminal method is applied. n must be greater than or equal to 0.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationskip
the SodaOperation object.
the number of documents to skip.
Abstract
versionSets the document version that retrieved documents must have.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclassversion
the SodaOperation object.
the version of retrieved documents.
SODA find operation class. This class is used to search and retrieve SODA documents from a SodaCollection. It provides non-terminal search condition operations and terminal SodaDocument retrieval operations.
See
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodaoperationclass