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

Class DefaultWithPath

java.lang.Object

com.couchbase.client.java.query.dsl.path.AbstractPath

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

All Implemented Interfaces:

WithPath, Path, Statement

Direct Known Subclasses:

DefaultUsingWithPath

@Experimental
@Private
public class DefaultWithPath
extends AbstractPath
implements WithPath

See WithPath.

Since:

2.2

Author:

Simon Baslé

Constructor Summary

Constructors

Constructor	Description
DefaultWithPath(AbstractPath parent)

Method Summary

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

Methods inherited from class com.couchbase.client.java.query.dsl.path.AbstractPath

element, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DefaultWithPath

public DefaultWithPath(AbstractPath parent)

Method Details

withNode

public Statement withNode(String nodeName)

Description copied from interface: WithPath

Specify on which node to create a GSI index.

Specified by:

withNode in interface WithPath

Parameters:

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

withNodes

public Statement withNodes(String... nodeNames)

Description copied from interface: WithPath

Specify on which node(s) to create a GSI index.

Specified by:

withNodes in interface WithPath

Parameters:

nodeNames - one or more node names on which to create an index (at least one should be provided).

withNodes

public Statement withNodes(Collection<String> nodeNames)

Description copied from interface: WithPath

Specify on which node(s) to create a GSI index.

Specified by:

withNodes in interface WithPath

Parameters:

nodeNames - a collection of one or more node names on which to create an index (should not be empty).

withDefer

public Statement withDefer()

Description copied from interface: WithPath

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.

Specified by:

withDefer in interface WithPath

withDeferAndNode

public Statement withDeferAndNode(String nodeName)

Description copied from interface: WithPath

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.

Specified by:

withDeferAndNode in interface WithPath

Parameters:

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

withDeferAndNodes

public Statement withDeferAndNodes(String... nodeNames)

Description copied from interface: WithPath

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.

Specified by:

withDeferAndNodes in interface WithPath

Parameters:

nodeNames - one or more node names on which to create an index (at least one should be provided).

withDeferAndNodes

public Statement withDeferAndNodes(Collection<String> nodeNames)

Description copied from interface: WithPath

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.

Specified by:

withDeferAndNodes in interface WithPath

Parameters:

nodeNames - a collection of one or more node names on which to create an index (should not be empty).