AsyncBucketManager (Couchbase Java SDK)

All Known Implementing Classes:

DefaultAsyncBucketManager
```
@InterfaceStability.Committed
 @InterfaceAudience.Public
public interface AsyncBucketManager
```
Provides management capabilities for a AsyncBucket.
Operations provided on the BucketManager can be used to perform administrative tasks which require bucket-level credentials like managing DesignDocuments or flushing a Bucket.

Since:

2.0

Author:

Michael Nitschinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Observable<List<String>>`	`buildN1qlDeferredIndexes()` Instruct the query engine to trigger the build of indexes that have been deferred.
`Observable<Boolean>`	`createN1qlIndex(String indexName, boolean ignoreIfExist, boolean defer, Object... fields)` Create a secondary index for the current bucket.
`Observable<Boolean>`	`createN1qlIndex(String indexName, List<Object> fields, Expression whereClause, boolean ignoreIfExist, boolean defer)` Create a secondary index for the current bucket, with a WHERE clause.
`Observable<Boolean>`	`createN1qlPrimaryIndex(boolean ignoreIfExist, boolean defer)` Create a primary index for the current bucket.
`Observable<Boolean>`	`createN1qlPrimaryIndex(String customName, boolean ignoreIfExist, boolean defer)` Create a custom-named primary index for the current bucket.
`Observable<Boolean>`	`dropN1qlIndex(String name, boolean ignoreIfNotExist)` Drop the given secondary index associated with the current bucket.
`Observable<Boolean>`	`dropN1qlPrimaryIndex(boolean ignoreIfNotExist)` Drop the default primary index () associated with the current bucket.
`Observable<Boolean>`	`dropN1qlPrimaryIndex(String customName, boolean ignoreIfNotExist)` Drop the given custom-named primary index associated with the current bucket.
`Observable<Boolean>`	`flush()` Flushes the bucket (removes all data).
`Observable<DesignDocument>`	`getDesignDocument(String name)` Loads a published `DesignDocument` by its name.
`Observable<DesignDocument>`	`getDesignDocument(String name, boolean development)` Loads a `DesignDocument` by its name from either development or production.
`Observable<DesignDocument>`	`getDesignDocuments()` Loads all published `DesignDocument`s.
`Observable<DesignDocument>`	`getDesignDocuments(boolean development)` Loads all `DesignDocument`s from development or production.
`Observable<BucketInfo>`	`info()` Returns information about the connected bucket.
`Observable<DesignDocument>`	`insertDesignDocument(DesignDocument designDocument)` Inserts a `DesignDocument` into production if it does not exist.
`Observable<DesignDocument>`	`insertDesignDocument(DesignDocument designDocument, boolean development)` Inserts a `DesignDocument` into development or production if it does not exist.
`Observable<IndexInfo>`	`listN1qlIndexes()` List all N1QL GSI indexes that are registered for the current bucket.
`Observable<DesignDocument>`	`publishDesignDocument(String name)` Publishes a `DesignDocument` from development into production.
`Observable<DesignDocument>`	`publishDesignDocument(String name, boolean overwrite)` Publishes a `DesignDocument` from development into production.
`Observable<Boolean>`	`removeDesignDocument(String name)` Removes a `DesignDocument` from production by its name.
`Observable<Boolean>`	`removeDesignDocument(String name, boolean development)` Removes a `DesignDocument` from production or development by its name.
`Observable<DesignDocument>`	`upsertDesignDocument(DesignDocument designDocument)` Upserts (inserts or replaces) a `DesignDocument` into production.
`Observable<DesignDocument>`	`upsertDesignDocument(DesignDocument designDocument, boolean development)` Upserts (inserts or replaces) a `DesignDocument` into production or development.
`Observable<IndexInfo>`	`watchN1qlIndexes(List<String> watchList, long watchTimeout, TimeUnit watchTimeUnit)` Watches all given indexes (possibly including the primary one), polling the query service until they become “online” or the watchTimeout has expired..

- Method Detail
  - info
```
Observable<BucketInfo> info()
```
    Returns information about the connected bucket.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
    Returns:
    
    bucket information wrapped in a BucketInfo.
  - flush
```
Observable<Boolean> flush()
```
    Flushes the bucket (removes all data).
    Note that flush needs to be enabled on the bucket, otherwise an exception will be raised.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.FlushDisabledException: If flush is disabled.
    - com.couchbase.client.core.CouchbaseException: If the server response could not be parsed.
    Returns:
    
    true if the bucket was flushed, an failed Observable otherwise.
  - getDesignDocuments
```
Observable<DesignDocument> getDesignDocuments()
```
    Loads all published DesignDocuments.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Returns:
    
    zero to N invocations containing published DesignDocuments.
  - getDesignDocuments
```
Observable<DesignDocument> getDesignDocuments(boolean development)
```
    Loads all DesignDocuments from development or production.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    - com.couchbase.client.java.error.DesignDocumentDoesNotExistException: If DesignDocument is not found.
    Parameters:
    
    development - if the DesignDocuments should be loaded from development or production.
    
    Returns:
    
    zero to N invocations containing published DesignDocuments.
  - getDesignDocument
```
Observable<DesignDocument> getDesignDocument(String name)
```
    Loads a published DesignDocument by its name.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    - com.couchbase.client.java.error.DesignDocumentDoesNotExistException: If DesignDocument is not found.
    Parameters:
    
    name - the name of the DesignDocument.
    
    Returns:
    
    and empty observable if the document not found or a DesignDocument.
  - getDesignDocument
```
Observable<DesignDocument> getDesignDocument(String name,
                                             boolean development)
```
    Loads a DesignDocument by its name from either development or production.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    - com.couchbase.client.java.error.DesignDocumentDoesNotExistException: If DesignDocument is not found.
    Parameters:
    
    name - the name of the DesignDocument.
    
    development - if it should be loaded from development or production.
    
    Returns:
    
    and empty observable if the document not found or a DesignDocument.
  - insertDesignDocument
```
Observable<DesignDocument> insertDesignDocument(DesignDocument designDocument)
```
    Inserts a DesignDocument into production if it does not exist.
    Note that inserting a DesignDocument is not an atomic operation, but instead internally performs a getDesignDocument(String) operation first. While expected to be very uncommon, a race condition may happen if two users at the same time perform this operation with the same DesignDocument.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    - com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument exists.
    Parameters:
    
    designDocument - the DesignDocument to insert.
    
    Returns:
    
    the inserted DesignDocument on success.
  - insertDesignDocument
```
Observable<DesignDocument> insertDesignDocument(DesignDocument designDocument,
                                                boolean development)
```
    Inserts a DesignDocument into development or production if it does not exist.
    Note that inserting a DesignDocument is not an atomic operation, but instead internally performs a getDesignDocument(String) operation first. While expected to be very uncommon, a race condition may happen if two users at the same time perform this operation with the same DesignDocument.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    - com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument exists.
    Parameters:
    
    designDocument - the DesignDocument to insert.
    
    development - if it should be inserted into development or production (published).
    
    Returns:
    
    the inserted DesignDocument on success.
  - upsertDesignDocument
```
Observable<DesignDocument> upsertDesignDocument(DesignDocument designDocument)
```
    Upserts (inserts or replaces) a DesignDocument into production.
    If you want to add or update view definitions to an existing design document, you need to make sure you have all the views (including old ones) in the DesignDocument. Use getDesignDocument(String) to get the old list and add your new view to it before calling this method.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Parameters:
    
    designDocument - the DesignDocument to upsert.
    
    Returns:
    
    the upserted DesignDocument on success.
  - upsertDesignDocument
```
Observable<DesignDocument> upsertDesignDocument(DesignDocument designDocument,
                                                boolean development)
```
    Upserts (inserts or replaces) a DesignDocument into production or development.
    If you want to add or update view definitions to an existing design document, you need to make sure you have all the views (including old ones) in the DesignDocument. Use getDesignDocument(String) to get the old list and add your new view to it before calling this method.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Parameters:
    
    designDocument - the DesignDocument to upsert.
    
    development - if the DesignDocument should be upserted into development or production.
    
    Returns:
    
    the upserted DesignDocument on success.
  - removeDesignDocument
```
Observable<Boolean> removeDesignDocument(String name)
```
    Removes a DesignDocument from production by its name.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.DesignDocumentDoesNotExistException: If DesignDocument is not found.
    Parameters:
    
    name - the name of the DesignDocument.
    
    Returns:
    
    true if succeeded, false otherwise.
  - removeDesignDocument
```
Observable<Boolean> removeDesignDocument(String name,
                                         boolean development)
```
    Removes a DesignDocument from production or development by its name.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.DesignDocumentDoesNotExistException: If DesignDocument is not found.
    Parameters:
    
    name - the name of the DesignDocument.
    
    development - if the DesignDocument should be removed from development or production.
    
    Returns:
    
    true if succeeded, false otherwise.
  - publishDesignDocument
```
Observable<DesignDocument> publishDesignDocument(String name)
```
    Publishes a DesignDocument from development into production.
    Note that this method does not override a already existing DesignDocument (see publishDesignDocument(String, boolean)) as an alternative.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument already exists.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    Parameters:
    
    name - the name of the DesignDocument to publish.
    
    Returns:
    
    the published DesignDocument on success.
  - publishDesignDocument
```
Observable<DesignDocument> publishDesignDocument(String name,
                                                 boolean overwrite)
```
    Publishes a DesignDocument from development into production.
    The Observable can error under the following conditions:
    - com.couchbase.client.java.error.DesignDocumentAlreadyExistsException: If the DesignDocument already exists and override is set to false.
    - com.couchbase.client.java.error.TranscodingException: If the server response could not be parsed.
    - com.couchbase.client.java.error.DesignDocumentDoesNotExistException: If DesignDocument is not found.
    Parameters:
    
    name - the name of the DesignDocument to publish.
    
    overwrite - if an existing DesignDocument should be overridden.
    
    Returns:
    
    the published DesignDocument on success.
  - listN1qlIndexes
```
Observable<IndexInfo> listN1qlIndexes()
```
    List all N1QL GSI indexes that are registered for the current bucket.
    The index management API only deals with GSI type of indexes, which allows it to uniquely identify indexes by name.
    The Observable can error under the following conditions:
    - TranscodingException if the server response couldn’t be parsed.
    Returns:
    
    an Observable that will get notified of each relevant IndexInfo (can be empty if no relevant index is defined for this bucket).
  - createN1qlPrimaryIndex
```
Observable<Boolean> createN1qlPrimaryIndex(boolean ignoreIfExist,
                                           boolean defer)
```
    Create a primary index for the current bucket.
    The index management API only deals with GSI type of indexes, which allows it to uniquely identify indexes by name.
    The Observable can error under the following conditions:
    - IndexAlreadyExistsException if the index already exists and ignoreIfExist is set to false.
    - CouchbaseException if another error occurs during index creation.
    Parameters:
    
    ignoreIfExist - if a primary index already exists, an exception will be thrown unless this is set to true.
    
    defer - true to defer building of the index until buildN1qlDeferredIndexes() is called (or a direct call to the corresponding query service API).
    
    Returns:
    
    an Observable that will get notified with a single Boolean.TRUE if the index was effectively created (even in deferred mode), Boolean.FALSE if the index existed and ignoreIfExist is true.
  - createN1qlPrimaryIndex
```
Observable<Boolean> createN1qlPrimaryIndex(String customName,
                                           boolean ignoreIfExist,
                                           boolean defer)
```
    Create a custom-named primary index for the current bucket.
    The index management API only deals with GSI type of indexes, which allows it to uniquely identify indexes by name.
    The Observable can error under the following conditions:
    - IndexAlreadyExistsException if the index already exists and ignoreIfExist is set to false.
    - CouchbaseException if another error occurs during index creation.
    Parameters:
    
    customName - the custom name for the primary index.
    
    ignoreIfExist - if a primary index already exists, an exception will be thrown unless this is set to true.
    
    defer - true to defer building of the index until buildN1qlDeferredIndexes() is called (or a direct call to the corresponding query service API).
    
    Returns:
    
    an Observable that will get notified with a single Boolean.TRUE if the index was effectively created (even in deferred mode), Boolean.FALSE if the index existed and ignoreIfExist is true.
  - createN1qlIndex
```
Observable<Boolean> createN1qlIndex(String indexName,
                                    boolean ignoreIfExist,
                                    boolean defer,
                                    Object... fields)
```
    Create a secondary index for the current bucket.
    The index management API only deals with GSI type of indexes, which allows it to uniquely identify indexes by name.
    The convenience of providing fields as a vararg of either String or Expression comes with the limitation that a WHERE clause cannot be provided. See createN1qlIndex(String, List, Expression, boolean, boolean) for that.
    The Observable can error under the following conditions:
    - IndexAlreadyExistsException if the index already exists and ignoreIfExist is set to false.
    - CouchbaseException if another error occurs during index creation.
    Parameters:
    
    indexName - the name of the index.
    
    ignoreIfExist - if a secondary index already exists with that name, an exception will be thrown unless this is set to true.
    
    defer - true to defer building of the index until buildN1qlDeferredIndexes() is called (or a direct call to the corresponding query service API).
    
    fields - the JSON fields to index, in either Expression or String form.
    
    Returns:
    
    an Observable that will get notified with a single Boolean.TRUE if the index was effectively created (even in deferred mode), Boolean.FALSE if the index existed and ignoreIfExist is true.
    
    See Also:
    
    createN1qlIndex(String, List, Expression, boolean, boolean)
  - createN1qlIndex
```
Observable<Boolean> createN1qlIndex(String indexName,
                                    List<Object> fields,
                                    Expression whereClause,
                                    boolean ignoreIfExist,
                                    boolean defer)
```
    Create a secondary index for the current bucket, with a WHERE clause.
    The index management API only deals with GSI type of indexes, which allows it to uniquely identify indexes by name.
    The Observable can error under the following conditions:
    - IndexAlreadyExistsException if the index already exists and ignoreIfExist is set to false.
    - CouchbaseException if another error occurs during index creation.
    Parameters:
    
    indexName - the name of the index.
    
    fields - the JSON fields to index, in the form of a List containing a mix of Expression or String.
    
    whereClause - the Expression to use in the WHERE clause of the index.
    
    ignoreIfExist - if a secondary index already exists with that name, an exception will be thrown unless this is set to true.
    
    defer - true to defer building of the index until buildN1qlDeferredIndexes() is called (or a direct call to the corresponding query service API).
    
    Returns:
    
    an Observable that will get notified with a single Boolean.TRUE if the index was effectively created (even in deferred mode), Boolean.FALSE if the index existed and ignoreIfExist is true.
  - dropN1qlPrimaryIndex
```
Observable<Boolean> dropN1qlPrimaryIndex(boolean ignoreIfNotExist)
```
    Drop the default primary index () associated with the current bucket.
    The index management API only deals with GSI type of indexes, which allows it to uniquely identify indexes by name.
    The Observable can error under the following conditions:
    - IndexDoesNotExistException if the primary index doesn’t exist and ignoreIfNoExist is set to false.
    - CouchbaseException if another error occurs during index drop.
    Parameters:
    
    ignoreIfNotExist - if true, attempting to drop on a bucket without any primary index won’t cause an exception to be propagated.
    
    Returns:
    
    an Observable that will get notified with a single Boolean.TRUE if the index was effectively dropped.
  - dropN1qlPrimaryIndex
```
Observable<Boolean> dropN1qlPrimaryIndex(String customName,
                                         boolean ignoreIfNotExist)
```
    Drop the given custom-named primary index associated with the current bucket.
    The index management API only deals with GSI type of indexes, which allows it to uniquely identify indexes by name.
    The Observable can error under the following conditions:
    - IndexDoesNotExistException if the primary index doesn’t exist and ignoreIfNoExist is set to false.
    - CouchbaseException if another error occurs during index drop.
    Parameters:
    
    customName - the custom name of the primary index.
    
    ignoreIfNotExist - if true, attempting to drop on a bucket without any primary index won’t cause an exception to be propagated.
    
    Returns:
    
    an Observable that will get notified with a single Boolean.TRUE if the index was effectively dropped.
  - dropN1qlIndex
```
Observable<Boolean> dropN1qlIndex(String name,
                                  boolean ignoreIfNotExist)
```
    Drop the given secondary index associated with the current bucket.
    The index management API only deals with GSI type of indexes, which allows it to uniquely identify indexes by name.
    The Observable can error under the following conditions:
    - IndexDoesNotExistException if the secondary index doesn’t exist and ignoreIfNoExist is set to false.
    - CouchbaseException if another error occurs during index drop.
    Parameters:
    
    ignoreIfNotExist - if true, attempting to drop on a bucket without the specified index won’t cause an exception to be propagated.
    
    Returns:
    
    an Observable that will get notified with a single Boolean.TRUE if the index was effectively dropped.
  - buildN1qlDeferredIndexes
```
Observable<List<String>> buildN1qlDeferredIndexes()
```
    Instruct the query engine to trigger the build of indexes that have been deferred. This only considers GSI indexes, as the index management API only deals with this type of indexes.
    This process itself is asynchronous, meaning that the call will immediately return despite indexes still being in a “pending” or “building” state. This method will return a List of the names of indexes whose build has been triggered, in a single emission.
    
    Returns:
    
    an Observable that will get notified with a single List of index names, the names of the indexes that have been triggered.
    
    See Also:
    
    to poll for a list of indexes to become online.
  - watchN1qlIndexes
```
Observable<IndexInfo> watchN1qlIndexes(List<String> watchList,
                                       long watchTimeout,
                                       TimeUnit watchTimeUnit)
```
    Watches all given indexes (possibly including the primary one), polling the query service until they become “online” or the watchTimeout has expired.. This only considers GSI indexes, as the index management API only deals with this type of indexes.
    Note: You can activate DEBUG level logs on the “” logger to see various stages of the polling.
    You can also watch a primary index by using the Index.PRIMARY_NAME constant.
    
    Parameters:
    
    watchList - the names of the SECONDARY indexes to watch (can be empty).
    
    watchTimeout - the maximum duration for which to poll for the index to become online.
    
    watchTimeUnit - the time unit for the watchTimeout.
    
    Returns:
    
    a stream of the IndexInfo for the indexes that went online during the watch period. Can be empty if all indexes where online, no index to watch or no index became online within the watchTimeout timeframe.

Interface AsyncBucketManager

Method Summary

Method Detail

info

flush

getDesignDocuments

getDesignDocuments

getDesignDocument

getDesignDocument

insertDesignDocument

insertDesignDocument

upsertDesignDocument

upsertDesignDocument

removeDesignDocument

removeDesignDocument

publishDesignDocument

publishDesignDocument

listN1qlIndexes

createN1qlPrimaryIndex

createN1qlPrimaryIndex

createN1qlIndex

createN1qlIndex

dropN1qlPrimaryIndex

dropN1qlPrimaryIndex

dropN1qlIndex

buildN1qlDeferredIndexes

watchN1qlIndexes