Xskipper

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 clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. def describeIndex(): DataFrame

   

   Describes the indexes on the URI (for table URI)

   Describes the indexes on the URI (for table URI)

   returns

   DataFrame object containing information about the index

   Exceptions thrown

   XskipperException if the URI is not indexed

7. def describeIndex(reader: DataFrameReader): DataFrame

   

   Describes the indexes on the URI (for non table URI)

   Describes the indexes on the URI (for non table URI)

   reader

   a DataFrameReader instance to enable reading the URI as a DataFrame

   returns

   DataFrame object containing information about the index

   Exceptions thrown

   XskipperException if the URI is not indexed

8. def dropIndex(): Unit

   

   Deletes the index

   Deletes the index

   Exceptions thrown

   XskipperException if index cannot be removed

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

   

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

12. def generateDescribeIndex(df: DataFrame): DataFrame

    

    return meta index info like indexing scheme and skipping stats

    return meta index info like indexing scheme and skipping stats

    Attributes

    protected

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

    

    Definition Classes

    AnyRef → Any

14. def getLatestQueryStats(): DataFrame

    

    Return latest query skipping statistics for this Xskipper instance

    Return latest query skipping statistics for this Xskipper instance

    In case the API was called on a URI without an index or the API was called without running a query the returned DataFrame structure is - status, reason with status=FAILED In case the query cannot be skipped because one of the following: 1. Dataset has no indexed files 2. No query to the metadata store can be generated - can be due to a predicate that can not be used in skipping (or maybe due to missing metadata filter) or due to failure to translate the abstract query. the returned dataframe structure is: status, isSkippable, skipped_Bytes, skipped_Objs, total_Bytes, total_Objs with status=SUCCESS, isSkippable=false and all other values are -1 Otherwise the DataFrame structure is the same as above with isSkippable=true and the relevant stats

    returns

    DataFrame object containing information about latest query stats

15. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

16. def indexBuilder(): IndexBuilder

    

    Helper class for setting and building an index

17. def isIndexed(): Boolean

    

    Checks if the URI is indexed

    Checks if the URI is indexed

    returns

    true if the URI is indexed

18. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

19. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

20. final def notify(): Unit

    

    Definition Classes

    AnyRef

21. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

22. def refreshIndex(): DataFrame

    

    Refresh index operation for table URI

    Refresh index operation for table URI

    returns

    DataFrame object containing statistics about the refresh operation

    Exceptions thrown

    XskipperException if index cannot be refreshed

23. def refreshIndex(reader: DataFrameReader): DataFrame

    

    Refresh index operation for non table URI

    Refresh index operation for non table URI

    reader

    a DataFrameReader instance to enable reading the URI as a DataFrame Note: The reader is assumed to have all of the parameters configured. reader.load(Seq(<path>)) will be used by the indexing code to read each object separately

    returns

    DataFrame object containing statistics about the refresh operation

    Exceptions thrown

    XskipperException if index cannot be refreshed

24. def setParams(params: Map[String, String]): Unit

    

25. def setParams(params: Map[String, String]): Unit

    

    Update instance specific MetadataHandle parameters

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

    

    Definition Classes

    AnyRef

27. val tableIdentifier: String

    

28. def toString(): String

    

    Definition Classes

    AnyRef → Any

29. val uri: String

    

    the URI of the dataset / the identifier of the table on which the index is defined

30. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

32. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )