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

Interface CreateIndexPath

All Superinterfaces:

Path

All Known Implementing Classes:

DefaultCreateIndexPath

@Experimental
@Public
public interface CreateIndexPath
extends Path

Starting path of the Index creation DSL.

Since:

2.2

Author:

Simon Baslé

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.

Method Details

create

OnPath create(String indexName)

Create a secondary index.

Parameters:

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

createPrimary

OnPrimaryPath createPrimary()

Create a primary index.

createPrimary

OnPrimaryPath createPrimary(String customPrimaryName)

Create a primary index with a custom name.

Parameters:

customPrimaryName - the custom name for the primary index.