Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

5.  def cancel(indexName: String): Unit

   Cancel API to bring back index from an inconsistent state to the last known stable state.

   Cancel API to bring back index from an inconsistent state to the last known stable state. E.g. if index fails during creation, in "CREATING" state. The index will not allow any index modifying operations unless a cancel is called.

   Note: Cancel from "VACUUMING" state will move it forward to "DOESNOTEXIST" state. Note: If no previous stable state exists, cancel will move it to "DOESNOTEXIST" state.

   indexName

   Name of the index to cancel.

6.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @native() @throws( ... )

7.  def createIndex(df: DataFrame, indexConfig: IndexConfig): Unit

   Create index.

   Create index.

   df

   the DataFrame object to build index on.

   indexConfig

   the configuration of index to be created.

8.  def deleteIndex(indexName: String): Unit

   Soft deletes the index with given index name.

   Soft deletes the index with given index name.

   indexName

   the name of index to delete.

9.  final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

10.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

11.  def explain(df: DataFrame, verbose: Boolean = false)(implicit redirectFunc: (String) ⇒ Unit = print): Unit

    Explains how indexes will be applied to the given dataframe.

    Explains how indexes will be applied to the given dataframe.

    df

    dataFrame.

    verbose

    Flag to enable verbose mode.

    redirectFunc

    optional function to redirect output of explain.

12.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

13.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

14.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

15.  def index(indexName: String): DataFrame

    Get index metadata and detailed index statistics for a given index.

    Get index metadata and detailed index statistics for a given index.

    indexName

    Name of the index to get stats for.

    returns

    Index metadata and statistics as a DataFrame.

16.  def indexes: DataFrame

    Collect all the index metadata.

    Collect all the index metadata.

    returns

    all index metadata as a DataFrame.

17.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

18.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

19.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

20.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

21.  def optimizeIndex(indexName: String, mode: String): Unit

    Optimize index by changing the underlying index data layout (e.g., compaction).

    Optimize index by changing the underlying index data layout (e.g., compaction).

    Note: This API does NOT refresh (i.e. update) the index if the underlying data changes. It only rearranges the index data into a better layout, by compacting small index files. The index files larger than a threshold remain untouched to avoid rewriting large contents.

    Available modes: Quick mode: This mode allows for fast optimization. Files smaller than a predefined threshold "spark.hyperspace.index.optimize.fileSizeThreshold" will be picked for compaction.

    Full mode: This allows for slow but complete optimization. ALL index files are picked for compaction.

    indexName

    Name of the index to optimize.

    mode

    Index optimization mode. "quick" refers to optimization of only small index files, based on a threshold. "full" refers to recreation of index.

22.  def optimizeIndex(indexName: String): Unit

    Optimize index by changing the underlying index data layout (e.g., compaction).

    Optimize index by changing the underlying index data layout (e.g., compaction).

    Note: This API does NOT refresh (i.e. update) the index if the underlying data changes. It only rearranges the index data into a better layout, by compacting small index files. The index files larger than a threshold remain untouched to avoid rewriting large contents.

    Quick optimize mode is used by default.

    indexName

    Name of the index to optimize.

23.  def refreshIndex(indexName: String, mode: String): Unit

    Update indexes for the latest version of the data.

    Update indexes for the latest version of the data. This API provides a few supported refresh modes as listed below.

    indexName

    Name of the index to refresh.

    mode

    Refresh mode. Currently supported modes are incremental and full.

24.  def refreshIndex(indexName: String): Unit

    Update indexes for the latest version of the data.

    Update indexes for the latest version of the data.

    indexName

    Name of the index to refresh.

25.  def restoreIndex(indexName: String): Unit

    Restores index with given index name.

    Restores index with given index name.

    indexName

    Name of the index to restore.

26.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

27.  def toString(): String

    Definition Classes

    AnyRef → Any

28.  def vacuumIndex(indexName: String): Unit

    Does hard delete of indexes marked as DELETED.

    Does hard delete of indexes marked as DELETED.

    indexName

    Name of the index to restore.

29.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

30.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

31.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )