Package org.apache.druid.data.input.impl

Class DimensionSchema

java.lang.Object

org.apache.druid.data.input.impl.DimensionSchema

Direct Known Subclasses:

AutoTypeColumnSchema, DoubleDimensionSchema, FloatDimensionSchema, LongDimensionSchema, NestedDataColumnSchema, NewSpatialDimensionSchema, StringDimensionSchema

public abstract class DimensionSchema
extends Object

Defines the schema of a single dimension in a dataset.

Includes metadata such as the dimension's name, type, and whether it can hold multiple values. Supports Jackson serialization/deserialization, including polymorphic types via @JsonSubTypes.

Example JSON:

 {
     "type": "string",
     "name": "country",
     "multiValue": false
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DimensionSchema.MultiValueHandling

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOUBLE_TYPE_NAME
static final String	FLOAT_TYPE_NAME
static final String	LONG_TYPE_NAME
static final String	SPATIAL_TYPE_NAME
static final String	STRING_TYPE_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DimensionSchema(String name, DimensionSchema.MultiValueHandling multiValueHandling, boolean createBitmapIndex)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
abstract ColumnType	getColumnType()
static DimensionSchema	getDefaultSchemaForBuiltInType(String name, TypeSignature<ValueType> type)
DimensionHandler	getDimensionHandler()
DimensionSchema	getEffectiveSchema(IndexSpec indexSpec)	Computes the 'effective' DimensionSchema, allowing columns which provide mechanisms for customizing storage format to fill in values from the segment level IndexSpec defaults.
DimensionSchema.MultiValueHandling	getMultiValueHandling()
String	getName()
abstract String	getTypeName()
boolean	hasBitmapIndex()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

STRING_TYPE_NAME

public static final String STRING_TYPE_NAME

See Also:

• Constant Field Values

LONG_TYPE_NAME

public static final String LONG_TYPE_NAME

See Also:

• Constant Field Values

FLOAT_TYPE_NAME

public static final String FLOAT_TYPE_NAME

See Also:

• Constant Field Values

SPATIAL_TYPE_NAME

public static final String SPATIAL_TYPE_NAME

See Also:

• Constant Field Values

DOUBLE_TYPE_NAME

public static final String DOUBLE_TYPE_NAME

See Also:

• Constant Field Values

Constructor Details

DimensionSchema

protected DimensionSchema(String name,
 DimensionSchema.MultiValueHandling multiValueHandling,
 boolean createBitmapIndex)

Method Details

getDefaultSchemaForBuiltInType

public static DimensionSchema getDefaultSchemaForBuiltInType(String name,
 TypeSignature<ValueType> type)

getName

public String getName()

getMultiValueHandling

public DimensionSchema.MultiValueHandling getMultiValueHandling()

hasBitmapIndex

public boolean hasBitmapIndex()

getTypeName

public abstract String getTypeName()

getColumnType

public abstract ColumnType getColumnType()

getDimensionHandler

public DimensionHandler getDimensionHandler()

getEffectiveSchema

public DimensionSchema getEffectiveSchema(IndexSpec indexSpec)

Computes the 'effective' DimensionSchema, allowing columns which provide mechanisms for customizing storage format to fill in values from the segment level IndexSpec defaults. This is useful for comparising the operator explicitly defined schema with the 'effective' schema that was written to the segments for things like comparing compaction state.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object