Jackie-Jiang commented on code in PR #10191: URL: https://github.com/apache/pinot/pull/10191#discussion_r1129946089
########## pinot-segment-spi/src/main/java/org/apache/pinot/segment/spi/index/IndexType.java: ########## @@ -0,0 +1,171 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.pinot.segment.spi.index; + +import com.fasterxml.jackson.databind.JsonNode; +import java.io.IOException; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.pinot.segment.spi.ColumnMetadata; +import org.apache.pinot.segment.spi.creator.IndexCreationContext; +import org.apache.pinot.segment.spi.index.column.ColumnIndexContainer; +import org.apache.pinot.segment.spi.store.SegmentDirectory; +import org.apache.pinot.spi.config.table.FieldConfig; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.spi.utils.JsonUtils; + + +/** + * TODO: implement mutable indexes. + * @param <C> the class that represents how this object is configured. + * @param <IR> the {@link IndexReader} subclass that should be used to read indexes of this type. + * @param <IC> the {@link IndexCreator} subclass that should be used to create indexes of this type. + */ +public interface IndexType<C, IR extends IndexReader, IC extends IndexCreator> { + + /** + * The unique id that identifies this index type. + * In case there is more than one implementation for a given index, then all should share the same id in order to be + * correctly registered in the {@link IndexService}. + * This is also the value being used as the default toString implementation and the one used as keys when config is + * specified. + * + * <p>Therefore the returned value for each index should be constant across different Pinot versions.</p> + */ + String getId(); Review Comment: Should we rename this method to `getName()`? ########## pinot-segment-spi/src/main/java/org/apache/pinot/segment/spi/index/FieldIndexConfigs.java: ########## @@ -0,0 +1,131 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.pinot.segment.spi.index; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.JsonNode; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import java.util.function.Function; +import java.util.stream.Collectors; +import org.apache.pinot.spi.config.table.IndexConfig; +import org.apache.pinot.spi.utils.JsonUtils; + + +/** + * FieldIndexConfigs are a map like structure that relates index types with their configuration, providing a type safe + * interface. + * + * This class can be serialized into a JSON object whose keys are the index type ids using Jackson, but cannot be + * serialized back. A custom Jackson deserializer could be provided if needed. + */ +public class FieldIndexConfigs { + + public static final FieldIndexConfigs EMPTY = new FieldIndexConfigs(new HashMap<>()); + + private final Map<IndexType, IndexConfig> _configMap; + + private FieldIndexConfigs(Map<IndexType, IndexConfig> configMap) { + _configMap = Collections.unmodifiableMap(configMap); + } + + /** + * Returns the configuration associated with the given index type, which will be null if there is no configuration for + * that index type. + */ + @JsonIgnore + public <C extends IndexConfig, I extends IndexType<C, ?, ?>> C getConfig(I indexType) { + IndexConfig config = _configMap.get(indexType); + if (config == null) { + return indexType.getDefaultConfig(); + } + return (C) config; + } + + /* + This is used by Jackson when this object is serialized. Each entry of the map will be directly contained in the + JSON object, with the key name as the key in the JSON object and the result of serializing the key value as the value + in the JSON object. + */ + @JsonAnyGetter + public Map<String, JsonNode> unwrapIndexes() { + Function<Map.Entry<IndexType, IndexConfig>, JsonNode> serializer = + entry -> entry.getKey().serialize(entry.getValue()); + return _configMap.entrySet().stream() + .filter(e -> e.getValue() != null) + .collect(Collectors.toMap(entry -> entry.getKey().getId(), serializer)); + } + + @Override + public String toString() { + try { + return JsonUtils.objectToString(this); Review Comment: We may remove the json annotations with the following change: ```suggestion return JsonUtils.objectToString(unwrapIndexes()); ``` ########## pinot-segment-spi/src/main/java/org/apache/pinot/segment/spi/index/IndexType.java: ########## @@ -0,0 +1,130 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.pinot.segment.spi.index; + +import com.fasterxml.jackson.databind.JsonNode; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.pinot.segment.spi.ColumnMetadata; +import org.apache.pinot.segment.spi.creator.IndexCreationContext; +import org.apache.pinot.segment.spi.index.column.ColumnIndexContainer; +import org.apache.pinot.segment.spi.store.SegmentDirectory; +import org.apache.pinot.spi.config.table.IndexConfig; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.spi.utils.JsonUtils; + + +/** + * TODO: implement mutable indexes. + * @param <C> the class that represents how this object is configured. + * @param <IR> the {@link IndexReader} subclass that should be used to read indexes of this type. + * @param <IC> the {@link IndexCreator} subclass that should be used to create indexes of this type. + */ +public interface IndexType<C extends IndexConfig, IR extends IndexReader, IC extends IndexCreator> { + + /** + * The unique id that identifies this index type. + * <p>The returned value for each index should be constant across different Pinot versions as it is used as:</p> + * + * <ul> + * <li>They key used when the index is registered in IndexService.</li> + * <li>The internal identification in v1 files and metadata persisted on disk.</li> + * <li>The default toString implementation.</li> + * <li>The key that identifies the index config in the indexes section inside + * {@link org.apache.pinot.spi.config.table.FieldConfig}, although specific index types may choose to read other + * names (for example, <code>inverted_index</code> may read <code>inverted</code> key.</li> + * </ul> + */ + String getId(); + + Class<C> getIndexConfigClass(); + + /** + * The default config when it is not explicitly defined by the user. + */ + C getDefaultConfig(); + + C getConfig(TableConfig tableConfig, Schema schema); + + /** + * Transforms a config object into a Jackson {@link JsonNode}. + */ + default JsonNode serialize(C config) { Review Comment: `IndexConfig` already extends `BaseJsonConfig` which has `toJsonNode()` method. Do you see the need for the customized serializer? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
