Package org.apache.druid.segment.realtime.sink

Class Sink

java.lang.Object

org.apache.druid.segment.realtime.sink.Sink

All Implemented Interfaces:

Iterable<FireHydrant>, Overshadowable<Sink>

public class Sink
extends Object
implements Iterable<FireHydrant>, Overshadowable<Sink>

Constructor Summary

Constructors

Constructor	Description
Sink(org.joda.time.Interval interval, DataSchema schema, ShardSpec shardSpec, String version, AppendableIndexSpec appendableIndexSpec, int maxRowsInMemory, long maxBytesInMemory)
Sink(org.joda.time.Interval interval, DataSchema schema, ShardSpec shardSpec, String version, AppendableIndexSpec appendableIndexSpec, int maxRowsInMemory, long maxBytesInMemory, List<FireHydrant> hydrants)

Method Summary

Modifier and Type	Method	Description
List<SinkSegmentReference>	acquireSegmentReferences(SegmentMapFunction segmentMapFn, boolean skipIncrementalSegment)	Acquire references to all FireHydrant that represent this sink.
IncrementalIndexAddResult	add(InputRow row)
boolean	canAppendRow()
boolean	finished()
boolean	finishWriting()	Marks sink as 'finished', preventing further writes.
short	getAtomicUpdateGroupSize()
long	getBytesInMemory()
FireHydrant	getCurrHydrant()
int	getEndRootPartitionId()
org.joda.time.Interval	getInterval()
short	getMinorVersion()
int	getNumRows()
int	getNumRowsInMemory()
DataSegment	getSegment()
RowSignature	getSignature()	Get column information from all the FireHydrant's.
int	getStartRootPartitionId()
String	getVersion()
boolean	isEmpty()
boolean	isWritable()
Iterator<FireHydrant>	iterator()
boolean	overshadows(Sink other)
FireHydrant	swap()	If currHydrant is A, creates a new index B, sets currHydrant to B and returns A.
boolean	swappable()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.apache.druid.timeline.Overshadowable

containsRootPartition, hasData

Constructor Details

Sink

public Sink(org.joda.time.Interval interval,
 DataSchema schema,
 ShardSpec shardSpec,
 String version,
 AppendableIndexSpec appendableIndexSpec,
 int maxRowsInMemory,
 long maxBytesInMemory)

Sink

public Sink(org.joda.time.Interval interval,
 DataSchema schema,
 ShardSpec shardSpec,
 String version,
 AppendableIndexSpec appendableIndexSpec,
 int maxRowsInMemory,
 long maxBytesInMemory,
 List<FireHydrant> hydrants)

Method Details

getInterval

public org.joda.time.Interval getInterval()

getCurrHydrant

public FireHydrant getCurrHydrant()

add

public IncrementalIndexAddResult add(InputRow row)

canAppendRow

public boolean canAppendRow()

isEmpty

public boolean isEmpty()

isWritable

public boolean isWritable()

swap

public FireHydrant swap()

If currHydrant is A, creates a new index B, sets currHydrant to B and returns A.

Returns:

the current index after swapping in a new one

swappable

public boolean swappable()

finished

public boolean finished()

finishWriting

public boolean finishWriting()

Marks sink as 'finished', preventing further writes.

Returns:

'true' if sink was sucessfully finished, 'false' if sink was already finished

getSegment

public DataSegment getSegment()

getNumRows

public int getNumRows()

getNumRowsInMemory

public int getNumRowsInMemory()

getBytesInMemory

public long getBytesInMemory()

acquireSegmentReferences

@Nullable
public List<SinkSegmentReference> acquireSegmentReferences(SegmentMapFunction segmentMapFn,
 boolean skipIncrementalSegment)

Acquire references to all FireHydrant that represent this sink. Returns null if they cannot all be acquired, possibly because they were closed (swapped to null) concurrently with this method being called.

Parameters:

segmentMapFn - from DataSource.createSegmentMapFunction(Query)

skipIncrementalSegment - whether in-memory IncrementalIndex segments should be skipped

getSignature

public RowSignature getSignature()

Get column information from all the FireHydrant's.

iterator

public Iterator<FireHydrant> iterator()

Specified by:

iterator in interface Iterable<FireHydrant>

toString

public String toString()

Overrides:

toString in class Object

overshadows

public boolean overshadows(Sink other)

Specified by:

overshadows in interface Overshadowable<Sink>

getStartRootPartitionId

public int getStartRootPartitionId()

Specified by:

getStartRootPartitionId in interface Overshadowable<Sink>

getEndRootPartitionId

public int getEndRootPartitionId()

Specified by:

getEndRootPartitionId in interface Overshadowable<Sink>

getVersion

public String getVersion()

Specified by:

getVersion in interface Overshadowable<Sink>

getMinorVersion

public short getMinorVersion()

Specified by:

getMinorVersion in interface Overshadowable<Sink>

getAtomicUpdateGroupSize

public short getAtomicUpdateGroupSize()

Specified by:

getAtomicUpdateGroupSize in interface Overshadowable<Sink>