Package org.apache.pinot.spi.data

Class Schema.SchemaBuilder

java.lang.Object

org.apache.pinot.spi.data.Schema.SchemaBuilder

Enclosing class:

Schema

public static class Schema.SchemaBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
SchemaBuilder()

Method Summary

Modifier and Type	Method	Description
Schema.SchemaBuilder	addComplex(String name, FieldSpec.DataType dataType)	Add complex field spec
Schema.SchemaBuilder	addDateTime(String name, FieldSpec.DataType dataType, String format, String granularity)	Add dateTimeFieldSpec with basic fields
Schema.SchemaBuilder	addDateTime(String name, FieldSpec.DataType dataType, String format, String granularity, Object defaultNullValue, String transformFunction)	Add dateTimeFieldSpec with basic fields plus defaultNullValue and transformFunction
Schema.SchemaBuilder	addMetric(String metricName, FieldSpec.DataType dataType)	Add metricFieldSpec
Schema.SchemaBuilder	addMetric(String metricName, FieldSpec.DataType dataType, Object defaultNullValue)	Add metricFieldSpec with defaultNullValue
Schema.SchemaBuilder	addMultiValueDimension(String dimensionName, FieldSpec.DataType dataType)	Add multi value dimensionFieldSpec
Schema.SchemaBuilder	addMultiValueDimension(String dimensionName, FieldSpec.DataType dataType, int maxLength, Object defaultNullValue)	Add multi value dimensionFieldSpec with maxLength and a defaultNullValue
Schema.SchemaBuilder	addMultiValueDimension(String dimensionName, FieldSpec.DataType dataType, Object defaultNullValue)	Add multi value dimensionFieldSpec with defaultNullValue
Schema.SchemaBuilder	addSingleValueDimension(String dimensionName, FieldSpec.DataType dataType)	Add single value dimensionFieldSpec
Schema.SchemaBuilder	addSingleValueDimension(String dimensionName, FieldSpec.DataType dataType, int maxLength, Object defaultNullValue)	Add single value dimensionFieldSpec with maxLength and a defaultNullValue
Schema.SchemaBuilder	addSingleValueDimension(String dimensionName, FieldSpec.DataType dataType, Object defaultNullValue)	Add single value dimensionFieldSpec with a defaultNullValue
Schema.SchemaBuilder	addTime(TimeGranularitySpec incomingTimeGranularitySpec, TimeGranularitySpec outgoingTimeGranularitySpec)	Deprecated. in favor of addDateTime(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
Schema	build()
Schema.SchemaBuilder	setPrimaryKeyColumns(List<String> primaryKeyColumns)
Schema.SchemaBuilder	setSchemaName(String schemaName)

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaBuilder

public SchemaBuilder()

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 of addDateTime(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) field

dataType - root data type of complex field

setPrimaryKeyColumns

public Schema.SchemaBuilder setPrimaryKeyColumns(List<String> primaryKeyColumns)

build

public Schema build()