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

Interface WithPath

All Superinterfaces:
Path, Statement
All Known Subinterfaces:
UsingWithPath, WherePath
All Known Implementing Classes:
DefaultUsingWithPath, DefaultWherePath, DefaultWithPath
@Experimental
@Public
public interface WithPath
extends Path, Statement
With path of the Index creation DSL (setting options).
Since:
2.2
Author:
Simon Baslé
See Also:
WithIndexOptionElement

  • Method Details

    • withNode

      @Deprecated Statement withNode​(String nodeName)
      Deprecated.
      you can call withNodes(String...) with a single entry instead.
      Specify on which node to create a GSI index.
      Parameters:
      nodeName - the name of a single node on which to create an index.

    • withNodes

      Statement withNodes​(String... nodeNames)
      Specify on which node(s) to create a GSI index.
      Parameters:
      nodeNames - one or more node names on which to create an index (at least one should be provided).

    • withNodes

      Statement withNodes​(Collection<String> nodeNames)
      Specify on which node(s) to create a GSI index.
      Parameters:
      nodeNames - a collection of one or more node names on which to create an index (should not be empty).

    • withDefer

      Statement withDefer()
      Specify that the index creation should be deferred to later, allowing to create multiple index and then build them all at once in one scan/swipe.

    • withDeferAndNode

      Statement withDeferAndNode​(String nodeName)
      Deprecated.
      you can call withDeferAndNodes(String...) with a single entry instead.
      Sets both index creation supported options : specify that the index creation should be deferred and give the name of the node on which to create a GSI index.
      Parameters:
      nodeName - the name of the node on which to create an index.

    • withDeferAndNodes

      Statement withDeferAndNodes​(String... nodeNames)
      Sets both index creation supported options : specify that the index creation should be deferred and give the name of the node(s) on which to create a GSI index.
      Parameters:
      nodeNames - one or more node names on which to create an index (at least one should be provided).

    • withDeferAndNodes

      Statement withDeferAndNodes​(Collection<String> nodeNames)
      Sets both index creation supported options : specify that the index creation should be deferred and give the name of the node(s) on which to create a GSI index.
      Parameters:
      nodeNames - a collection of one or more node names on which to create an index (should not be empty).