Package org.apache.pinot.segment.spi.index.metadata

Class SegmentMetadataImpl

java.lang.Object

org.apache.pinot.segment.spi.index.metadata.SegmentMetadataImpl

All Implemented Interfaces:

SegmentMetadata

public class SegmentMetadataImpl
extends Object
implements SegmentMetadata

Constructor Summary

Constructors

Constructor	Description
SegmentMetadataImpl(File indexDir)	For segments on disk.
SegmentMetadataImpl(InputStream metadataPropertiesInputStream, InputStream creationMetaInputStream)	For segments that can only provide the inputstream to the metadata
SegmentMetadataImpl(String rawTableName, String segmentName, Schema schema, long creationTime)	For REALTIME consuming segments.

Method Summary

Modifier and Type	Method	Description
Map<String,ColumnMetadata>	getColumnMetadataMap()
String	getCrc()
String	getCreatorName()
Map<String,String>	getCustomMap()
String	getEndOffset()
long	getEndTime()
long	getIndexCreationTime()
File	getIndexDir()
long	getLastIndexedTimestamp()	Return the last time a record was indexed in this segment.
long	getLatestIngestionTimestamp()	Return the latest ingestion timestamp associated with the records indexed in this segment.
String	getName()
Schema	getSchema()
String	getStartOffset()
List<StarTreeV2Metadata>	getStarTreeV2MetadataList()
long	getStartTime()
String	getTableName()	Returns the raw table name (without the type suffix).
String	getTimeColumn()
org.joda.time.Duration	getTimeGranularity()
org.joda.time.Interval	getTimeInterval()
TimeUnit	getTimeUnit()
int	getTotalDocs()
SegmentVersion	getVersion()
void	removeColumn(String column)	Removes a column from the segment metadata.
com.fasterxml.jackson.databind.JsonNode	toJson(Set<String> columnFilter)	Converts segment metadata to json.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pinot.segment.spi.SegmentMetadata

getAllColumns, getColumnMetadataFor, isMutableSegment

Constructor Detail

SegmentMetadataImpl

public SegmentMetadataImpl(InputStream metadataPropertiesInputStream,
                           InputStream creationMetaInputStream)
                    throws IOException

For segments that can only provide the inputstream to the metadata

Throws:

IOException

SegmentMetadataImpl

public SegmentMetadataImpl(File indexDir)
                    throws IOException

For segments on disk.

Index directory passed in should be top level segment directory.

If segment metadata file exists in multiple segment version, load the one in highest segment version.

Throws:

IOException

SegmentMetadataImpl

public SegmentMetadataImpl(String rawTableName,
                           String segmentName,
                           Schema schema,
                           long creationTime)

For REALTIME consuming segments.

Method Detail

getTableName

public String getTableName()

Description copied from interface: SegmentMetadata

Returns the raw table name (without the type suffix).

Specified by:

getTableName in interface SegmentMetadata

getName

public String getName()

Specified by:

getName in interface SegmentMetadata

getTimeColumn

public String getTimeColumn()

Specified by:

getTimeColumn in interface SegmentMetadata

getStartTime

public long getStartTime()

Specified by:

getStartTime in interface SegmentMetadata

getEndTime

public long getEndTime()

Specified by:

getEndTime in interface SegmentMetadata

getTimeUnit

public TimeUnit getTimeUnit()

Specified by:

getTimeUnit in interface SegmentMetadata

getTimeGranularity

public org.joda.time.Duration getTimeGranularity()

Specified by:

getTimeGranularity in interface SegmentMetadata

getTimeInterval

public org.joda.time.Interval getTimeInterval()

Specified by:

getTimeInterval in interface SegmentMetadata

getCrc

public String getCrc()

Specified by:

getCrc in interface SegmentMetadata

getVersion

public SegmentVersion getVersion()

Specified by:

getVersion in interface SegmentMetadata

getSchema

public Schema getSchema()

Specified by:

getSchema in interface SegmentMetadata

getTotalDocs

public int getTotalDocs()

Specified by:

getTotalDocs in interface SegmentMetadata

getIndexDir

public File getIndexDir()

Specified by:

getIndexDir in interface SegmentMetadata

getCreatorName

@Nullable
public String getCreatorName()

Specified by:

getCreatorName in interface SegmentMetadata

getIndexCreationTime

public long getIndexCreationTime()

Specified by:

getIndexCreationTime in interface SegmentMetadata

getLastIndexedTimestamp

public long getLastIndexedTimestamp()

Description copied from interface: SegmentMetadata

Return the last time a record was indexed in this segment. Applicable for MutableSegments.

Specified by:

getLastIndexedTimestamp in interface SegmentMetadata

Returns:

time when the last record was indexed

getLatestIngestionTimestamp

public long getLatestIngestionTimestamp()

Description copied from interface: SegmentMetadata

Return the latest ingestion timestamp associated with the records indexed in this segment. Applicable for MutableSegments.

Specified by:

getLatestIngestionTimestamp in interface SegmentMetadata

Returns:

latest timestamp associated with indexed records Long.MIN_VALUE if the stream doesn't provide a timestamp

getStarTreeV2MetadataList

public List<StarTreeV2Metadata> getStarTreeV2MetadataList()

Specified by:

getStarTreeV2MetadataList in interface SegmentMetadata

getCustomMap

public Map<String,String> getCustomMap()

Specified by:

getCustomMap in interface SegmentMetadata

getStartOffset

public String getStartOffset()

Specified by:

getStartOffset in interface SegmentMetadata

getEndOffset

public String getEndOffset()

Specified by:

getEndOffset in interface SegmentMetadata

getColumnMetadataMap

public Map<String,ColumnMetadata> getColumnMetadataMap()

Specified by:

getColumnMetadataMap in interface SegmentMetadata

removeColumn

public void removeColumn(String column)

Description copied from interface: SegmentMetadata

Removes a column from the segment metadata.

Specified by:

removeColumn in interface SegmentMetadata

toJson

public com.fasterxml.jackson.databind.JsonNode toJson(@Nullable
                                                      Set<String> columnFilter)

Description copied from interface: SegmentMetadata

Converts segment metadata to json.

Specified by:

toJson in interface SegmentMetadata

Parameters:

columnFilter - list only the columns in the set. Lists all the columns if the parameter value is null.

Returns:

json representation of segment metadata.

toString

public String toString()

Overrides:

toString in class Object