oracle 0.3.3

Oracle binding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

.. _dpiSodaOperOptions:

ODPI-C Structure dpiSodaOperOptions
-----------------------------------

This structure is used for passing search criteria to a number of SODA
operations. It is initialized using the function
:func:`dpiContext_initSodaOperOptions()` and used by the functions
:func:`dpiSodaColl_find()`, :func:`dpiSodaColl_findOne()`,
:func:`dpiSodaColl_getDocCount()`, :func:`dpiSodaColl_remove()`
and :func:`dpiSodaColl_replaceOne()`.

.. member:: uint32_t dpiSodaOperOptions.numKeys

    Specifies the number of elements in the members
    :member:`~dpiSodaOperOptions.keys` and
    :member:`~dpiSodaOperOptions.keyLengths`.

.. member:: 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 :member:`~dpiSodaOperOptions.numKeys`.

.. member:: 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
    :member:`~dpiSodaOperOptions.keys` at the same element index. The length of
    this array is defined by the member :member:`~dpiSodaOperOptions.numKeys`.

.. member:: const char \*dpiSodaOperOptions.key

    Specifies the key which the document must have in order to be processed by
    the operation.

.. member:: uint32_t dpiSodaOperOptions.keyLength

    Specifies the length of the member :member:`~dpiSodaOperOptions.key`, in
    bytes.

.. member:: 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
    :member:`~dpiSodaOperOptions.key` and allows for opportunistic locking,
    so that operations do not affect a document that someone else has already
    modified.

.. member:: uint32_t dpiSodaOperOptions.versionLength

    Specifies the length of the member :member:`~dpiSodaOperOptions.version`,
    in bytes.

.. member:: const char \*dpiSodaOperOptions.filter

    Specifies a filter value which limits the documents processed by the
    operation. See `Overview of SODA Filter Specifications (QBEs)
    <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&
    id=GUID-CB09C4E3-BBB1-40DC-88A8-8417821B0FBE>`__.

.. member:: uint32_t dpiSodaOperOptions.filterLength

    Specifies the length of the member :member:`~dpiSodaOperOptions.filter`,
    in bytes.

.. member:: 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.

.. member:: uint32_t dpiSodaOperOptions.limit

    Specifies the maximum number of documents to process in the collection. A
    value of 0 means no limit is enforced.