@InterfaceStability.Committed
@InterfaceAudience.Public
public interface AsyncBucket
Defines operations that can be executed asynchronously against a Couchbase Server bucket.
Note that only a subset of the provided operations are available for “memcached” type buckets. Also, some other operations are only available against specific versions of Couchbase Server.
Always apply a Observable.timeout(long, TimeUnit) of some form to add a boundary between the SDK as an integration point and the application. Networks are unreliable, servers can fail and the SDK contains bugs. With applying a timeout and reacting to them accordingly, application level code is less likely to fail.
| Modifier and Type | Method and Description |
|---|---|
<D extends Document<?>> |
append(D document)
Append a
Document to another one. |
rx.Observable<AsyncBucketManager> |
bucketManager()
Provides access to the
AsyncBucketManager for administrative access. |
rx.Observable<java.lang.Boolean> |
close()
Closes the
AsyncBucket. |
rx.Observable<JsonLongDocument> |
counter(java.lang.String id,
long delta)
Increment or decrement a counter with the given value and a default value of 0.
|
rx.Observable<JsonLongDocument> |
counter(java.lang.String id,
long delta,
long initial)
Increment or decrement a counter with the given value and a initial value if it does not exist.
|
rx.Observable<JsonLongDocument> |
counter(java.lang.String id,
long delta,
long initial,
int expiry)
Increment or decrement a counter with the given value and a initial value if it does not exist.
|
<D extends Document<?>> |
get(D document)
Retrieves any type of
Document by its unique ID. |
rx.Observable<JsonDocument> |
get(java.lang.String id)
Retrieves a
JsonDocument by its unique ID. |
<D extends Document<?>> |
get(java.lang.String id,
java.lang.Class<D> target)
Retrieves any type of
Document by its unique ID. |
<D extends Document<?>> |
getAndLock(D document,
int lockTime)
Retrieve and lock a
Document by its unique ID. |
rx.Observable<JsonDocument> |
getAndLock(java.lang.String id,
int lockTime)
Retrieve and lock a
JsonDocument by its unique ID. |
<D extends Document<?>> |
getAndLock(java.lang.String id,
int lockTime,
java.lang.Class<D> target)
Retrieve and lock a
Document by its unique ID. |
<D extends Document<?>> |
getAndTouch(D document)
Retrieve and touch a
Document by its unique ID. |
rx.Observable<JsonDocument> |
getAndTouch(java.lang.String id,
int expiry)
Retrieve and touch a
JsonDocument by its unique ID. |
<D extends Document<?>> |
getAndTouch(java.lang.String id,
int expiry,
java.lang.Class<D> target)
Retrieve and touch a
Document by its unique ID. |
<D extends Document<?>> |
getFromReplica(D document,
ReplicaMode type)
Retrieves one or more, possibly stale, representations of a
Document by its unique ID. |
rx.Observable<JsonDocument> |
getFromReplica(java.lang.String id,
ReplicaMode type)
Retrieves one or more, possibly stale, representations of a
JsonDocument by its unique ID. |
<D extends Document<?>> |
getFromReplica(java.lang.String id,
ReplicaMode type,
java.lang.Class<D> target)
Retrieves one or more, possibly stale, representations of a
Document by its unique ID. |
<D extends Document<?>> |
insert(D document)
Insert a
Document if it does not exist already. |
<D extends Document<?>> |
insert(D document,
PersistTo persistTo)
Insert a
Document if it does not exist already and watch for durability constraints. |
<D extends Document<?>> |
insert(D document,
PersistTo persistTo,
ReplicateTo replicateTo)
Insert a
Document if it does not exist already and watch for durability constraints. |
<D extends Document<?>> |
insert(D document,
ReplicateTo replicateTo)
Insert a
Document if it does not exist already and watch for durability constraints. |
java.lang.String |
name()
The name of the
Bucket. |
<D extends Document<?>> |
prepend(D document)
Prepend a
Document to another one. |
rx.Observable<AsyncQueryResult> |
query(Query query)
Experimental: Queries a N1QL secondary index.
|
rx.Observable<AsyncQueryResult> |
query(java.lang.String query)
Experimental: Queries a N1QL secondary index.
|
rx.Observable<AsyncViewResult> |
query(ViewQuery query)
Queries a Couchbase Server
View. |
<D extends Document<?>> |
remove(D document)
Removes a
Document from the Server. |
<D extends Document<?>> |
remove(D document,
PersistTo persistTo)
Removes a
Document from the Server and apply a durability requirement. |
<D extends Document<?>> |
remove(D document,
PersistTo persistTo,
ReplicateTo replicateTo)
Removes a
Document from the Server and apply a durability requirement. |
<D extends Document<?>> |
remove(D document,
ReplicateTo replicateTo)
Removes a
Document from the Server and apply a durability requirement. |
rx.Observable<JsonDocument> |
remove(java.lang.String id)
Removes a
Document from the Server identified by its ID. |
<D extends Document<?>> |
remove(java.lang.String id,
java.lang.Class<D> target)
Removes a
Document from the Server identified by its ID. |
rx.Observable<JsonDocument> |
remove(java.lang.String id,
PersistTo persistTo)
Removes a
Document from the Server by its ID and apply a durability requirement. |
<D extends Document<?>> |
remove(java.lang.String id,
PersistTo persistTo,
java.lang.Class<D> target)
Removes a
Document from the Server by its ID and apply a durability requirement. |
rx.Observable<JsonDocument> |
remove(java.lang.String id,
PersistTo persistTo,
ReplicateTo replicateTo)
Removes a
Document from the Server by its ID and apply a durability requirement. |
<D extends Document<?>> |
remove(java.lang.String id,
PersistTo persistTo,
ReplicateTo replicateTo,
java.lang.Class<D> target)
Removes a
Document from the Server by its ID and apply a durability requirement. |
rx.Observable<JsonDocument> |
remove(java.lang.String id,
ReplicateTo replicateTo)
Removes a
Document from the Server by its ID and apply a durability requirement. |
<D extends Document<?>> |
remove(java.lang.String id,
ReplicateTo replicateTo,
java.lang.Class<D> target)
Removes a
Document from the Server by its ID and apply a durability requirement. |
<D extends Document<?>> |
replace(D document)
Replace a
Document if it does already exist. |
<D extends Document<?>> |
replace(D document,
PersistTo persistTo)
Replace a
Document if it does exist and watch for durability constraints. |
<D extends Document<?>> |
replace(D document,
PersistTo persistTo,
ReplicateTo replicateTo)
Replace a
Document if it does exist and watch for durability constraints. |
<D extends Document<?>> |
replace(D document,
ReplicateTo replicateTo)
Replace a
Document if it does exist and watch for durability constraints. |
<D extends Document<?>> |
touch(D document)
Renews the expiration time of a
Document. |
rx.Observable<java.lang.Boolean> |
touch(java.lang.String id,
int expiry)
Renews the expiration time of a
Document. |
<D extends Document<?>> |
unlock(D document)
Unlocks a write-locked
Document. |
rx.Observable<java.lang.Boolean> |
unlock(java.lang.String id,
long cas)
Unlocks a write-locked
Document. |
<D extends Document<?>> |
upsert(D document)
Insert or replace a
Document. |
<D extends Document<?>> |
upsert(D document,
PersistTo persistTo)
Insert or replace a
Document and watch for durability constraints. |
<D extends Document<?>> |
upsert(D document,
PersistTo persistTo,
ReplicateTo replicateTo)
Insert or replace a
Document and watch for durability constraints. |
<D extends Document<?>> |
upsert(D document,
ReplicateTo replicateTo)
Insert or replace a
Document and watch for durability constraints. |
java.lang.String name()
The name of the Bucket.
rx.Observable<JsonDocument> get(java.lang.String id)
Retrieves a JsonDocument by its unique ID.
If the document is found, a JsonDocument is returned. If the document is not found, the Observable completes without an item emitted.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - the unique ID of the document.Observable eventually containing the found JsonDocument.<D extends Document<?>> rx.Observable<D> get(D document)
Retrieves any type of Document by its unique ID.
The document ID is taken out of the Document provided, as well as the target type to return. Note that not the same document is returned, but rather a new one of the same type with the freshly loaded properties.
If the document is found, a Document is returned. If the document is not found, the Observable completes without an item emitted.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptiondocument - the source document from which the ID is taken and the type is inferred.Observable eventually containing the found Document.<D extends Document<?>> rx.Observable<D> get(java.lang.String id, java.lang.Class<D> target)
Retrieves any type of Document by its unique ID.
This method differs from get(String) in that if a specific Document type is passed in, the appropriate Transcoder will be selected (and not JSON conversion).
If the document is found, a Document is returned. If the document is not found, the Observable completes without an item emitted.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - the unique ID of the document.target - the target document type to use.Observable eventually containing the found Document.rx.Observable<JsonDocument> getFromReplica(java.lang.String id, ReplicaMode type)
Retrieves one or more, possibly stale, representations of a JsonDocument by its unique ID.
Depending on the ReplicaMode selected, there can be none to four JsonDocument be returned from the Observable. If ReplicaMode.FIRST, ReplicaMode.SECOND or ReplicaMode.THIRD are selected zero or one documents are returned, if ReplicaMode.ALL is used, all configured replicas plus the master node may return a document.
If the document has not been replicated yet or if the replica or master are not available (because a node has been failed over), no response is expected from these nodes.
Since data is replicated asynchronously, all data returned from this method must be considered stale. If the appropriate ReplicateTo constraints are set on write and the operation returns successfully, then the data can be considered as non-stale.
Note that the returning JsonDocument responses can come in any order.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - id the unique ID of the document.type - the ReplicaMode to select.Observable eventually containing zero to N JsonDocuments.<D extends Document<?>> rx.Observable<D> getFromReplica(D document, ReplicaMode type)
Retrieves one or more, possibly stale, representations of a Document by its unique ID.
The document ID is taken out of the Document provided, as well as the target type to return. Note that not the same document is returned, but rather a new one of the same type with the freshly loaded properties.
Depending on the ReplicaMode selected, there can be none to four Document be returned from the Observable. If ReplicaMode.FIRST, ReplicaMode.SECOND or ReplicaMode.THIRD are selected zero or one documents are returned, if ReplicaMode.ALL is used, all configured replicas plus the master node may return a document.
If the document has not been replicated yet or if the replica or master are not available (because a node has been failed over), no response is expected from these nodes.
Since data is replicated asynchronously, all data returned from this method must be considered stale. If the appropriate ReplicateTo constraints are set on write and the operation returns successfully, then the data can be considered as non-stale.
Note that the returning Document responses can come in any order.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptiondocument - the source document from which the ID is taken and the type is inferred.type - the ReplicaMode to select.Observable eventually containing zero to N Documents.<D extends Document<?>> rx.Observable<D> getFromReplica(java.lang.String id, ReplicaMode type, java.lang.Class<D> target)
Retrieves one or more, possibly stale, representations of a Document by its unique ID.
This method differs from getFromReplica(String, ReplicaMode) in that if a specific Document type is passed in, the appropriate Transcoder will be selected (and not JSON conversion).
Depending on the ReplicaMode selected, there can be none to four Document be returned from the Observable. If ReplicaMode.FIRST, ReplicaMode.SECOND or ReplicaMode.THIRD are selected zero or one documents are returned, if ReplicaMode.ALL is used, all configured replicas plus the master node may return a document.
If the document has not been replicated yet or if the replica or master are not available (because a node has been failed over), no response is expected from these nodes.
Since data is replicated asynchronously, all data returned from this method must be considered stale. If the appropriate ReplicateTo constraints are set on write and the operation returns successfully, then the data can be considered as non-stale.
Note that the returning Document responses can come in any order.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - id the unique ID of the document.type - the ReplicaMode to select.target - the target document type to use.Observable eventually containing zero to N Documents.rx.Observable<JsonDocument> getAndLock(java.lang.String id, int lockTime)
Retrieve and lock a JsonDocument by its unique ID.
If the document is found, a JsonDocument is returned. If the document is not found, the Observable completes without an item emitted.
This method works similar to get(String), but in addition it (write) locks the document for the given lock time interval. Note that this lock time is hard capped to 30 seconds, even if provided with a higher value and is not configurable. The document will unlock afterwards automatically.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - id the unique ID of the document.lockTime - the time to write lock the document (max. 30 seconds).Observable eventually containing the found JsonDocument.<D extends Document<?>> rx.Observable<D> getAndLock(D document, int lockTime)
Retrieve and lock a Document by its unique ID.
If the document is found, a Document is returned. If the document is not found, the Observable completes without an item emitted.
This method works similar to get(Document), but in addition it (write) locks the document for the given lock time interval. Note that this lock time is hard capped to 30 seconds, even if provided with a higher value and is not configurable. The document will unlock afterwards automatically.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptiondocument - the source document from which the ID is taken and the type is inferred.lockTime - the time to write lock the document (max. 30 seconds).Observable eventually containing the found Document.<D extends Document<?>> rx.Observable<D> getAndLock(java.lang.String id, int lockTime, java.lang.Class<D> target)
Retrieve and lock a Document by its unique ID.
This method differs from getAndLock(String, int) in that if a specific Document type is passed in, the appropriate Transcoder will be selected (and not JSON conversion).
If the document is found, a Document is returned. If the document is not found, the Observable completes without an item emitted.
This method works similar to get(String), but in addition it (write) locks the document for the given lock time interval. Note that this lock time is hard capped to 30 seconds, even if provided with a higher value and is not configurable. The document will unlock afterwards automatically.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - id the unique ID of the document.lockTime - the time to write lock the document (max. 30 seconds).target - the target document type to use.Observable eventually containing the found Document.rx.Observable<JsonDocument> getAndTouch(java.lang.String id, int expiry)
Retrieve and touch a JsonDocument by its unique ID.
If the document is found, a JsonDocument is returned. If the document is not found, the Observable completes without an item emitted.
This method works similar to get(String), but in addition it touches the document, which will reset its configured expiration time to the value provided.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - id the unique ID of the document.expiry - the new expiration time for the document.Observable eventually containing the found JsonDocument.<D extends Document<?>> rx.Observable<D> getAndTouch(D document)
Retrieve and touch a Document by its unique ID.
If the document is found, a Document is returned. If the document is not found, the Observable completes without an item emitted.
This method works similar to get(Document), but in addition it touches the document, which will reset its configured expiration time set on the given document itself.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptiondocument - the source document from which the ID and expiry is taken and the type is inferred.Observable eventually containing the found Document.<D extends Document<?>> rx.Observable<D> getAndTouch(java.lang.String id, int expiry, java.lang.Class<D> target)
Retrieve and touch a Document by its unique ID.
This method differs from getAndTouch(String, int) in that if a specific Document type is passed in, the appropriate Transcoder will be selected (and not JSON conversion).
If the document is found, a JsonDocument is returned. If the document is not found, the Observable completes without an item emitted.
This method works similar to get(String, Class), but in addition it touches the document, which will reset its configured expiration time to the value provided.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - id the unique ID of the document.expiry - the new expiration time for the document.target - the target document type to use.Observable eventually containing the found Document.<D extends Document<?>> rx.Observable<D> insert(D document)
Insert a Document if it does not exist already.
If the given Document (identified by its unique ID) already exists, the observable errors with a DocumentAlreadyExistsException. If the operation should also override the existing Document, upsert(Document) should be used instead. It will always either return a document or fail with an error.
The returned Document contains original properties, but has the refreshed CAS value set.
This operation will return successfully if the Document has been acknowledged in the managed cache layer on the master server node. If increased data durability is a concern, insert(Document, PersistTo, ReplicateTo) should be used instead.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDocumentAlreadyExistsException<D extends Document<?>> rx.Observable<D> insert(D document, PersistTo persistTo, ReplicateTo replicateTo)
Insert a Document if it does not exist already and watch for durability constraints.
This method works exactly like insert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDocumentAlreadyExistsExceptionDurabilityException.A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original insert has already happened, so the actual insert and the watching for durability constraints are two separate tasks internally.
<D extends Document<?>> rx.Observable<D> insert(D document, PersistTo persistTo)
Insert a Document if it does not exist already and watch for durability constraints.
This method works exactly like insert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDocumentAlreadyExistsExceptionDurabilityException.A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original insert has already happened, so the actual insert and the watching for durability constraints are two separate tasks internally.
<D extends Document<?>> rx.Observable<D> insert(D document, ReplicateTo replicateTo)
Insert a Document if it does not exist already and watch for durability constraints.
This method works exactly like insert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDocumentAlreadyExistsExceptionDurabilityException.A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original insert has already happened, so the actual insert and the watching for durability constraints are two separate tasks internally.
<D extends Document<?>> rx.Observable<D> upsert(D document)
Insert or replace a Document.
If the given Document (identified by its unique ID) already exists, it will be overridden by the current one. The returned Document contains original properties, but has the refreshed CAS value set.
This operation will return successfully if the Document has been acknowledged in the managed cache layer on the master server node. If increased data durability is a concern, upsert(Document, PersistTo, ReplicateTo) should be used instead.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledException<D extends Document<?>> rx.Observable<D> upsert(D document, PersistTo persistTo, ReplicateTo replicateTo)
Insert or replace a Document and watch for durability constraints.
This method works exactly like upsert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original upsert has already happened, so the actual upsert and the watching for durability constraints are two separate tasks internally.
<D extends Document<?>> rx.Observable<D> upsert(D document, PersistTo persistTo)
Insert or replace a Document and watch for durability constraints.
This method works exactly like upsert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original upsert has already happened, so the actual upsert and the watching for durability constraints are two separate tasks internally.
<D extends Document<?>> rx.Observable<D> upsert(D document, ReplicateTo replicateTo)
Insert or replace a Document and watch for durability constraints.
This method works exactly like upsert(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.A DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original upsert has already happened, so the actual upsert and the watching for durability constraints are two separate tasks internally.
<D extends Document<?>> rx.Observable<D> replace(D document)
Replace a Document if it does already exist.
If the given Document (identified by its unique ID) does not exist already, the method errors with a DocumentDoesNotExistException. If the operation should also insert the Document, upsert(Document) should be used instead. It will always either return a document or fail with an error.
The returned Document contains original properties, but has the refreshed CAS value set.
This operation will return successfully if the Document has been acknowledged in the managed cache layer on the master server node. If increased data durability is a concern, replace(Document, PersistTo, ReplicateTo) should be used instead.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDocumentDoesNotExistExceptionCASMismatchException<D extends Document<?>> rx.Observable<D> replace(D document, PersistTo persistTo, ReplicateTo replicateTo)
Replace a Document if it does exist and watch for durability constraints.
This method works exactly like replace(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDocumentDoesNotExistExceptionDurabilityException.CASMismatchExceptionA DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original replace has already happened, so the actual replace and the watching for durability constraints are two separate tasks internally.
<D extends Document<?>> rx.Observable<D> replace(D document, PersistTo persistTo)
Replace a Document if it does exist and watch for durability constraints.
This method works exactly like replace(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDocumentDoesNotExistExceptionDurabilityException.CASMismatchExceptionA DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original replace has already happened, so the actual replace and the watching for durability constraints are two separate tasks internally.
<D extends Document<?>> rx.Observable<D> replace(D document, ReplicateTo replicateTo)
Replace a Document if it does exist and watch for durability constraints.
This method works exactly like replace(Document), but afterwards watches the server states if the given durability constraints are met. If this is the case, a new document is returned which contains the original properties, but has the refreshed CAS value set.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDocumentDoesNotExistExceptionDurabilityException.CASMismatchExceptionA DurabilityException typically happens if the given amount of replicas needed to fulfill the durability constraint cannot be met because either the bucket does not have enough replicas configured or they are not available in a failover event. As an example, if one replica is configured and ReplicateTo.TWO is used, the observable is errored with a DurabilityException. The same can happen if one replica is configured, but one node has been failed over and not yet rebalanced (hence, on a subset of the partitions there is no replica available). It is important to understand that the original replace has already happened, so the actual replace and the watching for durability constraints are two separate tasks internally.
<D extends Document<?>> rx.Observable<D> remove(D document)
Removes a Document from the Server.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptiondocument - the document to remove, with the ID extracted.<D extends Document<?>> rx.Observable<D> remove(D document, PersistTo persistTo, ReplicateTo replicateTo)
Removes a Document from the Server and apply a durability requirement.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.document - the document to remove, with the ID extracted.persistTo - the persistence constraint to watch.replicateTo - the replication constraint to watch.<D extends Document<?>> rx.Observable<D> remove(D document, PersistTo persistTo)
Removes a Document from the Server and apply a durability requirement.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.document - the document to remove, with the ID extracted.persistTo - the persistence constraint to watch.<D extends Document<?>> rx.Observable<D> remove(D document, ReplicateTo replicateTo)
Removes a Document from the Server and apply a durability requirement.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.document - the document to remove, with the ID extracted.replicateTo - the replication constraint to watch.rx.Observable<JsonDocument> remove(java.lang.String id)
Removes a Document from the Server identified by its ID.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - the id of the document to remove.rx.Observable<JsonDocument> remove(java.lang.String id, PersistTo persistTo, ReplicateTo replicateTo)
Removes a Document from the Server by its ID and apply a durability requirement.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.id - the id of the document to remove.persistTo - the persistence constraint to watch.replicateTo - the replication constraint to watch.rx.Observable<JsonDocument> remove(java.lang.String id, PersistTo persistTo)
Removes a Document from the Server by its ID and apply a durability requirement.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.id - the id of the document to remove.persistTo - the persistence constraint to watch.rx.Observable<JsonDocument> remove(java.lang.String id, ReplicateTo replicateTo)
Removes a Document from the Server by its ID and apply a durability requirement.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.id - the id of the document to remove.replicateTo - the replication constraint to watch.<D extends Document<?>> rx.Observable<D> remove(java.lang.String id, java.lang.Class<D> target)
Removes a Document from the Server identified by its ID.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - the id of the document to remove.target - the target document type to use.<D extends Document<?>> rx.Observable<D> remove(java.lang.String id, PersistTo persistTo, ReplicateTo replicateTo, java.lang.Class<D> target)
Removes a Document from the Server by its ID and apply a durability requirement.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.id - the id of the document to remove.persistTo - the persistence constraint to watch.replicateTo - the replication constraint to watch.target - the target document type to use.<D extends Document<?>> rx.Observable<D> remove(java.lang.String id, PersistTo persistTo, java.lang.Class<D> target)
Removes a Document from the Server by its ID and apply a durability requirement.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.id - the id of the document to remove.persistTo - the persistence constraint to watch.target - the target document type to use.<D extends Document<?>> rx.Observable<D> remove(java.lang.String id, ReplicateTo replicateTo, java.lang.Class<D> target)
Removes a Document from the Server by its ID and apply a durability requirement.
The Document returned just has the document ID set, since the value and all other associated properties have been removed from the server.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDurabilityException.id - the id of the document to remove.replicateTo - the replication constraint to watch.target - the target document type to use.rx.Observable<AsyncViewResult> query(ViewQuery query)
Queries a Couchbase Server View.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionViewDoesNotExistExceptionquery - the query to perform.rx.Observable<AsyncQueryResult> query(Query query)
Experimental: Queries a N1QL secondary index.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionquery - the query in a DSL form (start with a static select() import)rx.Observable<AsyncQueryResult> query(java.lang.String query)
Experimental: Queries a N1QL secondary index.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionquery - the query in a plain N1QL Stringrx.Observable<java.lang.Boolean> unlock(java.lang.String id,
long cas)
Unlocks a write-locked Document.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDocumentDoesNotExistExceptionCASMismatchExceptionid - the id of the document to unlock.cas - the CAS value which is mandatory to unlock it.<D extends Document<?>> rx.Observable<java.lang.Boolean> unlock(D document)
Unlocks a write-locked Document.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionDocumentDoesNotExistExceptionCASMismatchExceptiondocument - the document where ID and CAS are extracted from.rx.Observable<java.lang.Boolean> touch(java.lang.String id,
int expiry)
Renews the expiration time of a Document.
Compared to getAndTouch(Document), this method does not actually fetch the document from the server, but it just resets its expiration time to the given value.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - the id of the document.expiry - the new expiration time. 0 means no expiry.<D extends Document<?>> rx.Observable<java.lang.Boolean> touch(D document)
Renews the expiration time of a Document.
Compared to getAndTouch(Document), this method does not actually fetch the document from the server, but it just resets its expiration time to the given value.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptiondocument - the document to extract the ID and expiry from.rx.Observable<JsonLongDocument> counter(java.lang.String id, long delta)
Increment or decrement a counter with the given value and a default value of 0.
It is not allowed that the delta value will bring the actual value below zero.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - the id of the document.delta - the increment or decrement amount.Document containing the resulting value.rx.Observable<JsonLongDocument> counter(java.lang.String id, long delta, long initial)
Increment or decrement a counter with the given value and a initial value if it does not exist.
It is not allowed that the delta value will bring the actual value below zero.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - the id of the document.delta - the increment or decrement amount.Document containing the resulting value.rx.Observable<JsonLongDocument> counter(java.lang.String id, long delta, long initial, int expiry)
Increment or decrement a counter with the given value and a initial value if it does not exist.
This method allows to set an expiration time for the document as well. It is not allowed that the delta value will bring the actual value below zero.
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptionid - the id of the document.delta - the increment or decrement amount.Document containing the resulting value.<D extends Document<?>> rx.Observable<D> append(D document)
Append a Document to another one.
If the Document does not exist, it needs to be created upfront. Note that JsonDocuments in all forms are not supported, it is advised that the following ones are used:
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptiondocument - the document to be appended.<D extends Document<?>> rx.Observable<D> prepend(D document)
Prepend a Document to another one.
If the Document does not exist, it needs to be created upfront. Note that JsonDocuments in all forms are not supported, it is advised that the following ones are used:
The returned Observable can error under the following conditions:
BackpressureExceptionRequestCancelledExceptiondocument - the document to be prepended.rx.Observable<AsyncBucketManager> bucketManager()
Provides access to the AsyncBucketManager for administrative access.
The manager lets you perform operations such as flushing a bucket or creating and managing design documents.
rx.Observable<java.lang.Boolean> close()
Closes the AsyncBucket.
Observable eventually containing a new Boolean after close.