Trait

za.co.absa.pramen.api

Sink

Related Doc: package api

Permalink

trait Sink extends ExternalChannel with AutoCloseable

A sink is an entity where jobs can write to and it won't be under metastore control (e.g. Kafka).

Special Sink jobs are used to write tables from metastore to a sink.

Linear Supertypes
AutoCloseable, ExternalChannel, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Sink
  2. AutoCloseable
  3. ExternalChannel
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close(): Unit

    Permalink

    Sinks can optionally have a method to close it when saving is done or in case of an error.

    Sinks can optionally have a method to close it when saving is done or in case of an error.

    Definition Classes
    Sink → AutoCloseable
    Annotations
    @throws( ... )

  2. abstract def connect(): Unit

    Permalink

    Sinks can optionally have a method to connect to it.

    Sinks can optionally have a method to connect to it.

    Annotations
    @throws( ... )

  3. abstract def send(df: DataFrame, tableName: String, metastore: MetastoreReader, infoDate: LocalDate, options: Map[String, String])(implicit spark: SparkSession): Long

    Permalink

    Sends the given data frame to the sink.

    Sends the given data frame to the sink.

    df

    the dataframe containing data to send to the sink (with all transformations and filters applied).

    tableName

    the name of the table from which the data is coming from.

    metastore

    the metastore reader to read other tables from.

    infoDate

    the information date to use when reading the table from the metastore.

    options

    arbitrary extra options to use for the table (e.g. topic name, etc.)

    returns

    The number of records written if successful, throw an exception otherwise.

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 AutoCloseable

Inherited from ExternalChannel

Inherited from AnyRef

Inherited from Any

Ungrouped