public interface IndexDesc
extends org.ojai.JsonString
Modifier and Type | Interface and Description |
---|---|
static class |
IndexDesc.MissingAndNullOrdering |
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. |
java.util.List<IndexFieldDesc> getIndexedFields()
java.util.Collection<IndexFieldDesc> getIncludedFields()
boolean isHashed()
true
if the index is hashed.boolean isUnique()
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.boolean isExternal()
true
if the index is not a native MapR-DB index.boolean isDisabled()
true
if the index is disabled.java.lang.String getPrimaryTablePath()
java.lang.String getIndexFid()
java.lang.String getIndexName()
java.lang.String getSystem()
java.lang.String getCluster()
java.lang.String getConnectionString()
null
for native secondary indexes.int getNumHashPartitions()
com.mapr.fs.proto.Dbserver.SIndexInfo getIndexInfo()
com.mapr.fs.proto.Dbserver.SIndexInfo.Version getIndexVersion()
boolean isFullIndex()
boolean isArrayIndex()
IndexDesc.MissingAndNullOrdering getMissingAndNullOrdering()
IndexDesc.MissingAndNullOrdering
for this index.