Package com.couchbase.client.java.query.util

Class IndexInfo

java.lang.Object

com.couchbase.client.java.query.util.IndexInfo

public class IndexInfo
extends Object

Contains meta-information about a N1QL index.

Since:

2.2

Author:

Simon Baslé

Field Summary

Fields

Modifier and Type	Field	Description
static String	PRIMARY_DEFAULT_NAME

Constructor Summary

Constructors

Constructor	Description
IndexInfo(JsonObject raw)

Method Summary

Modifier and Type	Method	Description
String	condition()	Return the String representation of the index's condition (the WHERE clause of the index), or an empty String if no condition was set.
boolean	equals(Object o)
int	hashCode()
JsonArray	indexKey()	Return an array of Strings that represent the index key(s).
boolean	isPrimary()
String	keyspace()
String	name()
String	namespace()
JsonObject	raw()
String	rawType()
String	state()
String	toString()
IndexType	type()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PRIMARY_DEFAULT_NAME

public static final String PRIMARY_DEFAULT_NAME

See Also:

Constant Field Values

Constructor Details

IndexInfo

public IndexInfo(JsonObject raw)

Method Details

isPrimary

public boolean isPrimary()

name

public String name()

type

public IndexType type()

Returns:

the IndexType enum corresponding to this index, or null if the type couldn't be parsed, in which case rawType() can be used to see which type string is advertised by the query service.

rawType

public String rawType()

Returns:

the raw type string advertised by the query service for this index. Can be useful for unknown types that couldn't be parsed into a IndexType for type().

state

public String state()

keyspace

public String keyspace()

Returns:

the keyspace for the index, typically the bucket name.

namespace

public String namespace()

Returns:

the namespace for the index. A namespace is a resource pool that contains multiple keyspaces.

See Also:

keyspace()

indexKey

public JsonArray indexKey()

Return an array of Strings that represent the index key(s). The array is empty in the case of a PRIMARY INDEX. Note that the query service can present the key in a slightly different manner from when you declared the index: for instance, it will show the indexed fields in an escaped format (surrounded by backticks).

Returns:

an array of Strings that represent the index key(s), or an empty array in the case of a PRIMARY index.

condition

public String condition()

Return the String representation of the index's condition (the WHERE clause of the index), or an empty String if no condition was set. Note that the query service can present the condition in a slightly different manner from when you declared the index: for instance it will wrap expressions with parentheses and show the fields in an escaped format (surrounded by backticks).

Returns:

the condition/WHERE clause of the index or empty string if none.

raw

public JsonObject raw()

Returns:

the raw JSON representation of the index information, as returned by the query service.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object