Trait

za.co.absa.pramen.api

MetastoreReader

Related Doc: package api

Permalink

trait MetastoreReader extends AnyRef

Metastore reader allows querying tables registered at the 'metastore' section of the configuration. It abstracts away the storage provider (HDFS, S3, etc), format (Parquet, Delta, etc.) and partitioning options.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MetastoreReader
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def getLatest(tableName: String, until: Option[LocalDate] = None): DataFrame

    Permalink

    Reads the latest partition of a given table.

    Reads the latest partition of a given table.

    In order to read a table it is not sufficient the table to be registered in the metastore. It also should be defined as input tables of the job. Otherwise, a runtime exception will be thrown.

    tableName

    The name of the table to read.

    until

    An optional upper boundary. When you run historical transformations you might want to limit the recency of input data. Uses the current information date if None.

    returns

    The dataframe containing data from the table.

  2. abstract def getLatestAvailableDate(tableName: String, until: Option[LocalDate] = None): Option[LocalDate]

    Permalink

    Returns the latest information date the table has data for.

    Returns the latest information date the table has data for.

    In order to read a table it is not sufficient the table to be registered in the metastore. It also should be defined as input tables of the job. Otherwise, a runtime exception will be thrown.

    tableName

    The name of the table to read.

    until

    An optional upper boundary. When you run historical transformations you might want to limit the recency of input data.

    returns

    The latest information date the table has data for, None otherwise.

  3. abstract def getTable(tableName: String, infoDateFrom: Option[LocalDate] = None, infoDateTo: Option[LocalDate] = None): DataFrame

    Permalink

    Reads a table given th range of information dates, and returns back the dataframe.

    Reads a table given th range of information dates, and returns back the dataframe.

    In order to read a table it is not sufficient the table to be registered in the metastore. It also should be defined as input tables of the job. Otherwise, a runtime exception will be thrown.

    tableName

    The name of the table to read.

    infoDateFrom

    The starting info date to fetch data from (inclusive). Uses the current information date if None.

    infoDateTo

    The ending info date (inclusive). Uses the current information date if None.

    returns

    The dataframe containing data from the table.

  4. abstract def isDataAvailable(tableName: String, from: Option[LocalDate], until: Option[LocalDate]): Boolean

    Permalink

    Returns true if data for the specified table is available for the specified range.

    Returns true if data for the specified table is available for the specified range.

    This method can be used for validations.

    tableName

    The name of the table to read.

    from

    The starting info date of the availability of the table (inclusive).

    until

    An upper boundary. When you run historical transformations you might want to limit the recency of input data.

    returns

    true if data is available for the specified range.

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped