com.couchbase.client.java.manager.view

Class ViewIndexManager

java.lang.Object

com.couchbase.client.java.manager.view.ViewIndexManager

public class ViewIndexManager
extends Object

Constructor Summary

Constructors

Constructor and Description
ViewIndexManager(AsyncViewIndexManager async)

Method Summary

Modifier and Type	Method and Description
AsyncViewIndexManager	async()
void	dropDesignDocument(String name, DesignDocumentNamespace namespace) Removes a design document from the server.
void	dropDesignDocument(String name, DesignDocumentNamespace namespace, DropDesignDocumentOptions options) Removes a design document from the server.
List<DesignDocument>	getAllDesignDocuments(DesignDocumentNamespace namespace) Returns all of the design documents in the specified namespace.
List<DesignDocument>	getAllDesignDocuments(DesignDocumentNamespace namespace, GetAllDesignDocumentsOptions options) Returns all of the design documents in the specified namespace.
DesignDocument	getDesignDocument(String name, DesignDocumentNamespace namespace) Returns the design document from the cluster if present.
DesignDocument	getDesignDocument(String name, DesignDocumentNamespace namespace, GetDesignDocumentOptions options) Returns the design document from the cluster if present with custom options.
void	publishDesignDocument(String name) Convenience method that gets a the document from the development namespace and upserts it to the production namespace.
void	publishDesignDocument(String name, PublishDesignDocumentOptions options) Convenience method that gets a the document from the development namespace and upserts it to the production namespace.
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.
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

ViewIndexManager

public ViewIndexManager(AsyncViewIndexManager async)

Method Detail

async

public AsyncViewIndexManager async()

getDesignDocument

public 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:

com.couchbase.client.core.error.DesignDocumentNotFoundException - if there is no design document with the given name present.

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

getDesignDocument

public 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:

com.couchbase.client.core.error.DesignDocumentNotFoundException - if there is no design document with the given name present.

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

upsertDesignDocument

public 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:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

upsertDesignDocument

public 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:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

publishDesignDocument

public 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:

com.couchbase.client.core.error.DesignDocumentNotFoundException - if the development namespace does not contain a document with the given name

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

publishDesignDocument

public 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:

com.couchbase.client.core.error.DesignDocumentNotFoundException - if the development namespace does not contain a document with the given name

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

dropDesignDocument

public 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:

com.couchbase.client.core.error.DesignDocumentNotFoundException - if the namespace does not contain a document with the given name

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

dropDesignDocument

public 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:

com.couchbase.client.core.error.DesignDocumentNotFoundException - if the namespace does not contain a document with the given name

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

getAllDesignDocuments

public List<DesignDocument> getAllDesignDocuments(DesignDocumentNamespace namespace)

Returns all of the design documents in the specified namespace.

Parameters:

namespace - namespace to query

Throws:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).

getAllDesignDocuments

public List<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:

com.couchbase.client.core.error.TimeoutException - if the operation times out before getting a result.

com.couchbase.client.core.error.CouchbaseException - for all other error reasons (acts as a base type and catch-all).