Jackie-Jiang commented on code in PR #17678: URL: https://github.com/apache/pinot/pull/17678#discussion_r2842997172
########## pinot-common/src/main/java/org/apache/pinot/common/utils/LogicalTableConfigSerDe.java: ########## @@ -0,0 +1,47 @@ +/** + * 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.common.utils; + +import java.io.IOException; +import org.apache.helix.zookeeper.datamodel.ZNRecord; +import org.apache.pinot.spi.data.LogicalTableConfig; + + +/** + * Pluggable serializer/deserializer for {@link LogicalTableConfig} stored in ZooKeeper as {@link ZNRecord}. + * + * <p>Implementations are discovered via {@link java.util.ServiceLoader}. When multiple implementations + * are present, the one with the highest {@link #getPriority()} wins.</p> + */ +public interface LogicalTableConfigSerDe { + + /** + * Deserializes a {@link LogicalTableConfig} from the given {@link ZNRecord}. + */ + LogicalTableConfig fromZNRecord(ZNRecord znRecord) Review Comment: We should also include a serialize interface (i.e. `ZNRecord toZNRecord(LogicalTableConfig logicalTableConfig)`) ########## pinot-common/src/main/java/org/apache/pinot/common/utils/LogicalTableConfigSerDe.java: ########## @@ -0,0 +1,47 @@ +/** + * 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.common.utils; + +import java.io.IOException; +import org.apache.helix.zookeeper.datamodel.ZNRecord; +import org.apache.pinot.spi.data.LogicalTableConfig; + + +/** Review Comment: (minor) Consider using [markdown](https://openjdk.org/jeps/467) style of javadoc, which is easier to read. Same for other javadocs ########## pinot-spi/src/main/java/org/apache/pinot/spi/config/ConfigRecord.java: ########## @@ -0,0 +1,68 @@ +/** + * 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.spi.config; + +import java.util.Collections; +import java.util.Map; +import javax.annotation.Nullable; + + +/** + * A helix-agnostic record that mirrors ZNRecord's data structure (id, simpleFields, mapFields). + * Config classes in pinot-spi use this for serialization/deserialization, while bridge utilities + * in pinot-common handle conversion between ConfigRecord and ZNRecord. + */ +public class ConfigRecord { Review Comment: Let's not introduce this class. We don't need this layer of abstraction, which can introduce unnecessary overhead -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
