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 clickhouse
    Definition Classes
    streamloader
  • package rowbinary
    Definition Classes
    clickhouse
  • ClickHouseFileBuilder
  • ClickHouseFileBuilderFactory
  • ClickHouseFileRecordBatch
  • ClickHouseFileRecordBatcher
  • ClickHouseFileStorage
c

com.adform.streamloader.clickhouse

ClickHouseFileRecordBatch

case class ClickHouseFileRecordBatch(file: File, format: ClickHouseFormat, fileCompression: Compression, recordRanges: Seq[StreamRange], rowCount: Long) extends FileRecordBatch with Product with Serializable

A file containing a batch of records in some ClickHouse supported format that can be loaded to ClickHouse.

Linear Supertypes
Serializable, Product, Equals, FileRecordBatch, RecordBatch, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClickHouseFileRecordBatch
  2. Serializable
  3. Product
  4. Equals
  5. FileRecordBatch
  6. RecordBatch
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ClickHouseFileRecordBatch(file: File, format: ClickHouseFormat, fileCompression: Compression, recordRanges: Seq[StreamRange], rowCount: Long)

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def discard(): Boolean

    Performs any necessary cleanup after the batch is no longer needed, e.g.

    Performs any necessary cleanup after the batch is no longer needed, e.g. deletes any underlying files.

    returns

    Whether the discard operation succeeded.

    Definition Classes
    FileRecordBatch → RecordBatch
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val file: File
    Definition Classes
    ClickHouseFileRecordBatch → FileRecordBatch
  9. val fileCompression: Compression
  10. val format: ClickHouseFormat
  11. final def getClass(): Class[_ <: AnyRef]
    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. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. val recordRanges: Seq[StreamRange]

    Gets the ranges of records in each topic partition contained in the batch.

    Gets the ranges of records in each topic partition contained in the batch.

    Definition Classes
    ClickHouseFileRecordBatch → RecordBatch
  18. val rowCount: Long
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from FileRecordBatch

Inherited from RecordBatch

Inherited from AnyRef

Inherited from Any

Ungrouped