com.couchbase.client.java.manager.view

Class ReactiveViewIndexManager

java.lang.Object

com.couchbase.client.java.manager.view.ReactiveViewIndexManager

public class ReactiveViewIndexManager
extends Object

Constructor Summary

Constructors

Constructor and Description
ReactiveViewIndexManager(AsyncViewIndexManager async)

Method Summary

Modifier and Type	Method and Description
Mono<Void>	dropDesignDocument(String name, DesignDocumentNamespace namespace) Removes a design document from the server.
Mono<Void>	dropDesignDocument(String name, DesignDocumentNamespace namespace, DropDesignDocumentOptions options) Removes a design document from the server.
Flux<DesignDocument>	getAllDesignDocuments(DesignDocumentNamespace namespace) Returns all of the design documents in the specified namespace.
Flux<DesignDocument>	getAllDesignDocuments(DesignDocumentNamespace namespace, GetAllDesignDocumentsOptions options) Returns all of the design documents in the specified namespace.
Mono<DesignDocument>	getDesignDocument(String name, DesignDocumentNamespace namespace) Returns the design document from the cluster if present.
Mono<DesignDocument>	getDesignDocument(String name, DesignDocumentNamespace namespace, GetDesignDocumentOptions options) Returns the design document from the cluster if present with custom options.
Mono<Void>	publishDesignDocument(String name) Convenience method that gets a the document from the development namespace and upserts it to the production namespace.
Mono<Void>	publishDesignDocument(String name, PublishDesignDocumentOptions options) Convenience method that gets a the document from the development namespace and upserts it to the production namespace.
Mono<Void>	upsertDesignDocument(DesignDocument designDocument, DesignDocumentNamespace namespace) Stores the design document on the server under the specified namespace, replacing any existing document with the same name.
Mono<Void>	upsertDesignDocument(DesignDocument designDocument, DesignDocumentNamespace namespace, UpsertDesignDocumentOptions options) Stores the design document on the server under the specified namespace, replacing any existing document with the same name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReactiveViewIndexManager

public ReactiveViewIndexManager(AsyncViewIndexManager async)

Method Detail

getDesignDocument

public Mono<DesignDocument> getDesignDocument(String name,
                                              DesignDocumentNamespace namespace)

Returns the design document from the cluster if present.

Parameters:

name - name of the design document to retrieve.

namespace - namespace to look in.

Throws:

DesignDocumentNotFoundException - (async) if there is no design document with the given name present.

TimeoutException - (async) if the operation times out before getting a result.

CouchbaseException - (async) for all other error reasons (acts as a base type and catch-all).

getDesignDocument

public Mono<DesignDocument> getDesignDocument(String name,
                                              DesignDocumentNamespace namespace,
                                              GetDesignDocumentOptions options)

Returns the design document from the cluster if present with custom options.

Parameters:

name - name of the design document to retrieve

namespace - namespace to look in

options - additional optional arguments (timeout, retry, etc.)

Throws:

DesignDocumentNotFoundException - (async) if there is no design document with the given name present.

TimeoutException - (async) if the operation times out before getting a result.

CouchbaseException - (async) for all other error reasons (acts as a base type and catch-all).

upsertDesignDocument

public Mono<Void> upsertDesignDocument(DesignDocument designDocument,
                                       DesignDocumentNamespace namespace)

Stores the design document on the server under the specified namespace, replacing any existing document with the same name.

Parameters:

designDocument - document to store

namespace - namespace to store it in

Throws:

TimeoutException - (async) if the operation times out before getting a result.

CouchbaseException - (async) for all other error reasons (acts as a base type and catch-all).

upsertDesignDocument

public Mono<Void> upsertDesignDocument(DesignDocument designDocument,
                                       DesignDocumentNamespace namespace,
                                       UpsertDesignDocumentOptions options)

Stores the design document on the server under the specified namespace, replacing any existing document with the same name.

Parameters:

designDocument - document to store

namespace - namespace to store it in

options - additional optional arguments (timeout, retry, etc.)

Throws:

TimeoutException - (async) if the operation times out before getting a result.

CouchbaseException - (async) for all other error reasons (acts as a base type and catch-all).

publishDesignDocument

public Mono<Void> publishDesignDocument(String name)

Convenience method that gets a the document from the development namespace and upserts it to the production namespace.

Parameters:

name - name of the development design document

Throws:

DesignDocumentNotFoundException - (async) if the development namespace does not contain a document with the given name

TimeoutException - (async) if the operation times out before getting a result.

CouchbaseException - (async) for all other error reasons (acts as a base type and catch-all).

publishDesignDocument

public Mono<Void> publishDesignDocument(String name,
                                        PublishDesignDocumentOptions options)

Convenience method that gets a the document from the development namespace and upserts it to the production namespace.

Parameters:

name - name of the development design document

options - additional optional arguments (timeout, retry, etc.)

Throws:

DesignDocumentNotFoundException - (async) if the development namespace does not contain a document with the given name

TimeoutException - (async) if the operation times out before getting a result.

CouchbaseException - (async) for all other error reasons (acts as a base type and catch-all).

dropDesignDocument

public Mono<Void> dropDesignDocument(String name,
                                     DesignDocumentNamespace namespace)

Removes a design document from the server.

Parameters:

name - name of the document to remove

namespace - namespace to remove it from

Throws:

DesignDocumentNotFoundException - (async) if the namespace does not contain a document with the given name

TimeoutException - (async) if the operation times out before getting a result.

CouchbaseException - (async) for all other error reasons (acts as a base type and catch-all).

dropDesignDocument

public Mono<Void> dropDesignDocument(String name,
                                     DesignDocumentNamespace namespace,
                                     DropDesignDocumentOptions options)

Removes a design document from the server.

Parameters:

name - name of the document to remove

namespace - namespace to remove it from

options - additional optional arguments (timeout, retry, etc.)

Throws:

DesignDocumentNotFoundException - (async) if the namespace does not contain a document with the given name

TimeoutException - (async) if the operation times out before getting a result.

CouchbaseException - (async) for all other error reasons (acts as a base type and catch-all).

getAllDesignDocuments

public Flux<DesignDocument> getAllDesignDocuments(DesignDocumentNamespace namespace)

Returns all of the design documents in the specified namespace.

Parameters:

namespace - namespace to query

Throws:

TimeoutException - (async) if the operation times out before getting a result.

CouchbaseException - (async) for all other error reasons (acts as a base type and catch-all).

getAllDesignDocuments

public Flux<DesignDocument> getAllDesignDocuments(DesignDocumentNamespace namespace,
                                                  GetAllDesignDocumentsOptions options)

Returns all of the design documents in the specified namespace.

Parameters:

namespace - namespace to query

options - additional optional arguments (timeout, retry, etc.)

Throws:

TimeoutException - (async) if the operation times out before getting a result.

CouchbaseException - (async) for all other error reasons (acts as a base type and catch-all).