Class: Libcouchbase::Ext::CMDSUBDOC
- Inherits:
-
FFI::Struct
- Object
- FFI::Struct
- Libcouchbase::Ext::CMDSUBDOC
- Defined in:
- lib/libcouchbase/ext/libcouchbase/cmdsubdoc.rb
Overview
(Not documented)
## Fields:
- :cmdflags
-
(Integer)
- :exptime
-
(Integer)
- :cas
-
(Integer)
- :key
-
(KEYBUF)
- :hashkey
-
(KEYBUF)
- :specs
-
(SDSPEC) An array of one or more command specifications. The storage for the array need only persist for the duration of the lcb_subdoc3() call.
The specs array must be valid only through the invocation of lcb_subdoc3(). As such, they can reside on the stack and be re-used for scheduling multiple commands. See subdoc-simple.cc
- :nspecs
-
(Integer) Number of entries in #specs
- :error_index
-
(FFI::Pointer(*Int)) If the scheduling of the command failed, the index of the entry which caused the failure will be written to this pointer.
If the value is -1 then the failure took place at the command level and not at the spec level.
- :multimode
-
(Integer) Operation mode to use. This can either be @ref LCB_SDMULTI_MODE_LOOKUP or @ref LCB_SDMULTI_MODE_MUTATE.
This field may be left empty, in which case the mode is implicitly derived from the first command issued.
Constant Summary collapse
- UPSERT_DOC =
CMD flags
(1<<16)
- INSERT_DOC =
document must be created anew. Fail if it exists
(1<<17)
- ACCESS_DELETED =
Access a potentially deleted document.
(1<<18)
- SDMULTI_MODE_INVALID =
0
- SDMULTI_MODE_LOOKUP =
1
- SDMULTI_MODE_MUTATE =
2