Class SearchIndexManager


  • public class SearchIndexManager
    extends Object
    The SearchIndexManager allows to manage search index structures in a couchbase cluster.
    Since:
    3.0.0
    • Method Detail

      • getIndex

        public SearchIndex getIndex​(String name,
                                    GetSearchIndexOptions options)
        Fetches an index from the server if it exists.
        Parameters:
        name - the name of the search index.
        Returns:
        the index definition if it exists.
      • getIndexedDocumentsCount

        public long getIndexedDocumentsCount​(String name,
                                             GetIndexedSearchIndexOptions options)
        Retrieves the number of documents that have been indexed for an index.
        Parameters:
        name - the name of the search index.
        Returns:
        the number of indexed documents.
      • analyzeDocument

        public List<JsonObject> analyzeDocument​(String name,
                                                JsonObject document,
                                                AnalyzeDocumentOptions options)
        Allows to see how a document is analyzed against a specific index.
        Parameters:
        name - the name of the search index.
        document - the document to be analyzed.
        Returns:
        the analyzed sections for the document.
      • upsertIndex

        public void upsertIndex​(SearchIndex index,
                                UpsertSearchIndexOptions options)
        Creates, or updates, an index.
        Parameters:
        index - the index definition including name and settings.
      • dropIndex

        public void dropIndex​(String name,
                              DropSearchIndexOptions options)
        Drops an index.
        Parameters:
        name - the name of the search index.
      • pauseIngest

        public void pauseIngest​(String name,
                                PauseIngestSearchIndexOptions options)
        Pauses updates and maintenance for an index.
        Parameters:
        name - the name of the search index.
      • resumeIngest

        public void resumeIngest​(String name,
                                 ResumeIngestSearchIndexOptions options)
        Resumes updates and maintenance for an index.
        Parameters:
        name - the name of the search index.
      • allowQuerying

        public void allowQuerying​(String name,
                                  AllowQueryingSearchIndexOptions options)
        Allows querying against an index.
        Parameters:
        name - the name of the search index.
      • freezePlan

        public void freezePlan​(String name,
                               FreezePlanSearchIndexOptions options)
        Freeze the assignment of index partitions to nodes.
        Parameters:
        name - the name of the search index.
      • unfreezePlan

        public void unfreezePlan​(String name,
                                 UnfreezePlanSearchIndexOptions options)
        Unfreeze the assignment of index partitions to nodes.
        Parameters:
        name - the name of the search index.
      • getIndex

        public SearchIndex getIndex​(String name)
        Fetches an index from the server if it exists.
        Parameters:
        name - the name of the search index.
        Returns:
        the index definition if it exists.
      • getAllIndexes

        public List<SearchIndex> getAllIndexes()
        Fetches all indexes from the server.
        Returns:
        all currently present indexes.
      • getIndexedDocumentsCount

        public long getIndexedDocumentsCount​(String name)
        Retrieves the number of documents that have been indexed for an index.
        Parameters:
        name - the name of the search index.
        Returns:
        the number of indexed documents.
      • analyzeDocument

        public List<JsonObject> analyzeDocument​(String name,
                                                JsonObject document)
        Allows to see how a document is analyzed against a specific index.
        Parameters:
        name - the name of the search index.
        document - the document to be analyzed.
        Returns:
        the analyzed sections for the document.
      • upsertIndex

        public void upsertIndex​(SearchIndex index)
        Creates, or updates, an index.
        Parameters:
        index - the index definition including name and settings.
      • dropIndex

        public void dropIndex​(String name)
        Drops an index.
        Parameters:
        name - the name of the search index.
      • pauseIngest

        public void pauseIngest​(String name)
        Pauses updates and maintenance for an index.
        Parameters:
        name - the name of the search index.
      • resumeIngest

        public void resumeIngest​(String name)
        Resumes updates and maintenance for an index.
        Parameters:
        name - the name of the search index.
      • allowQuerying

        public void allowQuerying​(String name)
        Allows querying against an index.
        Parameters:
        name - the name of the search index.
      • disallowQuerying

        public void disallowQuerying​(String name)
        Disallows querying against an index.
        Parameters:
        name - the name of the search index.
      • freezePlan

        public void freezePlan​(String name)
        Freeze the assignment of index partitions to nodes.
        Parameters:
        name - the name of the search index.
      • unfreezePlan

        public void unfreezePlan​(String name)
        Unfreeze the assignment of index partitions to nodes.
        Parameters:
        name - the name of the search index.