Abstract Abstract metaMetadata for the collection. The metadata will conform to the JSON object layout specified in the Oracle Database "SODA Collection Metadata Components (Reference)" documentation.
Abstract nameName of the collection.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodacollectionproperties
Abstract createCreates an index on a SODA collection to improve the performance of SODA query-by-examples (QBE) or to enable text searches. Different index types can be created as long as the indexSpec parameter conforms to the JSON object layout specified in the Oracle Database "SODA Index Specifications (Reference)" documentation.
an exception if the index creation fails.
index specification, see "SODA Index Specifications (Reference)"
Abstract dropDrops the current collection.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodacolldrop
a DropResult containing a dropped value of true if the drop operation succeeded or false if the collection does not exist.
an exception if the collection drop fails.
Abstract dropDrops the specified index.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodacolldropindex
a DropIndexResult containing a dropped value of true if the drop index operation succeeded or false if the index doesn't exist.
an exception if the index drop fails.
the name of the index to drop
Optional options: IDropIndexOptionsan optional force flag may be specified
Abstract findLocates and orders a set of SODA documents for retrieval, replacement, or removal with non-terminal and terminal methods, see SodaOperation for details.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodacollfind
a SodaOperation object which is used via method chaining
Abstract getInfers the schema of a collection of JSON documents. The data guide is represented as JSON content in a SodaDocument.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodacollgetdataguide
a new SodaDocument containing the inferred schema.
an exception if the schema inference fails.
Abstract insertInserts an array of Objects or SodaDocuments into the collection.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodacollinsertmany
an exception if a document insertion fails. The offset attribute on the Error object will contain the number of documents that were successfully inserted. Subsequent documents in the input array will not be inserted.
an array of Objects or SodaDocuments to be inserted into the collection.
Abstract insertInserts an array of Objects or SodaDocuuments into the collection and returns the documents which contain all SodaDocument components except for content, for performance reasons.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodacollinsertmanyandget
an array of inserted SodaDocuments.
an exception if a document insertion fails. The offset attribute on the Error object will contain the number of documents that were successfully inserted. Subsequent documents in the input array will not be inserted.
an array of Objects or SodaDocuments to be inserted into the collection.
Abstract insertInserts a given document to the collection. The input document can be either a JavaScript object representing the data content, or it can be an existing SodaDocument.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodacollinsertone
an exception if insertion fails.
an Object or SodaDocument to insert into the collection.
Abstract insertInserts a document in a collection and returns the result document that contains all SodaDocument components except for content, for performance reasons.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodacollinsertoneandget
the inserted SodaDocument.
an exception if insertion fails.
the Object or SodaDoc to insert into the collection.
Abstract saveThis method behaves like sodaCollection.insertOne() with the exception that if a document with the same key already exists, then it is updated instead. The collection must use client-assigned keys, which is why save() accepts only a SodaDocument, unlike insertOne(). If the collection is not configured with client-assigned keys, then the behavior is exactly the same as sodaCollection.insertOne().
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#user-content-sodacollsave
the document to save.
Abstract saveThis method behaves like sodaCollection.insertOneAndGet() with the exception that if a document with the same key already exists, then it is updated instead. The collection must use client-assigned keys, which is why saveAndGet() accepts only a SodaDocument, unlike insertOneAndGet(). If the collection is not configured with client-assigned keys, then the behavior is exactly the same as sodaCollection.insertOneAndGet().
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#user-content-sodacollsaveandget
the saved document.
the document to save.
Abstract truncateThis method truncates a collection, removing all documents. The collection will not be deleted.
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#user-content-sodacolltruncate
an exception if truncation fails.
SODA collection class. A SODA collection is a set of SodaDocuments.
See
https://github.com/oracle/node-oracledb/blob/v5.0.0/doc/api.md#sodacollectionclass