JingsongLi commented on code in PR #771: URL: https://github.com/apache/incubator-paimon/pull/771#discussion_r1153310157
########## paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/factories/PaimonFactory.java: ########## @@ -0,0 +1,84 @@ +/* + * 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.paimon.flink.factories; + +import org.apache.flink.configuration.ConfigOption; + +import java.util.Set; + +/** + * Base interface for all kind of factories that create object instances from a list of key-value + * pairs in Flink's Table & SQL API. + * + * <p>A factory is uniquely identified by {@link Class} and {@link #factoryIdentifier()}. + * + * <p>The list of available factories is discovered using Java's Service Provider Interfaces (SPI). + * Classes that implement this interface can be added to {@code + * META_INF/services/org.apache.paimon.flink.factories.PaimonFactory} in JAR files. + * + * <p>Every factory declares a set of required and optional options. This information will not be + * used during discovery but is helpful when generating documentation and performing validation. A + * factory may discover further (nested) factories, the options of the nested factories must not be + * declared in the sets of this factory. + * + * <p>It is the responsibility of each factory to perform validation before returning an instance. + * + * <p>For consistency, the following style for key names of {@link ConfigOption} is recommended: + * + * <ul> + * <li>Try to <b>reuse</b> key names as much as possible. Use other factory implementations as an + * example. + * <li>Key names should be declared in <b>lower case</b>. Use "-" instead of dots or camel case to + * split words. + * <li>Key names should be <b>hierarchical</b> where appropriate. Think about how one would define + * such a hierarchy in JSON or YAML file (e.g. {@code sink.bulk-flush.max-actions}). + * <li>In case of a hierarchy, try not to use the higher level again in the key name (e.g. do + * {@code sink.partitioner} instead of {@code sink.sink-partitioner}) to <b>keep the keys + * short</b>. + * <li>Key names which can be templated, e.g. to refer to a specific column, should be listed + * using '#' as the placeholder symbol. For example, use {@code fields.#.min}. + * </ul> + */ +public interface PaimonFactory { + + /** + * Returns a unique identifier among same factory interfaces. + * + * <p>For consistency, an identifier should be declared as one lower case word (e.g. {@code + * kafka}). If multiple factories exist for different versions, a version should be appended + * using "-" (e.g. {@code elasticsearch-7}). + */ + String factoryIdentifier(); + + /** + * Returns a set of {@link ConfigOption} that an implementation of this factory requires in + * addition to {@link #optionalOptions()}. + * + * <p>See the documentation of {@link PaimonFactory} for more information. + */ + Set<ConfigOption<?>> requiredOptions(); + + /** + * Returns a set of {@link ConfigOption} that an implementation of this factory consumes in + * addition to {@link #requiredOptions()}. + * + * <p>See the documentation of {@link PaimonFactory} for more information. + */ + Set<ConfigOption<?>> optionalOptions(); Review Comment: useless too? ########## paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/factories/PaimonFactory.java: ########## @@ -0,0 +1,84 @@ +/* + * 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.paimon.flink.factories; + +import org.apache.flink.configuration.ConfigOption; + +import java.util.Set; + +/** + * Base interface for all kind of factories that create object instances from a list of key-value + * pairs in Flink's Table & SQL API. + * + * <p>A factory is uniquely identified by {@link Class} and {@link #factoryIdentifier()}. + * + * <p>The list of available factories is discovered using Java's Service Provider Interfaces (SPI). + * Classes that implement this interface can be added to {@code + * META_INF/services/org.apache.paimon.flink.factories.PaimonFactory} in JAR files. + * + * <p>Every factory declares a set of required and optional options. This information will not be + * used during discovery but is helpful when generating documentation and performing validation. A + * factory may discover further (nested) factories, the options of the nested factories must not be + * declared in the sets of this factory. + * + * <p>It is the responsibility of each factory to perform validation before returning an instance. + * + * <p>For consistency, the following style for key names of {@link ConfigOption} is recommended: + * + * <ul> + * <li>Try to <b>reuse</b> key names as much as possible. Use other factory implementations as an + * example. + * <li>Key names should be declared in <b>lower case</b>. Use "-" instead of dots or camel case to + * split words. + * <li>Key names should be <b>hierarchical</b> where appropriate. Think about how one would define + * such a hierarchy in JSON or YAML file (e.g. {@code sink.bulk-flush.max-actions}). + * <li>In case of a hierarchy, try not to use the higher level again in the key name (e.g. do + * {@code sink.partitioner} instead of {@code sink.sink-partitioner}) to <b>keep the keys + * short</b>. + * <li>Key names which can be templated, e.g. to refer to a specific column, should be listed + * using '#' as the placeholder symbol. For example, use {@code fields.#.min}. + * </ul> + */ +public interface PaimonFactory { + + /** + * Returns a unique identifier among same factory interfaces. + * + * <p>For consistency, an identifier should be declared as one lower case word (e.g. {@code + * kafka}). If multiple factories exist for different versions, a version should be appended + * using "-" (e.g. {@code elasticsearch-7}). + */ + String factoryIdentifier(); + + /** + * Returns a set of {@link ConfigOption} that an implementation of this factory requires in + * addition to {@link #optionalOptions()}. + * + * <p>See the documentation of {@link PaimonFactory} for more information. + */ + Set<ConfigOption<?>> requiredOptions(); Review Comment: useless too? ########## paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/log/LogStoreTableFactory.java: ########## @@ -50,7 +52,7 @@ * <p>Log tables are for processing only unbounded data. Support streaming reading and streaming * writing. */ -public interface LogStoreTableFactory extends DynamicTableFactory { +public interface LogStoreTableFactory extends DynamicTablePaimonFactory { Review Comment: Maybe we don't need `DynamicTablePaimonFactory` and `PaimonFactory`? Just a `LogStoreTableFactory` with `String factoryIdentifier()` is OK? -- 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: issues-unsubscr...@paimon.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
