com.mapr.db.index

Interface IndexDesc

All Superinterfaces:

org.ojai.JsonString

public interface IndexDesc
extends org.ojai.JsonString

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IndexDesc.MissingAndNullOrdering

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCluster() Returns the cluster identifier of the system.
java.lang.String	getConnectionString() For the external system that supports it, returns the connection string, null for native secondary indexes.
java.util.Collection<IndexFieldDesc>	getIncludedFields() Returns a collection of covered fields that are stored in this Index but are not indexed.
java.util.List<IndexFieldDesc>	getIndexedFields() Returns an ordered list of field descriptors which are indexed.
java.lang.String	getIndexFid() Returns secondary index table FID.
com.mapr.fs.proto.Dbserver.SIndexInfo	getIndexInfo() Returns the IndexInfo object
java.lang.String	getIndexName() Returns the fully qualified, canonical name of the index, e.g.
com.mapr.fs.proto.Dbserver.SIndexInfo.Version	getIndexVersion() Returns the Index version object
IndexDesc.MissingAndNullOrdering	getMissingAndNullOrdering() Return IndexDesc.MissingAndNullOrdering for this index.
int	getNumHashPartitions() Returns the number of hash partitions for hashed index, 0 otherwise.
java.lang.String	getPrimaryTablePath() Returns primary table path.
java.lang.String	getSystem() Returns the name descriptor of the system where the index is hosted, e.g.
boolean	isArrayIndex() Returns true if this is a array index
boolean	isDisabled() Returns true if the index is disabled.
boolean	isExternal() Returns true if the index is not a native MapR-DB index.
boolean	isFullIndex() Returns true if this is a full index
boolean	isHashed() Returns true if the index is hashed.
boolean	isUnique() Returns true if the values of the indexed field or the combination of fields in case of composite index, are unique across all documents in the table.

Methods inherited from interface org.ojai.JsonString

asJsonString, asJsonString

Method Detail

getIndexedFields

java.util.List<IndexFieldDesc> getIndexedFields()

Returns an ordered list of field descriptors which are indexed. For single field indexes, this list contains exactly one element while for composite indexes, it will contain one element for each field in the composite index, in the order they appear in the index.

getIncludedFields

java.util.Collection<IndexFieldDesc> getIncludedFields()

Returns a collection of covered fields that are stored in this Index but are not indexed.

isHashed

boolean isHashed()

Returns true if the index is hashed.

isUnique

boolean isUnique()

Returns true if the values of the indexed field or the combination of fields in case of composite index, are unique across all documents in the table.

isExternal

boolean isExternal()

Returns true if the index is not a native MapR-DB index.

isDisabled

boolean isDisabled()

Returns true if the index is disabled.

getPrimaryTablePath

java.lang.String getPrimaryTablePath()

Returns primary table path.

getIndexFid

java.lang.String getIndexFid()

Returns secondary index table FID.

getIndexName

java.lang.String getIndexName()

Returns the fully qualified, canonical name of the index, e.g. path of the native secondary index in MapR-DB. For external secondary indexes, the format will be dependent on the external system.

getSystem

java.lang.String getSystem()

Returns the name descriptor of the system where the index is hosted, e.g. "maprdb" for native secondary index.

getCluster

java.lang.String getCluster()

Returns the cluster identifier of the system.

getConnectionString

java.lang.String getConnectionString()

For the external system that supports it, returns the connection string, null for native secondary indexes.

getNumHashPartitions

int getNumHashPartitions()

Returns the number of hash partitions for hashed index, 0 otherwise.

getIndexInfo

com.mapr.fs.proto.Dbserver.SIndexInfo getIndexInfo()

Returns the IndexInfo object

getIndexVersion

com.mapr.fs.proto.Dbserver.SIndexInfo.Version getIndexVersion()

Returns the Index version object

isFullIndex

boolean isFullIndex()

Returns true if this is a full index

isArrayIndex

boolean isArrayIndex()

Returns true if this is a array index

getMissingAndNullOrdering

IndexDesc.MissingAndNullOrdering getMissingAndNullOrdering()

Return IndexDesc.MissingAndNullOrdering for this index.