Class ViewIndexManager


  • public class ViewIndexManager
    extends Object
    • Method Detail

      • 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:
        TimeoutException - if the operation times out before getting a result.
        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:
        TimeoutException - if the operation times out before getting a result.
        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:
        DesignDocumentNotFoundException - if the development namespace does not contain a document with the given name
        TimeoutException - if the operation times out before getting a result.
        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:
        DesignDocumentNotFoundException - if the development namespace does not contain a document with the given name
        TimeoutException - if the operation times out before getting a result.
        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:
        DesignDocumentNotFoundException - if the namespace does not contain a document with the given name
        TimeoutException - if the operation times out before getting a result.
        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:
        DesignDocumentNotFoundException - if the namespace does not contain a document with the given name
        TimeoutException - if the operation times out before getting a result.
        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:
        TimeoutException - if the operation times out before getting a result.
        CouchbaseException - for all other error reasons (acts as a base type and catch-all).