Package org.apache.druid.segment

Interface QueryableIndex

All Superinterfaces:

AutoCloseable, Closeable, ColumnInspector, Expr.InputBindingInspector

All Known Implementing Classes:

FrameQueryableIndex, NoopQueryableIndex, SimpleQueryableIndex

public interface QueryableIndex
extends Closeable, ColumnInspector

Direct interface to memory mapped segments. Not a public API for extensions; site specific queries should be using CursorFactory.

See Also:

• for query path adapter
• for indexing path adapter

Method Summary

Modifier and Type	Method	Description
void	close()	The close method shouldn't actually be here as this is nasty.
Indexed<String>	getAvailableDimensions()	List of dimensions, not including ColumnHolder.TIME_COLUMN_NAME.
BitmapFactory	getBitmapFactoryForDimensions()
default ColumnCapabilities	getColumnCapabilities(String column)	Returns capabilities of a particular column.
BaseColumnHolder	getColumnHolder(String columnName)
List<String>	getColumnNames()
org.joda.time.Interval	getDataInterval()
Map<String,DimensionHandler>	getDimensionHandlers()	Map of column name to DimensionHandler, whose contents and iteration order matches getAvailableDimensions().
Metadata	getMetadata()
int	getNumRows()
List<OrderBy>	getOrdering()	Returns the ordering of rows in this index.
default QueryableProjection<QueryableIndex>	getProjection(CursorBuildSpec cursorBuildSpec)
default QueryableIndex	getProjectionQueryableIndex(String name)

Methods inherited from interface org.apache.druid.segment.ColumnInspector

getType

Methods inherited from interface org.apache.druid.math.expr.Expr.InputBindingInspector

areNumeric, areNumeric, areSameTypes, areSameTypes, areScalar, areScalar, canVectorize, canVectorize

Method Details

getDataInterval

org.joda.time.Interval getDataInterval()

getNumRows

int getNumRows()

getAvailableDimensions

Indexed<String> getAvailableDimensions()

List of dimensions, not including ColumnHolder.TIME_COLUMN_NAME.

getBitmapFactoryForDimensions

BitmapFactory getBitmapFactoryForDimensions()

getMetadata

@Nullable
Metadata getMetadata()

getDimensionHandlers

Map<String,DimensionHandler> getDimensionHandlers()

Map of column name to DimensionHandler, whose contents and iteration order matches getAvailableDimensions().

getColumnNames

List<String> getColumnNames()

getColumnHolder

@Nullable
BaseColumnHolder getColumnHolder(String columnName)

getColumnCapabilities

@Nullable
default ColumnCapabilities getColumnCapabilities(String column)

Description copied from interface: ColumnInspector

Returns capabilities of a particular column.

Specified by:

getColumnCapabilities in interface ColumnInspector

Parameters:

column - column name

Returns:

capabilities, or null

getOrdering

List<OrderBy> getOrdering()

Returns the ordering of rows in this index.

close

void close()

The close method shouldn't actually be here as this is nasty. We will adjust it in the future.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if an exception was thrown closing the index

getProjection

@Nullable
default QueryableProjection<QueryableIndex> getProjection(CursorBuildSpec cursorBuildSpec)

getProjectionQueryableIndex

@Nullable
default QueryableIndex getProjectionQueryableIndex(String name)