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

Class IndexReference

java.lang.Object

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

@Experimental
@Public
public class IndexReference
extends Object

IndexReference wraps an index name and an index type (with the `USING GSI|VIEW` syntax).

Since:

2.2

Author:

Simon Baslé

See Also:

indexRef(String), indexRef(String, IndexType)

Method Summary

Modifier and Type	Method	Description
static IndexReference	indexRef(String indexName)	Constructs an IndexReference given an index name (which will be escaped).
static IndexReference	indexRef(String indexName, IndexType type)	Constructs an IndexReference given an index name (which will be escaped) and an explicit IndexType to use in a USING clause.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

toString

public String toString()

Overrides:

toString in class Object

indexRef

public static final IndexReference indexRef(String indexName)

Constructs an IndexReference given an index name (which will be escaped). No USING clause is set explicitely.

indexRef

public static final IndexReference indexRef(String indexName,
IndexType type)

Constructs an IndexReference given an index name (which will be escaped) and an explicit IndexType to use in a USING clause.