Jackie-Jiang commented on a change in pull request #6840: URL: https://github.com/apache/incubator-pinot/pull/6840#discussion_r619885268
########## File path: pinot-spi/src/main/java/org/apache/pinot/spi/config/PinotConfig.java ########## @@ -0,0 +1,76 @@ +/** + * 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 com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonProcessingException; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.spi.utils.JsonUtils; + + +/** + * Wrapper for all configs of a table, which include the offline table config, realtime table config and schema. + * This helps look at and operate on the pinot configs as a whole unit. + */ +public class PinotConfig { Review comment: Extend `BaseJsonConfig` which contains the basic json related methods ########## File path: pinot-spi/src/main/java/org/apache/pinot/spi/config/PinotConfig.java ########## @@ -0,0 +1,76 @@ +/** + * 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 com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonProcessingException; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.spi.utils.JsonUtils; + + +/** + * Wrapper for all configs of a table, which include the offline table config, realtime table config and schema. + * This helps look at and operate on the pinot configs as a whole unit. + */ +public class PinotConfig { Review comment: `PinotConfig` seems too general. Suggest renaming it to `TableConfigs` because it wraps only the table related configs ########## File path: pinot-spi/src/main/java/org/apache/pinot/spi/config/PinotConfig.java ########## @@ -0,0 +1,76 @@ +/** + * 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 com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonProcessingException; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.spi.utils.JsonUtils; + + +/** + * Wrapper for all configs of a table, which include the offline table config, realtime table config and schema. + * This helps look at and operate on the pinot configs as a whole unit. + */ +public class PinotConfig { + private final String _configName; Review comment: `_tableName`? ########## File path: pinot-spi/src/main/java/org/apache/pinot/spi/config/PinotConfig.java ########## @@ -0,0 +1,76 @@ +/** + * 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 com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonProcessingException; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.spi.utils.JsonUtils; + + +/** + * Wrapper for all configs of a table, which include the offline table config, realtime table config and schema. + * This helps look at and operate on the pinot configs as a whole unit. + */ +public class PinotConfig { + private final String _configName; + private final TableConfig _offlineTableConfig; + private final TableConfig _realtimeTableConfig; + private final Schema _schema; + + @JsonCreator + public PinotConfig(@JsonProperty(value = "configName", required = true) String configName, + @JsonProperty(value = "offlineTableConfig") @Nullable TableConfig offlineTableConfig, Review comment: Consider simplify the property name to `offline` and `realtime` ########## File path: pinot-controller/src/main/java/org/apache/pinot/controller/api/resources/Constants.java ########## @@ -30,6 +30,7 @@ public static final String CLUSTER_TAG = "Cluster"; public static final String TABLE_TAG = "Table"; + public static final String CONFIG_TAG = "Config"; Review comment: `Config` seems too general. I would suggest putting these new endpoints under `Table` and use path a different path, e.g. `/tableconfigs` ########## File path: pinot-spi/src/main/java/org/apache/pinot/spi/config/PinotConfig.java ########## @@ -0,0 +1,76 @@ +/** + * 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 com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonProcessingException; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.Schema; +import org.apache.pinot.spi.utils.JsonUtils; + + +/** + * Wrapper for all configs of a table, which include the offline table config, realtime table config and schema. + * This helps look at and operate on the pinot configs as a whole unit. + */ +public class PinotConfig { + private final String _configName; + private final TableConfig _offlineTableConfig; + private final TableConfig _realtimeTableConfig; + private final Schema _schema; + + @JsonCreator + public PinotConfig(@JsonProperty(value = "configName", required = true) String configName, + @JsonProperty(value = "offlineTableConfig") @Nullable TableConfig offlineTableConfig, + @JsonProperty(value = "realtimeTableConfig") @Nullable TableConfig realtimeTableConfig, + @JsonProperty(value = "schema", required = true) Schema schema) { Review comment: (nit) Put schema as the second argument because it's mandatory -- 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. 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
