Package com.couchbase.client.java.query.dsl.path.index

Interface IndexNamesPath

All Superinterfaces:
Path
All Known Implementing Classes:
DefaultIndexNamesPath
@Experimental
@Public
public interface IndexNamesPath
extends Path
Path of the Index building DSL to specify which index(es) to build.
Since:
2.2
Author:
Simon Baslé

  • Method Summary

    Modifier and Type Method Description
    UsingPath indexes​(String indexName, String... indexNames)
    Specify the index or indexes in a pending state that needs building.
    UsingPath indexes​(List<String> indexNames)
    Specify the indexes in a pending state that needs building, as a non-empty list.
    UsingPath primary()
    Build the primary index (using a name of Index.PRIMARY_NAME, must be in a pending state).

  • Method Details

    • indexes

      UsingPath indexes​(String indexName, String... indexNames)
      Specify the index or indexes in a pending state that needs building.
      Parameters:
      indexName - minimum index to build (name will be escaped).
      indexNames - 0-n additional indexes to also build (names will be escaped).

    • indexes

      UsingPath indexes​(List<String> indexNames)
      Specify the indexes in a pending state that needs building, as a non-empty list.
      Parameters:
      indexNames - the List of indexes to build (names will be escaped).

    • primary

      UsingPath primary()
      Build the primary index (using a name of Index.PRIMARY_NAME, must be in a pending state).