Trait

za.co.absa.pramen.api

Transformer

Related Doc: package api

Permalink

trait Transformer extends AnyRef

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

Abstract Value Members

  1. abstract def run(metastore: MetastoreReader, infoDate: LocalDate, options: Map[String, String]): DataFrame

    Permalink

    A job has access to the metastore where it can query tables registered in the configuration.

    A job has access to the metastore where it can query tables registered in the configuration.

    If task fails it should throw a runtime exception.

    Do not add information date column to the output dataframe. It will be added automatically. If the information date column exists in the output dataframe, it will be deleted and replaced by the framework.

    metastore

    The read only version of metastore. You can only query tables using it.

    infoDate

    The information date of the output of the transformation.

    options

    Extra options specified in the configuration for the transformation.

    returns

    The output DataFrame

  2. abstract def validate(metastore: MetastoreReader, infoDate: LocalDate, options: Map[String, String]): Reason

    Permalink

    Validates if the transformation can run.

    Validates if the transformation can run.

    If the transformation can run for the given information date, it should return Reason.Ready.

    If requirements are not met the validation routine should do one of teh following: - return Reason.NotReady - this means some input data is missing, but the transformation can run in the future when the requirements are met - return Reason.Skip - this means the running of the transformation should be completely skipped. - throw an exception - this will result in the same behavior as returning Reason.NotReady

    metastore

    The read only version of metastore. You can only query tables using it.

    infoDate

    The information date of the output of the transformation.

    options

    Extra options specified in the configuration for the transformation.

    returns

    Reason as the validation result.

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