org.apache.druid.metadata

Class SqlSegmentsMetadataQuery

java.lang.Object

org.apache.druid.metadata.SqlSegmentsMetadataQuery

public class SqlSegmentsMetadataQuery
extends Object

An object that helps SqlSegmentsMetadataManager and IndexerSQLMetadataStorageCoordinator make queries to the metadata store segments table. Each instance of this class is scoped to a single handle and is meant to be short-lived.

Method Summary

Modifier and Type	Method and Description
static SqlSegmentsMetadataQuery	forHandle(org.skife.jdbi.v2.Handle handle, SQLMetadataConnector connector, MetadataStorageTablesConfig dbTables, com.fasterxml.jackson.databind.ObjectMapper jsonMapper) Create a query object.
int	markSegments(Collection<SegmentId> segmentIds, boolean used) Marks the provided segments as either used or unused.
int	markSegmentsUnused(String dataSource, org.joda.time.Interval interval) Marks all segments for a datasource unused that are *fully contained by* a particular interval.
CloseableIterator<DataSegment>	retrieveUnusedSegments(String dataSource, Collection<org.joda.time.Interval> intervals) Retrieves segments for a given datasource that are marked unused and that are *fully contained by* any interval in a particular collection of intervals.
CloseableIterator<DataSegment>	retrieveUsedSegments(String dataSource, Collection<org.joda.time.Interval> intervals) Retrieves segments for a given datasource that are marked used (i.e.

Methods inherited from class java.lang.Object

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

Method Detail

forHandle

public static SqlSegmentsMetadataQuery forHandle(org.skife.jdbi.v2.Handle handle,
                                                 SQLMetadataConnector connector,
                                                 MetadataStorageTablesConfig dbTables,
                                                 com.fasterxml.jackson.databind.ObjectMapper jsonMapper)

Create a query object. This instance is scoped to a single handle and is meant to be short-lived. It is okay to use it for more than one query, though.

retrieveUsedSegments

public CloseableIterator<DataSegment> retrieveUsedSegments(String dataSource,
                                                           Collection<org.joda.time.Interval> intervals)

Retrieves segments for a given datasource that are marked used (i.e. published) in the metadata store, and that *overlap* any interval in a particular collection of intervals. If the collection of intervals is empty, this method will retrieve all used segments. You cannot assume that segments returned by this call are actually active. Because there is some delay between new segment publishing and the marking-unused of older segments, it is possible that some segments returned by this call are overshadowed by other segments. To check for this, use SegmentTimeline.forSegments(Iterable). This call does not return any information about realtime segments. Returns a closeable iterator. You should close it when you are done.

retrieveUnusedSegments

public CloseableIterator<DataSegment> retrieveUnusedSegments(String dataSource,
                                                             Collection<org.joda.time.Interval> intervals)

Retrieves segments for a given datasource that are marked unused and that are *fully contained by* any interval in a particular collection of intervals. If the collection of intervals is empty, this method will retrieve all unused segments. This call does not return any information about realtime segments. Returns a closeable iterator. You should close it when you are done.

markSegments

public int markSegments(Collection<SegmentId> segmentIds,
                        boolean used)

Marks the provided segments as either used or unused. Returns the number of segments actually modified.

markSegmentsUnused

public int markSegmentsUnused(String dataSource,
                              org.joda.time.Interval interval)

Marks all segments for a datasource unused that are *fully contained by* a particular interval. Returns the number of segments actually modified.