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

Class DefaultCreateIndexPath

java.lang.Object

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

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

All Implemented Interfaces:

CreateIndexPath, Path

@Experimental
@Private
public class DefaultCreateIndexPath
extends AbstractPath
implements CreateIndexPath

See CreateIndexPath.

Since:

2.2

Author:

Simon Baslé

Constructor Summary

Constructors

Constructor	Description
DefaultCreateIndexPath()

Method Summary

Modifier and Type	Method	Description
OnPath	create(String indexName)	Create a secondary index.
OnPrimaryPath	createPrimary()	Create a primary index.
OnPrimaryPath	createPrimary(String customPrimaryName)	Create a primary index with a custom name.

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

DefaultCreateIndexPath

public DefaultCreateIndexPath()

Method Details

create

public OnPath create(String indexName)

Description copied from interface: CreateIndexPath

Create a secondary index.

Specified by:

create in interface CreateIndexPath

Parameters:

indexName - the name of the secondary index to be created. It will automatically be escaped.

createPrimary

public OnPrimaryPath createPrimary()

Description copied from interface: CreateIndexPath

Create a primary index.

Specified by:

createPrimary in interface CreateIndexPath

createPrimary

public OnPrimaryPath createPrimary(String customPrimaryName)

Description copied from interface: CreateIndexPath

Create a primary index with a custom name.

Specified by:

createPrimary in interface CreateIndexPath

Parameters:

customPrimaryName - the custom name for the primary index.