Class

io.xskipper.metadatastore.parquet

ParquetMetadataHandle

Related Doc: package parquet

Permalink

class ParquetMetadataHandle extends MetadataHandle with Logging with Serializable

Linear Supertypes
Serializable, Serializable, Logging, MetadataHandle, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParquetMetadataHandle
  2. Serializable
  3. Serializable
  4. Logging
  5. MetadataHandle
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ParquetMetadataHandle(session: SparkSession, tableIdentifier: String)

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clean(): Unit

    Permalink

    Cleans the MetadataHandle instance (implementation specific)

    Cleans the MetadataHandle instance (implementation specific)

    Definition Classes
    MetadataHandle
  6. def clearStats(): Unit

    Permalink

    Clears the latest stats

    Clears the latest stats

    Definition Classes
    MetadataHandle
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def dropAllMetadata(): Unit

    Permalink

    Drops all of the metadata associated with the given index

    Drops all of the metadata associated with the given index

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def finalizeMetadataUpload(): Unit

    Permalink

    Finalize metadata creation in the metadatastore (implementation specific)

    Finalize metadata creation in the metadatastore (implementation specific)

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  13. def getAllIndexedFiles(): Future[Set[String]]

    Permalink

    Returns a set of all indexed files (async)

    Returns a set of all indexed files (async)

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def getDeletionChunkSize(): Int

    Permalink

    returns

    Maximum number of objects to delete in one chunk

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  16. def getIndexStatus(): IndexStatusResult

    Permalink

    Returns index statistics

    Returns index statistics

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  17. def getIndexes(): Seq[Index]

    Permalink

    returns the sequence of indexes that exist in the metadatastore for the tableIdentifier

    returns the sequence of indexes that exist in the metadatastore for the tableIdentifier

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  18. def getMdVersionStatus(): MetadataVersionStatus

    Permalink

    returns the version status of the metadata.

    returns the version status of the metadata. we do not have a strict requirement for the metadatastore to use metadata from a version different than its current version for filtering / refresh but we do expect it to be able to tell the version status, and whether or not it can be upgraded to comply with the current version.

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  19. def getNumberOfIndexedObjects(): Long

    Permalink

    Gets the number of indexed objects

    Gets the number of indexed objects

    returns

    the number of indexed objects

  20. def getRequiredObjects(query: Any): Future[Set[String]]

    Permalink

    Returns the required file ids for the given query (async)

    Returns the required file ids for the given query (async)

    query

    the query to be used in order to get the relevant files (this query is of type Any and it is the responsibility of the metadatastore implementation to cast it to as instance which matches the translation for this MetaDataStore)

    returns

    the set of fileids required for this query

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  21. def getStats(): Option[QueryIndexStatsResult]

    Permalink
    Definition Classes
    MetadataHandle
  22. def getUploadChunkSize(): Int

    Permalink

    returns

    Maximum number of objects to index in one chunk

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  24. def indexExists(): Boolean

    Permalink

    Returns true if an index exists for the tableIdentifier

    Returns true if an index exists for the tableIdentifier

    returns

    true if the an index exists for the tableIdentifier

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  25. def initMetadataUpload(indexes: Seq[Index]): Unit

    Permalink

    Initialize metadata for a dataset in the metadatastore (implementation specific)

    Initialize metadata for a dataset in the metadatastore (implementation specific)

    indexes

    a sequence of metadata indexes

    Definition Classes
    MetadataHandle
  26. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  27. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  28. def isEncryptionSupported(): Boolean

    Permalink

    Returns whether or not this MetadataHandle supports encryption

    Returns whether or not this MetadataHandle supports encryption

    returns

    true if the MetadataHandle supports encryption

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def isMetadataUpgradePossible(): Boolean

    Permalink

    returns whether or not the metadata can be upgraded to comply with the current version

    returns whether or not the metadata can be upgraded to comply with the current version

    returns

    true if the metadata can be upgraded, false otherwise

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  31. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  32. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  33. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  34. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  35. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  36. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  37. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  38. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  39. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  40. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  41. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  42. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  43. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  44. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  45. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  47. def refresh(): Unit

    Permalink

    Refreshes the MetadataHandle by re-syncing with the metadatastore (implementation specific)

    Refreshes the MetadataHandle by re-syncing with the metadatastore (implementation specific)

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  48. def removeMetaDataForFiles(files: Seq[String]): Unit

    Permalink

    Removes the metadata for a sequence of files.

    Removes the metadata for a sequence of files. This method may assume that the Metadta version status is MetadataVersionStatus.CURRENT

    files

    a sequence of files for which the metadata will be removed

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  49. val session: SparkSession

    Permalink
  50. def setMDPath(md: String, type: String): ParquetMetadataHandle

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

    Permalink

    Set metadataStore specific parameters such as user, password, host Note: the implementation should not count on the Map not changing during the run therefore, it needs to save its parameters locally

    Set metadataStore specific parameters such as user, password, host Note: the implementation should not count on the Map not changing during the run therefore, it needs to save its parameters locally

    params

    a map of parameters (each metadata store expects certain input)

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  52. final def setParams(params: Map[String, String]): Unit

    Permalink
    Definition Classes
    MetadataHandle
  53. var stats: Option[QueryIndexStatsResult]

    Permalink
    Attributes
    protected
    Definition Classes
    MetadataHandle
  54. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  55. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  56. def updateQueryStats(currentFilterStatistics: QueryIndexStatsResult): Unit

    Permalink

    Updates the MetadataHandle stats with the given query stats called from the dataSkippingFileIndex rule in the catalyst to update the stats during the query tun time

    Updates the MetadataHandle stats with the given query stats called from the dataSkippingFileIndex rule in the catalyst to update the stats during the query tun time

    currentFilterStatistics

    the updated stats

    Definition Classes
    MetadataHandle
  57. def upgradeMetadata(indexes: Seq[Index]): Unit

    Permalink

    Upgrades the metadata to comply with the current version

    Upgrades the metadata to comply with the current version

    indexes

    - the indexes stored in the metadataStore.

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  58. def uploadMetadata(metaData: RDD[Row], indexes: Seq[Index], isRefresh: Boolean): Unit

    Permalink

    Uploads the metadata to the metadatastore This method may assume that the metadata version status is MetadataVersionStatus.CURRENT

    Uploads the metadata to the metadatastore This method may assume that the metadata version status is MetadataVersionStatus.CURRENT

    metaData

    RDD that contains for each file a list of abstract metaData types to be uploaded

    indexes

    a sequence of indexes that created the metadata

    isRefresh

    indicates whether the operation is a refresh operation

    Definition Classes
    ParquetMetadataHandleMetadataHandle
  59. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Logging

Inherited from MetadataHandle

Inherited from AnyRef

Inherited from Any

Ungrouped