Package org.apache.pinot.spi.data
Class Schema.SchemaBuilder
- java.lang.Object
-
- org.apache.pinot.spi.data.Schema.SchemaBuilder
-
-
Constructor Summary
Constructors Constructor Description SchemaBuilder()
-
Method Summary
Modifier and Type Method Description Schema.SchemaBuilderaddComplex(String name, FieldSpec.DataType dataType)Add complex field specSchema.SchemaBuilderaddDateTime(String name, FieldSpec.DataType dataType, String format, String granularity)Add dateTimeFieldSpec with basic fieldsSchema.SchemaBuilderaddDateTime(String name, FieldSpec.DataType dataType, String format, String granularity, Object defaultNullValue, String transformFunction)Add dateTimeFieldSpec with basic fields plus defaultNullValue and transformFunctionSchema.SchemaBuilderaddMetric(String metricName, FieldSpec.DataType dataType)Add metricFieldSpecSchema.SchemaBuilderaddMetric(String metricName, FieldSpec.DataType dataType, Object defaultNullValue)Add metricFieldSpec with defaultNullValueSchema.SchemaBuilderaddMultiValueDimension(String dimensionName, FieldSpec.DataType dataType)Add multi value dimensionFieldSpecSchema.SchemaBuilderaddMultiValueDimension(String dimensionName, FieldSpec.DataType dataType, int maxLength, Object defaultNullValue)Add multi value dimensionFieldSpec with maxLength and a defaultNullValueSchema.SchemaBuilderaddMultiValueDimension(String dimensionName, FieldSpec.DataType dataType, Object defaultNullValue)Add multi value dimensionFieldSpec with defaultNullValueSchema.SchemaBuilderaddSingleValueDimension(String dimensionName, FieldSpec.DataType dataType)Add single value dimensionFieldSpecSchema.SchemaBuilderaddSingleValueDimension(String dimensionName, FieldSpec.DataType dataType, int maxLength, Object defaultNullValue)Add single value dimensionFieldSpec with maxLength and a defaultNullValueSchema.SchemaBuilderaddSingleValueDimension(String dimensionName, FieldSpec.DataType dataType, Object defaultNullValue)Add single value dimensionFieldSpec with a defaultNullValueSchema.SchemaBuilderaddTime(TimeGranularitySpec incomingTimeGranularitySpec, TimeGranularitySpec outgoingTimeGranularitySpec)Deprecated.in favor ofaddDateTime(String, DataType, String, String)Adds timeFieldSpec with incoming and outgoing granularity spec This will continue to exist for a while in several tests, as it helps to test backward compatibility of schemas containing TimeFieldSpecSchemabuild()Schema.SchemaBuildersetPrimaryKeyColumns(List<String> primaryKeyColumns)Schema.SchemaBuildersetSchemaName(String schemaName)
-
-
-
Method Detail
-
setSchemaName
public Schema.SchemaBuilder setSchemaName(String schemaName)
-
addSingleValueDimension
public Schema.SchemaBuilder addSingleValueDimension(String dimensionName, FieldSpec.DataType dataType)
Add single value dimensionFieldSpec
-
addSingleValueDimension
public Schema.SchemaBuilder addSingleValueDimension(String dimensionName, FieldSpec.DataType dataType, Object defaultNullValue)
Add single value dimensionFieldSpec with a defaultNullValue
-
addSingleValueDimension
public Schema.SchemaBuilder addSingleValueDimension(String dimensionName, FieldSpec.DataType dataType, int maxLength, Object defaultNullValue)
Add single value dimensionFieldSpec with maxLength and a defaultNullValue
-
addMultiValueDimension
public Schema.SchemaBuilder addMultiValueDimension(String dimensionName, FieldSpec.DataType dataType)
Add multi value dimensionFieldSpec
-
addMultiValueDimension
public Schema.SchemaBuilder addMultiValueDimension(String dimensionName, FieldSpec.DataType dataType, Object defaultNullValue)
Add multi value dimensionFieldSpec with defaultNullValue
-
addMultiValueDimension
public Schema.SchemaBuilder addMultiValueDimension(String dimensionName, FieldSpec.DataType dataType, int maxLength, Object defaultNullValue)
Add multi value dimensionFieldSpec with maxLength and a defaultNullValue
-
addMetric
public Schema.SchemaBuilder addMetric(String metricName, FieldSpec.DataType dataType)
Add metricFieldSpec
-
addMetric
public Schema.SchemaBuilder addMetric(String metricName, FieldSpec.DataType dataType, Object defaultNullValue)
Add metricFieldSpec with defaultNullValue
-
addTime
@Deprecated public Schema.SchemaBuilder addTime(TimeGranularitySpec incomingTimeGranularitySpec, @Nullable TimeGranularitySpec outgoingTimeGranularitySpec)
Deprecated.in favor ofaddDateTime(String, DataType, String, String)Adds timeFieldSpec with incoming and outgoing granularity spec This will continue to exist for a while in several tests, as it helps to test backward compatibility of schemas containing TimeFieldSpec
-
addDateTime
public Schema.SchemaBuilder addDateTime(String name, FieldSpec.DataType dataType, String format, String granularity)
Add dateTimeFieldSpec with basic fields
-
addDateTime
public Schema.SchemaBuilder addDateTime(String name, FieldSpec.DataType dataType, String format, String granularity, @Nullable Object defaultNullValue, @Nullable String transformFunction)
Add dateTimeFieldSpec with basic fields plus defaultNullValue and transformFunction
-
addComplex
public Schema.SchemaBuilder addComplex(String name, FieldSpec.DataType dataType)
Add complex field spec- Parameters:
name- name of complex (nested) fielddataType- root data type of complex field
-
setPrimaryKeyColumns
public Schema.SchemaBuilder setPrimaryKeyColumns(List<String> primaryKeyColumns)
-
build
public Schema build()
-
-