org.apache.druid.metadata

Class IndexerSQLMetadataStorageCoordinator

java.lang.Object

org.apache.druid.metadata.IndexerSQLMetadataStorageCoordinator

All Implemented Interfaces:

IndexerMetadataStorageCoordinator

public class IndexerSQLMetadataStorageCoordinator
extends Object
implements IndexerMetadataStorageCoordinator

Constructor Summary

Constructors

Constructor and Description
IndexerSQLMetadataStorageCoordinator(com.fasterxml.jackson.databind.ObjectMapper jsonMapper, MetadataStorageTablesConfig dbTables, SQLMetadataConnector connector)

Method Summary

Modifier and Type	Method and Description
SegmentIdWithShardSpec	allocatePendingSegment(String dataSource, String sequenceName, String previousSegmentId, org.joda.time.Interval interval, PartialShardSpec partialShardSpec, 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.
SegmentPublishResult	commitMetadataOnly(String dataSource, DataSourceMetadata startMetadata, DataSourceMetadata endMetadata) Similar to IndexerMetadataStorageCoordinator.announceHistoricalSegments(Set), but meant for streaming ingestion tasks for handling the case where the task ingested no records and created no segments, but still needs to update the metadata with the progress that the task made.
boolean	deleteDataSourceMetadata(String dataSource) Removes entry for 'dataSource' from the dataSource metadata table.
int	deletePendingSegments(String dataSource) Delete all pending segments belonging to the given data source from the pending segments table.
int	deletePendingSegmentsCreatedInInterval(String dataSource, org.joda.time.Interval deleteInterval) Delete pending segments created in the given interval belonging to the given data source from the pending segments table.
void	deleteSegments(Set<DataSegment> segments)
boolean	insertDataSourceMetadata(String dataSource, DataSourceMetadata metadata) Insert dataSourceMetadata entry for 'dataSource'.
boolean	resetDataSourceMetadata(String dataSource, DataSourceMetadata dataSourceMetadata) Resets dataSourceMetadata entry for 'dataSource' to the one supplied.
Collection<DataSegment>	retrieveAllUsedSegments(String dataSource, Segments visibility) Retrieve all published used segments in the data source from the metadata store.
DataSourceMetadata	retrieveDataSourceMetadata(String dataSource) Read dataSource metadata.
List<DataSegment>	retrieveUnusedSegmentsForInterval(String dataSource, org.joda.time.Interval interval) Retrieve all published segments which include ONLY data within the given interval and are marked as unused from the metadata store.
List<Pair<DataSegment,String>>	retrieveUsedSegmentsAndCreatedDates(String dataSource) Retrieve all published segments which are marked as used and the created_date of these segments belonging to the given data source from the metadata store.
Collection<DataSegment>	retrieveUsedSegmentsForIntervals(String dataSource, List<org.joda.time.Interval> intervals, Segments visibility) Retrieve all published segments which may include any data in the given intervals and are marked as used from the metadata store.
void	start()
protected org.apache.druid.metadata.IndexerSQLMetadataStorageCoordinator.DataSourceMetadataUpdateResult	updateDataSourceMetadataWithHandle(org.skife.jdbi.v2.Handle handle, String dataSource, DataSourceMetadata startMetadata, DataSourceMetadata endMetadata) Compare-and-swap dataSource metadata in a transaction.
void	updateSegmentMetadata(Set<DataSegment> segments)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.druid.indexing.overlord.IndexerMetadataStorageCoordinator

retrieveUsedSegmentsForInterval

Constructor Detail

IndexerSQLMetadataStorageCoordinator

@Inject
public IndexerSQLMetadataStorageCoordinator(com.fasterxml.jackson.databind.ObjectMapper jsonMapper,
                                                    MetadataStorageTablesConfig dbTables,
                                                    SQLMetadataConnector connector)

Method Detail

start

public void start()

retrieveUsedSegmentsForIntervals

public Collection<DataSegment> retrieveUsedSegmentsForIntervals(String dataSource,
                                                                List<org.joda.time.Interval> intervals,
                                                                Segments visibility)

Description copied from interface: IndexerMetadataStorageCoordinator

Retrieve all published segments which may include any data in the given intervals and are marked as used from the metadata store. The order of segments within the returned collection is unspecified, but each segment is guaranteed to appear in the collection only once.

Specified by:

retrieveUsedSegmentsForIntervals in interface IndexerMetadataStorageCoordinator

Parameters:

dataSource - The data source to query

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

visibility - Whether only visible or visible as well as overshadowed segments should be returned. The visibility is considered within the specified intervals: that is, a segment which is visible outside of the specified intervals, but overshadowed on the specified intervals will not be returned if Segments.ONLY_VISIBLE is passed. See more precise description in the doc for Segments.

Returns:

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

retrieveAllUsedSegments

public Collection<DataSegment> retrieveAllUsedSegments(String dataSource,
                                                       Segments visibility)

Description copied from interface: IndexerMetadataStorageCoordinator

Retrieve all published used segments in the data source from the metadata store.

Specified by:

retrieveAllUsedSegments in interface IndexerMetadataStorageCoordinator

Parameters:

dataSource - The data source to query

Returns:

all segments belonging to the given data source

See Also:

similar to this method but also accepts data interval.

retrieveUsedSegmentsAndCreatedDates

public List<Pair<DataSegment,String>> retrieveUsedSegmentsAndCreatedDates(String dataSource)

Description copied from interface: IndexerMetadataStorageCoordinator

Retrieve all published segments which are marked as used and the created_date of these segments belonging to the given data source from the metadata store. Unlike other similar methods in this interface, this method doesn't accept a Segments "visibility" parameter. The returned collection may include overshadowed segments and their created_dates, as if Segments.INCLUDING_OVERSHADOWED was passed. It's the responsibility of the caller to filter out overshadowed ones if needed.

Specified by:

retrieveUsedSegmentsAndCreatedDates in interface IndexerMetadataStorageCoordinator

Parameters:

dataSource - The data source to query

Returns:

The DataSegments and the related created_date of segments

retrieveUnusedSegmentsForInterval

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

Description copied from interface: IndexerMetadataStorageCoordinator

Retrieve all published segments which include ONLY data within the given interval and are marked as unused from the metadata store.

Specified by:

retrieveUnusedSegmentsForInterval in interface IndexerMetadataStorageCoordinator

Parameters:

dataSource - The data source the segments belong to

interval - Filter the data segments to ones that include data in this interval exclusively.

Returns:

DataSegments which include ONLY data within the requested interval and are marked as unused. Segments NOT returned here may include data in the interval

announceHistoricalSegments

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

Description copied from interface: IndexerMetadataStorageCoordinator

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).

Specified by:

announceHistoricalSegments in interface IndexerMetadataStorageCoordinator

Parameters:

segments - set of segments to add

Returns:

set of segments actually added

Throws:

IOException

announceHistoricalSegments

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

Description copied from interface: IndexerMetadataStorageCoordinator

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.

Specified by:

announceHistoricalSegments in interface IndexerMetadataStorageCoordinator

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. This method must only return a failure code if it is sure that the transaction did not happen. If it is not sure, it must throw an exception instead.

Throws:

IOException

commitMetadataOnly

public SegmentPublishResult commitMetadataOnly(String dataSource,
                                               DataSourceMetadata startMetadata,
                                               DataSourceMetadata endMetadata)

Description copied from interface: IndexerMetadataStorageCoordinator

Similar to IndexerMetadataStorageCoordinator.announceHistoricalSegments(Set), but meant for streaming ingestion tasks for handling the case where the task ingested no records and created no segments, but still needs to update the metadata with the progress that the task made. The metadata should undergo the same validation checks as performed by IndexerMetadataStorageCoordinator.announceHistoricalSegments(java.util.Set<org.apache.druid.timeline.DataSegment>).

Specified by:

commitMetadataOnly in interface IndexerMetadataStorageCoordinator

Parameters:

dataSource - the datasource

startMetadata - dataSource metadata pre-insert must match this startMetadata according to DataSourceMetadata.matches(DataSourceMetadata).

endMetadata - dataSource metadata post-insert will have this endMetadata merged in with DataSourceMetadata.plus(DataSourceMetadata).

Returns:

segment publish result indicating transaction success or failure. This method must only return a failure code if it is sure that the transaction did not happen. If it is not sure, it must throw an exception instead.

allocatePendingSegment

public SegmentIdWithShardSpec allocatePendingSegment(String dataSource,
                                                     String sequenceName,
                                                     @Nullable
                                                     String previousSegmentId,
                                                     org.joda.time.Interval interval,
                                                     PartialShardSpec partialShardSpec,
                                                     String maxVersion,
                                                     boolean skipSegmentLineageCheck)

Description copied from interface: IndexerMetadataStorageCoordinator

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.

Specified by:

allocatePendingSegment in interface IndexerMetadataStorageCoordinator

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

partialShardSpec - partialShardSpec containing all necessary information to create a shardSpec for the new segmentId

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

deletePendingSegmentsCreatedInInterval

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

Description copied from interface: IndexerMetadataStorageCoordinator

Delete pending segments created in the given interval belonging to the given data source from the pending segments table. The created_date field of the pending segments table is checked to find segments to be deleted. Note that the semantic of the interval (for `created_date`s) is different from the semantic of the interval parameters in some other methods in this class, such as IndexerMetadataStorageCoordinator.retrieveUsedSegmentsForInterval(java.lang.String, org.joda.time.Interval, org.apache.druid.indexing.overlord.Segments) (where the interval is about the time column value in rows belonging to the segment).

Specified by:

deletePendingSegmentsCreatedInInterval in interface IndexerMetadataStorageCoordinator

Parameters:

dataSource - dataSource

deleteInterval - interval to check the created_date of pendingSegments

Returns:

number of deleted pending segments

deletePendingSegments

public int deletePendingSegments(String dataSource)

Description copied from interface: IndexerMetadataStorageCoordinator

Delete all pending segments belonging to the given data source from the pending segments table.

Specified by:

deletePendingSegments in interface IndexerMetadataStorageCoordinator

Returns:

number of deleted pending segments

See Also:

similar to this method but also accepts interval for segments' `created_date`s

retrieveDataSourceMetadata

@Nullable
public DataSourceMetadata retrieveDataSourceMetadata(String dataSource)

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

Specified by:

retrieveDataSourceMetadata in interface IndexerMetadataStorageCoordinator

updateDataSourceMetadataWithHandle

protected org.apache.druid.metadata.IndexerSQLMetadataStorageCoordinator.DataSourceMetadataUpdateResult updateDataSourceMetadataWithHandle(org.skife.jdbi.v2.Handle handle,
                                                                                                                                           String dataSource,
                                                                                                                                           DataSourceMetadata startMetadata,
                                                                                                                                           DataSourceMetadata endMetadata)
                                                                                                                                    throws IOException

Compare-and-swap dataSource metadata in a transaction. This will only modify dataSource metadata if it equals oldCommitMetadata when this function is called (based on T.equals). This method is idempotent in that if the metadata already equals newCommitMetadata, it will return true.

Parameters:

handle - database handle

dataSource - druid dataSource

startMetadata - dataSource metadata pre-insert must match this startMetadata according to DataSourceMetadata.matches(DataSourceMetadata)

endMetadata - dataSource metadata post-insert will have this endMetadata merged in with DataSourceMetadata.plus(DataSourceMetadata)

Returns:

SUCCESS if dataSource metadata was updated from matching startMetadata to matching endMetadata, FAILURE or TRY_AGAIN if it definitely was not updated. This guarantee is meant to help announceHistoricalSegments(Set, DataSourceMetadata, DataSourceMetadata) achieve its own guarantee.

Throws:

RuntimeException - if state is unknown after this call

IOException

deleteDataSourceMetadata

public boolean deleteDataSourceMetadata(String dataSource)

Description copied from interface: IndexerMetadataStorageCoordinator

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

Specified by:

deleteDataSourceMetadata in interface IndexerMetadataStorageCoordinator

Parameters:

dataSource - identifier

Returns:

true if the entry was deleted, false otherwise

resetDataSourceMetadata

public boolean resetDataSourceMetadata(String dataSource,
                                       DataSourceMetadata dataSourceMetadata)
                                throws IOException

Description copied from interface: IndexerMetadataStorageCoordinator

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

Specified by:

resetDataSourceMetadata in interface IndexerMetadataStorageCoordinator

Parameters:

dataSource - identifier

dataSourceMetadata - value to set

Returns:

true if the entry was reset, false otherwise

Throws:

IOException

updateSegmentMetadata

public void updateSegmentMetadata(Set<DataSegment> segments)

Specified by:

updateSegmentMetadata in interface IndexerMetadataStorageCoordinator

deleteSegments

public void deleteSegments(Set<DataSegment> segments)

Specified by:

deleteSegments in interface IndexerMetadataStorageCoordinator

insertDataSourceMetadata

public boolean insertDataSourceMetadata(String dataSource,
                                        DataSourceMetadata metadata)

Description copied from interface: IndexerMetadataStorageCoordinator

Insert dataSourceMetadata entry for 'dataSource'.

Specified by:

insertDataSourceMetadata in interface IndexerMetadataStorageCoordinator

Parameters:

dataSource - identifier

metadata - value to set

Returns:

true if the entry was inserted, false otherwise