org.apache.druid.segment

Class QueryableIndexStorageAdapter

java.lang.Object

org.apache.druid.segment.QueryableIndexStorageAdapter

All Implemented Interfaces:

ColumnInspector, CursorFactory, StorageAdapter

public class QueryableIndexStorageAdapter
extends Object
implements StorageAdapter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryableIndexStorageAdapter.FilterAnalysis

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_VECTOR_SIZE

Constructor Summary

Constructors

Constructor and Description
QueryableIndexStorageAdapter(QueryableIndex index)

Method Summary

Modifier and Type	Method and Description
QueryableIndexStorageAdapter.FilterAnalysis	analyzeFilter(Filter filter, ColumnSelectorBitmapIndexSelector indexSelector, QueryMetrics queryMetrics)
boolean	canVectorize(Filter filter, VirtualColumns virtualColumns, boolean descending) Returns true if the provided combination of parameters can be handled by "makeVectorCursor".
Indexed<String>	getAvailableDimensions()
Iterable<String>	getAvailableMetrics()
static ColumnCapabilities	getColumnCapabilities(ColumnSelector index, String columnName)
ColumnCapabilities	getColumnCapabilities(String column) Returns capabilities of a particular column, if known.
String	getColumnTypeName(String columnName) Like ColumnCapabilities.getType(), but may return a more descriptive string for complex columns.
int	getDimensionCardinality(String dimension) Returns the number of distinct values for the given column if known, or Integer.MAX_VALUE if unknown, e.
org.joda.time.Interval	getInterval()
org.joda.time.DateTime	getMaxIngestedEventTime()
org.joda.time.DateTime	getMaxTime()
Comparable	getMaxValue(String dimension)
Metadata	getMetadata()
org.joda.time.DateTime	getMinTime()
Comparable	getMinValue(String dimension)
int	getNumRows()
ColumnSelectorBitmapIndexSelector	makeBitmapIndexSelector(VirtualColumns virtualColumns)
Sequence<Cursor>	makeCursors(Filter filter, org.joda.time.Interval interval, VirtualColumns virtualColumns, Granularity gran, boolean descending, QueryMetrics<?> queryMetrics) Creates a sequence of Cursors, one for each time-granular bucket (based on the provided Granularity).
VectorCursor	makeVectorCursor(Filter filter, org.joda.time.Interval interval, VirtualColumns virtualColumns, boolean descending, int vectorSize, QueryMetrics<?> queryMetrics) Creates a VectorCursor.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VECTOR_SIZE

public static final int DEFAULT_VECTOR_SIZE

See Also:

Constant Field Values

Constructor Detail

QueryableIndexStorageAdapter

public QueryableIndexStorageAdapter(QueryableIndex index)

Method Detail

getInterval

public org.joda.time.Interval getInterval()

Specified by:

getInterval in interface StorageAdapter

getAvailableDimensions

public Indexed<String> getAvailableDimensions()

Specified by:

getAvailableDimensions in interface StorageAdapter

getAvailableMetrics

public Iterable<String> getAvailableMetrics()

Specified by:

getAvailableMetrics in interface StorageAdapter

getDimensionCardinality

public int getDimensionCardinality(String dimension)

Description copied from interface: StorageAdapter

Returns the number of distinct values for the given column if known, or Integer.MAX_VALUE if unknown, e. g. the column is numeric. If the column doesn't exist, returns 0.

Specified by:

getDimensionCardinality in interface StorageAdapter

getNumRows

public int getNumRows()

Specified by:

getNumRows in interface StorageAdapter

getMinTime

public org.joda.time.DateTime getMinTime()

Specified by:

getMinTime in interface StorageAdapter

getMaxTime

public org.joda.time.DateTime getMaxTime()

Specified by:

getMaxTime in interface StorageAdapter

getMinValue

@Nullable
public Comparable getMinValue(String dimension)

Specified by:

getMinValue in interface StorageAdapter

getMaxValue

@Nullable
public Comparable getMaxValue(String dimension)

Specified by:

getMaxValue in interface StorageAdapter

getColumnCapabilities

@Nullable
public ColumnCapabilities getColumnCapabilities(String column)

Description copied from interface: StorageAdapter

Returns capabilities of a particular column, if known. May be null if the column doesn't exist, or if the column does exist but the capabilities are unknown. The latter is possible with dynamically discovered columns. Note that StorageAdapters are representations of "real" segments, so they are not aware of any virtual columns that may be involved in a query. In general, query engines should instead use the method ColumnSelectorFactory.getColumnCapabilities(String), which returns capabilities for virtual columns as well.

Specified by:

getColumnCapabilities in interface ColumnInspector

Specified by:

getColumnCapabilities in interface StorageAdapter

Parameters:

column - column name

Returns:

capabilities, or null

getColumnTypeName

@Nullable
public String getColumnTypeName(String columnName)

Description copied from interface: StorageAdapter

Like ColumnCapabilities.getType(), but may return a more descriptive string for complex columns.

Specified by:

getColumnTypeName in interface StorageAdapter

Parameters:

columnName - column name

Returns:

type name

getMaxIngestedEventTime

public org.joda.time.DateTime getMaxIngestedEventTime()

Specified by:

getMaxIngestedEventTime in interface StorageAdapter

canVectorize

public boolean canVectorize(@Nullable
                            Filter filter,
                            VirtualColumns virtualColumns,
                            boolean descending)

Description copied from interface: CursorFactory

Returns true if the provided combination of parameters can be handled by "makeVectorCursor". Query engines should use this before running in vectorized mode, and be prepared to fall back to non-vectorized mode if this method returns false.

Specified by:

canVectorize in interface CursorFactory

makeVectorCursor

@Nullable
public VectorCursor makeVectorCursor(@Nullable
                                               Filter filter,
                                               org.joda.time.Interval interval,
                                               VirtualColumns virtualColumns,
                                               boolean descending,
                                               int vectorSize,
                                               @Nullable
                                               QueryMetrics<?> queryMetrics)

Description copied from interface: CursorFactory

Creates a VectorCursor. Unlike the Cursor returned by "makeCursor", there is just one of these. Hence, this method does not take a "granularity" parameter. Before calling this method, check "canVectorize" to see if the call you are about to make will throw an error or not. Returns null if there is no data to walk over (for example, if the "interval" does not overlap the data interval of this segment).

Specified by:

makeVectorCursor in interface CursorFactory

makeCursors

public Sequence<Cursor> makeCursors(@Nullable
                                    Filter filter,
                                    org.joda.time.Interval interval,
                                    VirtualColumns virtualColumns,
                                    Granularity gran,
                                    boolean descending,
                                    @Nullable
                                    QueryMetrics<?> queryMetrics)

Description copied from interface: CursorFactory

Creates a sequence of Cursors, one for each time-granular bucket (based on the provided Granularity).

Specified by:

makeCursors in interface CursorFactory

getColumnCapabilities

@Nullable
public static ColumnCapabilities getColumnCapabilities(ColumnSelector index,
                                                                 String columnName)

getMetadata

public Metadata getMetadata()

Specified by:

getMetadata in interface StorageAdapter

makeBitmapIndexSelector

public ColumnSelectorBitmapIndexSelector makeBitmapIndexSelector(VirtualColumns virtualColumns)

analyzeFilter

public QueryableIndexStorageAdapter.FilterAnalysis analyzeFilter(@Nullable
                                                                 Filter filter,
                                                                 ColumnSelectorBitmapIndexSelector indexSelector,
                                                                 @Nullable
                                                                 QueryMetrics queryMetrics)