Package com.mapr.fs.tables

Interface ExtIndexDesc

All Known Implementing Classes:
ExtIndexDescImpl
public interface ExtIndexDesc

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCluster()
    Returns the cluster identifier of the system.
    String
    getConnectionString()
    For the external system that supports it, returns the connection string, null for native secondary indexes.
    Collection<ExtIndexFieldDesc>
    getCoveredFields()
    Returns a collection of covered fields that are stored in this Index but are not indexed.
    List<ExtIndexFieldDesc>
    getIndexedFields()
    Returns an ordered list of field descriptors which are indexed.
    String
    getIndexFid()
    Returns secondary index table FID.
    String
    getIndexName()
    Returns the fully qualified, canonical name of the index, e.g.
    String
    getPrimaryTablePath()
    Returns primary table path.
    String
    getSystem()
    Returns the name descriptor of the system where the index is hosted, e.g.
    boolean
    isDisabled()
    Returns true if the index is disabled.
    boolean
    isExternal()
    Returns true if the index is not a native MapR-DB index.
    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.

  • Method Details

    • getIndexedFields

      List<ExtIndexFieldDesc> 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.

    • getCoveredFields

      Collection<ExtIndexFieldDesc> getCoveredFields()
      Returns a collection of covered fields that are stored in this Index but are not indexed.

    • 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

      String getPrimaryTablePath()
      Returns primary table path.

    • getIndexFid

      String getIndexFid()
      Returns secondary index table FID.

    • getIndexName

      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

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

    • getCluster

      String getCluster()
      Returns the cluster identifier of the system.

    • getConnectionString

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