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

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public interface WithPath
extends Path, Statement

With path of the Index creation DSL (setting options).

Since:

2.2

See Also:

WithIndexOptionElement

Method Summary

Modifier and Type	Method and Description
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.
Statement	withDeferAndNode(String nodeName) 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.
Statement	withNode(String nodeName) Specify on which node to create a GSI index.

Method Detail

withNode

Statement withNode(String nodeName)

Specify on which node to create a GSI index.

Parameters:

nodeName - the name of the node on which to create an index.

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)

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.