@InterfaceStability.Experimental @InterfaceAudience.Public public interface BinarySubdocMutationRequest extends BinarySubdocRequest
A BinarySubdocRequest
that describes a mutation operation. Mutations work on a fragment()
of the enclosing JSON document, at the site denoted by the BinarySubdocRequest.path()
.
If the path given doesn’t exist in its entirety, some mutation operations can optionally offer to create intermediary nodes in the JSON if valid and createIntermediaryPath()
returns true
.
Note that fragments should always be valid JSON. A sub-document mutation can also alter the enclosing document’s expiry and flags.
Modifier and Type | Method and Description |
---|---|
long |
cas() |
boolean |
createIntermediaryPath()
Sets whether missing nodes in the
BinarySubdocRequest.path() should be created as part of this mutation, when possible. |
int |
expiration() |
ByteBuf |
fragment()
A
ByteBuf containing the JSON fragment for the mutation. |
content, opcode, path, pathLength
key, keyBytes, opaque, partition, partition
bucket, incrementRetryCount, observable, password
creationTime
int expiration()
ByteBuf fragment()
A ByteBuf
containing the JSON fragment for the mutation. It is appended to the BinarySubdocRequest.content()
.
This buffer is to be automatically released once the content has been written on the wire.
boolean createIntermediaryPath()
Sets whether missing nodes in the BinarySubdocRequest.path()
should be created as part of this mutation, when possible. This is represented as an additional flag on the wire.
long cas()
Copyright © 2016 Couchbase, Inc.. All rights reserved.