Package org.apache.druid.timeline

Class DataSegment

java.lang.Object

org.apache.druid.timeline.DataSegment

All Implemented Interfaces:

Comparable<DataSegment>, Overshadowable<DataSegment>

public class DataSegment
extends Object
implements Comparable<DataSegment>, Overshadowable<DataSegment>

Metadata of Druid's data segment. An immutable object.

DataSegment's equality (equals(java.lang.Object)/hashCode()) and compareTo(org.apache.druid.timeline.DataSegment) methods consider only the SegmentId of the segment.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataSegment.Builder
static class	DataSegment.PruneSpecsHolder	This class is needed for optional injection of pruneLoadSpec and pruneLastCompactionState, see github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOMBSTONE_LOADSPEC_TYPE

Constructor Summary

Constructors

Constructor	Description
DataSegment(String dataSource, org.joda.time.Interval interval, String version, Map<String,Object> loadSpec, List<String> dimensions, List<String> metrics, List<String> projections, ShardSpec shardSpec, CompactionState lastCompactionState, Integer binaryVersion, long size, DataSegment.PruneSpecsHolder pruneSpecsHolder)
DataSegment(String dataSource, org.joda.time.Interval interval, String version, Map<String,Object> loadSpec, List<String> dimensions, List<String> metrics, ShardSpec shardSpec, Integer binaryVersion, long size)	Deprecated. use builder(SegmentId) or builder(DataSegment) instead.
DataSegment(String dataSource, org.joda.time.Interval interval, String version, Map<String,Object> loadSpec, List<String> dimensions, List<String> metrics, ShardSpec shardSpec, CompactionState lastCompactionState, Integer binaryVersion, long size)	Deprecated. use builder(SegmentId) or builder(DataSegment) instead.

Method Summary

Modifier and Type	Method	Description
static DataSegment.Builder	builder()	Deprecated. use builder(SegmentId) or builder(DataSegment) instead.
static DataSegment.Builder	builder(DataSegment segment)
static DataSegment.Builder	builder(SegmentId segmentId)
int	compareTo(DataSegment dataSegment)
boolean	equals(Object o)
short	getAtomicUpdateGroupSize()	Return the size of atomicUpdateGroup.
Integer	getBinaryVersion()
String	getDataSource()	Get dataSource
List<String>	getDimensions()
int	getEndRootPartitionId()	See doc of Overshadowable.getStartRootPartitionId().
SegmentId	getId()
org.joda.time.Interval	getInterval()
CompactionState	getLastCompactionState()
Map<String,Object>	getLoadSpec()
List<String>	getMetrics()
short	getMinorVersion()
List<String>	getProjections()
ShardSpec	getShardSpec()
long	getSize()
int	getStartRootPartitionId()	All overshadowables have root partition range.
String	getVersion()
boolean	hasData()
int	hashCode()
boolean	isTombstone()
boolean	overshadows(DataSegment other)	Returns true if this overshadowable overshadows the other.
SegmentDescriptor	toDescriptor()
String	toString()
DataSegment	withBinaryVersion(int binaryVersion)
DataSegment	withDimensions(List<String> dimensions)
DataSegment	withLastCompactionState(CompactionState compactionState)
DataSegment	withLoadSpec(Map<String,Object> loadSpec)
DataSegment	withMetrics(List<String> metrics)
DataSegment	withProjections(List<String> projections)
DataSegment	withShardSpec(ShardSpec newSpec)
DataSegment	withSize(long size)
DataSegment	withVersion(String version)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

containsRootPartition

Field Details

TOMBSTONE_LOADSPEC_TYPE

public static final String TOMBSTONE_LOADSPEC_TYPE

See Also:

• Constant Field Values

Constructor Details

DataSegment

@Deprecated
public DataSegment(String dataSource,
 org.joda.time.Interval interval,
 String version,
 Map<String,Object> loadSpec,
 List<String> dimensions,
 List<String> metrics,
 ShardSpec shardSpec,
 Integer binaryVersion,
 long size)

Deprecated.

use builder(SegmentId) or builder(DataSegment) instead.

DataSegment

@Deprecated
public DataSegment(String dataSource,
 org.joda.time.Interval interval,
 String version,
 Map<String,Object> loadSpec,
 List<String> dimensions,
 List<String> metrics,
 ShardSpec shardSpec,
 @Nullable
 CompactionState lastCompactionState,
 Integer binaryVersion,
 long size)

Deprecated.

use builder(SegmentId) or builder(DataSegment) instead.

DataSegment

public DataSegment(String dataSource,
 org.joda.time.Interval interval,
 String version,
 @Nullable
 Map<String,Object> loadSpec,
 @Nullable
 List<String> dimensions,
 @Nullable
 List<String> metrics,
 @Nullable
 List<String> projections,
 @Nullable
 ShardSpec shardSpec,
 @Nullable
 CompactionState lastCompactionState,
 Integer binaryVersion,
 long size,
 DataSegment.PruneSpecsHolder pruneSpecsHolder)

Method Details

getDataSource

public String getDataSource()

Get dataSource

Returns:

the dataSource

getInterval

public org.joda.time.Interval getInterval()

getLoadSpec

@Nullable
public Map<String,Object> getLoadSpec()

getVersion

public String getVersion()

Specified by:

getVersion in interface Overshadowable<DataSegment>

getDimensions

public List<String> getDimensions()

getMetrics

public List<String> getMetrics()

getProjections

@Nullable
public List<String> getProjections()

getShardSpec

public ShardSpec getShardSpec()

getLastCompactionState

@Nullable
public CompactionState getLastCompactionState()

getBinaryVersion

public Integer getBinaryVersion()

getSize

public long getSize()

getId

public SegmentId getId()

isTombstone

public boolean isTombstone()

overshadows

public boolean overshadows(DataSegment other)

Description copied from interface: Overshadowable

Returns true if this overshadowable overshadows the other.

Specified by:

overshadows in interface Overshadowable<DataSegment>

getStartRootPartitionId

public int getStartRootPartitionId()

Description copied from interface: Overshadowable

All overshadowables have root partition range. First-generation overshadowables have (partitionId, partitionId + 1) as their root partition range. Non-first-generation overshadowables are the overshadowables that overwrite first or non-first generation overshadowables, and they have the merged root partition range of all overwritten first-generation overshadowables. Note that first-generation overshadowables can be overwritten by a single non-first-generation overshadowable if they have consecutive partitionId. Non-first-generation overshadowables can be overwritten by another if their root partition ranges are consecutive.

Specified by:

getStartRootPartitionId in interface Overshadowable<DataSegment>

getEndRootPartitionId

public int getEndRootPartitionId()

Description copied from interface: Overshadowable

See doc of Overshadowable.getStartRootPartitionId().

Specified by:

getEndRootPartitionId in interface Overshadowable<DataSegment>

getMinorVersion

public short getMinorVersion()

Specified by:

getMinorVersion in interface Overshadowable<DataSegment>

getAtomicUpdateGroupSize

public short getAtomicUpdateGroupSize()

Description copied from interface: Overshadowable

Return the size of atomicUpdateGroup. An atomicUpdateGroup is a set of segments which should be updated all together atomically in VersionedIntervalTimeline.

Specified by:

getAtomicUpdateGroupSize in interface Overshadowable<DataSegment>

toDescriptor

public SegmentDescriptor toDescriptor()

withLoadSpec

public DataSegment withLoadSpec(Map<String,Object> loadSpec)

withDimensions

public DataSegment withDimensions(List<String> dimensions)

withMetrics

public DataSegment withMetrics(List<String> metrics)

withProjections

public DataSegment withProjections(List<String> projections)

withShardSpec

public DataSegment withShardSpec(ShardSpec newSpec)

withSize

public DataSegment withSize(long size)

withVersion

public DataSegment withVersion(String version)

withBinaryVersion

public DataSegment withBinaryVersion(int binaryVersion)

withLastCompactionState

public DataSegment withLastCompactionState(CompactionState compactionState)

compareTo

public int compareTo(DataSegment dataSegment)

Specified by:

compareTo in interface Comparable<DataSegment>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

@Deprecated
public static DataSegment.Builder builder()

Deprecated.

use builder(SegmentId) or builder(DataSegment) instead.

builder

public static DataSegment.Builder builder(SegmentId segmentId)

builder

public static DataSegment.Builder builder(DataSegment segment)

hasData

public boolean hasData()

Specified by:

hasData in interface Overshadowable<DataSegment>