ODPI-C Structure dpiSodaOperOptions¶
This structure is used for passing search criteria to a number of SODA
operations. It is initialized using the function
dpiContext_initSodaOperOptions()
and used by the functions
dpiSodaColl_find()
, dpiSodaColl_findOne()
,
dpiSodaColl_getDocCount()
, dpiSodaColl_remove()
and dpiSodaColl_replaceOne()
.
-
uint32_t dpiSodaOperOptions.numKeys¶
Specifies the number of elements in the members
keys
andkeyLengths
.
-
const char **dpiSodaOperOptions.keys¶
Specifies an array of key values which documents in the collection must have in order to be processed by the operation. The length of this array is defined by the member
numKeys
.
-
uint32_t *dpiSodaOperOptions.keyLengths¶
Specifies an array of key length values. Each element corresponds to the length of the key (in bytes) found in the member
keys
at the same element index. The length of this array is defined by the membernumKeys
.
-
const char *dpiSodaOperOptions.key¶
Specifies the key which the document must have in order to be processed by the operation.
-
const char *dpiSodaOperOptions.version¶
Specifies the document version that documents must have in order to be processed by the operation. This is typically used in conjunction with
key
and allows for opportunistic locking, so that operations do not affect a document that someone else has already modified.
-
const char *dpiSodaOperOptions.filter¶
Specifies a filter value which limits the documents processed by the operation. See Overview of SODA Filter Specifications (QBEs).
-
uint32_t dpiSodaOperOptions.skip¶
Specifies the number of documents to skip before processing documents in the collection. A value of 0 will result in no documents being skipped.
-
uint32_t dpiSodaOperOptions.limit¶
Specifies the maximum number of documents to process in the collection. A value of 0 means no limit is enforced.
-
uint32_t dpiSodaOperOptions.fetchArraySize¶
Specifies the number of documents that will be fetched at one time from a SODA collection. Increasing this value reduces the number of round-trips to the database but increases the amount of memory allocated. A value of 0 means that the default value (100) is used. This member is only supported in Oracle Client 19.5 and higher.
-
const char *dpiSodaOperOptions.hint¶
Specifies a hint that will be passed through to the SODA operation. These hints are the same as the hints used for normal SQL operations but without the enclosing comment characters. This member is only supported in Oracle Client 21.3 and higher (also available in Oracle Client 19 from 19.11).