io.druid.indexing.overlord

Interface IndexerMetadataStorageCoordinator

All Known Implementing Classes:

IndexerSQLMetadataStorageCoordinator

public interface IndexerMetadataStorageCoordinator

Method Summary

Modifier and Type	Method and Description
SegmentIdentifier	allocatePendingSegment(String dataSource, String sequenceName, String previousSegmentId, org.joda.time.Interval interval, String maxVersion, boolean skipSegmentLineageCheck) Allocate a new pending segment in the pending segments table.
Set<DataSegment>	announceHistoricalSegments(Set<DataSegment> segments) Attempts to insert a set of segments to the metadata storage.
SegmentPublishResult	announceHistoricalSegments(Set<DataSegment> segments, DataSourceMetadata startMetadata, DataSourceMetadata endMetadata) Attempts to insert a set of segments to the metadata storage.
boolean	deleteDataSourceMetadata(String dataSource) Removes entry for 'dataSource' from the dataSource metadata table.
int	deletePendingSegments(String dataSource, org.joda.time.Interval deleteInterval) Delete pending segments created in the given interval for the given dataSource from the pending segments table.
void	deleteSegments(Set<DataSegment> segments)
DataSourceMetadata	getDataSourceMetadata(String dataSource) Read dataSource metadata.
List<DataSegment>	getUnusedSegmentsForInterval(String dataSource, org.joda.time.Interval interval) Get all segments which include ONLY data within the given interval and are not flagged as used.
List<DataSegment>	getUsedSegmentsForInterval(String dataSource, org.joda.time.Interval interval) Get all segments which may include any data in the interval and are flagged as used.
List<DataSegment>	getUsedSegmentsForIntervals(String dataSource, List<org.joda.time.Interval> intervals) Get all segments which may include any data in the interval and are flagged as used.
boolean	resetDataSourceMetadata(String dataSource, DataSourceMetadata dataSourceMetadata) Resets dataSourceMetadata entry for 'dataSource' to the one supplied.
void	updateSegmentMetadata(Set<DataSegment> segments)

Method Detail

getUsedSegmentsForInterval

List<DataSegment> getUsedSegmentsForInterval(String dataSource,
                                             org.joda.time.Interval interval)
                                      throws IOException

Get all segments which may include any data in the interval and are flagged as used.

Parameters:

dataSource - The datasource to query

interval - The interval for which all applicable and used datasources are requested. Start is inclusive, end is exclusive

Returns:

The DataSegments which include data in the requested interval. These segments may contain data outside the requested interval.

Throws:

IOException

getUsedSegmentsForIntervals

List<DataSegment> getUsedSegmentsForIntervals(String dataSource,
                                              List<org.joda.time.Interval> intervals)
                                       throws IOException

Get all segments which may include any data in the interval and are flagged as used.

Parameters:

dataSource - The datasource to query

intervals - The intervals for which all applicable and used datasources are requested.

Returns:

The DataSegments which include data in the requested intervals. These segments may contain data outside the requested interval.

Throws:

IOException

announceHistoricalSegments

Set<DataSegment> announceHistoricalSegments(Set<DataSegment> segments)
                                     throws IOException

Attempts to insert a set of segments to the metadata storage. Returns the set of segments actually added (segments with identifiers already in the metadata storage will not be added).

Parameters:

segments - set of segments to add

Returns:

set of segments actually added

Throws:

IOException

allocatePendingSegment

SegmentIdentifier allocatePendingSegment(String dataSource,
                                         String sequenceName,
                                         String previousSegmentId,
                                         org.joda.time.Interval interval,
                                         String maxVersion,
                                         boolean skipSegmentLineageCheck)
                                  throws IOException

Allocate a new pending segment in the pending segments table. This segment identifier will never be given out again, unless another call is made with the same dataSource, sequenceName, and previousSegmentId.

The sequenceName and previousSegmentId parameters are meant to make it easy for two independent ingestion tasks to produce the same series of segments.

Note that a segment sequence may include segments with a variety of different intervals and versions.

Parameters:

dataSource - dataSource for which to allocate a segment

sequenceName - name of the group of ingestion tasks producing a segment series

previousSegmentId - previous segment in the series; may be null or empty, meaning this is the first segment

interval - interval for which to allocate a segment

maxVersion - use this version if we have no better version to use. The returned segment identifier may have a version lower than this one, but will not have one higher.

skipSegmentLineageCheck - if true, perform lineage validation using previousSegmentId for this sequence. Should be set to false if replica tasks would index events in same order

Returns:

the pending segment identifier, or null if it was impossible to allocate a new segment

Throws:

IOException

deletePendingSegments

int deletePendingSegments(String dataSource,
                          org.joda.time.Interval deleteInterval)

Delete pending segments created in the given interval for the given dataSource from the pending segments table. The created_date field of the pending segments table is checked to find segments to be deleted.

Parameters:

dataSource - dataSource

deleteInterval - interval to check the created_date of pendingSegments

Returns:

number of deleted pending segments

announceHistoricalSegments

SegmentPublishResult announceHistoricalSegments(Set<DataSegment> segments,
                                                DataSourceMetadata startMetadata,
                                                DataSourceMetadata endMetadata)
                                         throws IOException

Attempts to insert a set of segments to the metadata storage. Returns the set of segments actually added (segments with identifiers already in the metadata storage will not be added).

If startMetadata and endMetadata are set, this insertion will be atomic with a compare-and-swap on dataSource commit metadata.

Parameters:

segments - set of segments to add, must all be from the same dataSource

startMetadata - dataSource metadata pre-insert must match this startMetadata according to DataSourceMetadata.matches(DataSourceMetadata). If null, this insert will not involve a metadata transaction

endMetadata - dataSource metadata post-insert will have this endMetadata merged in with DataSourceMetadata.plus(DataSourceMetadata). If null, this insert will not involve a metadata transaction

Returns:

segment publish result indicating transaction success or failure, and set of segments actually published

Throws:

IllegalArgumentException - if startMetadata and endMetadata are not either both null or both non-null

IOException

getDataSourceMetadata

DataSourceMetadata getDataSourceMetadata(String dataSource)

Read dataSource metadata. Returns null if there is no metadata.

deleteDataSourceMetadata

boolean deleteDataSourceMetadata(String dataSource)

Removes entry for 'dataSource' from the dataSource metadata table.

Parameters:

dataSource - identifier

Returns:

true if the entry was deleted, false otherwise

resetDataSourceMetadata

boolean resetDataSourceMetadata(String dataSource,
                                DataSourceMetadata dataSourceMetadata)
                         throws IOException

Resets dataSourceMetadata entry for 'dataSource' to the one supplied.

Parameters:

dataSource - identifier

dataSourceMetadata - value to set

Returns:

true if the entry was reset, false otherwise

Throws:

IOException

updateSegmentMetadata

void updateSegmentMetadata(Set<DataSegment> segments)
                    throws IOException

Throws:

IOException

deleteSegments

void deleteSegments(Set<DataSegment> segments)
             throws IOException

Throws:

IOException

getUnusedSegmentsForInterval

List<DataSegment> getUnusedSegmentsForInterval(String dataSource,
                                               org.joda.time.Interval interval)

Get all segments which include ONLY data within the given interval and are not flagged as used.

Parameters:

dataSource - The datasource the segments belong to

interval - Filter the data segments to ones that include data in this interval exclusively. Start is inclusive, end is exclusive

Returns:

DataSegments which include ONLY data within the requested interval and are not flagged as used. Data segments NOT returned here may include data in the interval