stream-loader < Back

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 file
Definition Classes
sink
BaseFileBuilder
Compression
CountingOutputStream
FileBuilder
FileBuilderFactory
FileCommitStrategy
FilePathFormatter
FileRecordBatch
FileRecordBatcher
FileStats
MultiFileCommitStrategy
PartitionedFileRecordBatch
PartitioningFileRecordBatcher
SingleFileRecordBatch
StreamFileBuilder
TimePartitioningFilePathFormatter

com.adform.streamloader.sink.file

FilePathFormatter

trait FilePathFormatter[-P] extends AnyRef

Base trait used to construct file paths when storing files to persistent storages.

Linear Supertypes

AnyRef, Any

Known Subclasses

TimePartitioningFilePathFormatter

Ordering

Alphabetic
By Inheritance

Inherited

FilePathFormatter
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def formatPath(partition: P, recordRanges: Seq[StreamRange]): String
Constructs a file path given the partition and ranges of records contained in the file.
Constructs a file path given the partition and ranges of records contained in the file.
partition
The partition of records in the file.
recordRanges
Ranges of records in the file.
returns
A relative path for the file.

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

Packages

FilePathFormatter

trait FilePathFormatter[-P] extends AnyRef

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

FilePathFormatter

trait FilePathFormatter[-P] extends AnyRef

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

FilePathFormatter