@InterfaceStability.Committed @InterfaceAudience.Public public interface BinarySubdocMutationRequest extends BinarySubdocRequest
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 |
createDocument()
Deprecated.
|
boolean |
createIntermediaryPath()
Sets whether missing nodes in the
BinarySubdocRequest.path() should be created as part of this mutation, when possible. |
boolean |
expandMacros()
Sets whether macros such as ${Mutation.CAS} should be expanded
|
int |
expiration() |
ByteBuf |
fragment()
A
ByteBuf containing the JSON fragment for the mutation. |
boolean |
insertDocument()
Add document only if it does not exist
|
boolean |
upsertDocument()
Upsert document if it does not exist
|
boolean |
xattr()
Access to extended attribute section of the couchbase document
|
content, opcode, path, pathLength
hasSeenNotMyVbucket, key, keyBytes, opaque, partition, partition, sawNotMyVbucket
bucket, complete, dispatchHostname, dispatchHostname, emit, fail, incrementRetryCount, isActive, lastLocalId, lastLocalId, lastLocalSocket, lastLocalSocket, lastRemoteSocket, lastRemoteSocket, maxRetryDuration, maxRetryDuration, observable, operationId, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, span, span, subscriber, succeed, username
creationTime
int expiration()
ByteBuf fragment()
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()
BinarySubdocRequest.path()
should be created as part of this mutation, when possible.
This is represented as an additional flag on the wire.long cas()
boolean xattr()
boolean expandMacros()
@Deprecated boolean createDocument()
upsertDocument()
boolean upsertDocument()
boolean insertDocument()
Copyright © 2021 Couchbase, Inc.. All rights reserved.