io.druid.segment.realtime.plumber

Interface Plumber

All Known Implementing Classes:

AppenderatorPlumber, FlushingPlumber, RealtimePlumber

public interface Plumber

Method Summary

Modifier and Type	Method and Description
int	add(InputRow row, com.google.common.base.Supplier<Committer> committerSupplier)
void	finishJob() Perform any final processing and clean up after ourselves.
<T> QueryRunner<T>	getQueryRunner(Query<T> query)
void	persist(Committer committer) Persist any in-memory indexed data to durable storage.
Object	startJob() Perform any initial setup.

Method Detail

startJob

Object startJob()

Perform any initial setup. Should be called before using any other methods, and should be paired with a corresponding call to finishJob().

Returns:

the metadata of the "newest" segment that might have previously been persisted

add

int add(InputRow row,
        com.google.common.base.Supplier<Committer> committerSupplier)
 throws IndexSizeExceededException

Parameters:

row - the row to insert

committerSupplier - supplier of a committer associated with all data that has been added, including this row

Returns:

- positive numbers indicate how many summarized rows exist in the index for that timestamp, -1 means a row was thrown away because it was too late

Throws:

IndexSizeExceededException

getQueryRunner

<T> QueryRunner<T> getQueryRunner(Query<T> query)

persist

void persist(Committer committer)

Persist any in-memory indexed data to durable storage. This may be only somewhat durable, e.g. the machine's local disk.

Parameters:

committer - committer to use after persisting data

finishJob

void finishJob()

Perform any final processing and clean up after ourselves. Should be called after all data has been fed into sinks and persisted.