Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package adform
    Definition Classes
    com
  • package streamloader

    The entry point of the stream loader library is the StreamLoader class, which requires a $KafkaSource and a $Sink.

    The entry point of the stream loader library is the StreamLoader class, which requires a $KafkaSource and a $Sink. Once started it will subscribe to the provided topics and will start polling and sinking records. The sink has to be able to persist records and to look up committed offsets (technically this is optional, but without it there would be no way to provide any delivery guarantees). A large class of sinks are batch based, implemented as $RecordBatchingSink. This sink accumulate batches of records using some $RecordBatcher and once ready, stores them to some underlying $RecordBatchStorage. A common type of batch is file based, i.e. a batcher might write records to a temporary file and once the file is full the sink commits the file to some underlying storage, such as a database or a distributed file system like HDFS.

    A sketch of the class hierarchy illustrating the main classes and interfaces can be seen below.



    For concrete storage implementations see the clickhouse, hadoop, s3 and vertica packages. They also contain more file builder implementations than just the $CsvFileBuilder included in the core library.

    Definition Classes
    adform
  • package sink
    Definition Classes
    streamloader
  • package batch
    Definition Classes
    sink
  • package storage
    Definition Classes
    batch
  • AppendableRecordBatch
  • RecordBatch
  • RecordBatchBuilder
  • RecordBatcher
  • RecordBatchingSink
  • RecordBatchingSinker
  • RecordFormatter
  • RecordPartitioner
  • RecordStreamWriter
c

com.adform.streamloader.sink.batch

RecordBatchBuilder

abstract class RecordBatchBuilder[+B <: RecordBatch] extends AnyRef

A record batch builder, the base implementation takes care of keeping track of contained record ranges. Concrete implementations should additionally implement actual batch construction.

B

Type of the batches being built.

Linear Supertypes
AnyRef, Any
Known Subclasses
IcebergRecordBatchBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RecordBatchBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RecordBatchBuilder()

Abstract Value Members

  1. abstract def addToBatch(record: StreamRecord): Int

    Adds a record to the underlying batch and returns the number of records actually added.

    Adds a record to the underlying batch and returns the number of records actually added.

    Attributes
    protected
  2. abstract def build(): Option[B]

    Finalizes and outputs the batch.

    Finalizes and outputs the batch. Returns None if no records were added to the batch.

  3. abstract def discard(): Unit

    Discards the current batch, performs any necessary cleanup.

  4. abstract def isBatchReady: Boolean

    Checks whether the current batch is ready.

    Checks whether the current batch is ready. Concrete implementations can check whether the batch contains a certain amount of records or some time has passed since batch creation, etc.

Concrete 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. def add(record: StreamRecord): Int

    Adds a new record to the current batch.

    Adds a new record to the current batch. Keeps track of record ranges in the batch and delegates the actual adding to addToBatch.

    record

    Record to add to batch.

    returns

    Actual number of records added to the batch.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def currentRecordRanges: Seq[StreamRange]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped