wangxianghu commented on a change in pull request #2993: URL: https://github.com/apache/hudi/pull/2993#discussion_r644777231
########## File path: hudi-client/hudi-client-common/src/main/java/org/apache/hudi/keygen/factory/HoodieAvroKeyGeneratorFactory.java ########## @@ -0,0 +1,94 @@ +/* + * 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.hudi.keygen.factory; + +import org.apache.hudi.common.config.TypedProperties; +import org.apache.hudi.common.util.ReflectionUtils; +import org.apache.hudi.common.util.StringUtils; +import org.apache.hudi.config.HoodieWriteConfig; +import org.apache.hudi.exception.HoodieKeyGeneratorException; +import org.apache.hudi.keygen.BaseKeyGenerator; +import org.apache.hudi.keygen.ComplexAvroKeyGenerator; +import org.apache.hudi.keygen.CustomAvroKeyGenerator; +import org.apache.hudi.keygen.GlobalAvroDeleteKeyGenerator; +import org.apache.hudi.keygen.NonpartitionedAvroKeyGenerator; +import org.apache.hudi.keygen.SimpleAvroKeyGenerator; +import org.apache.hudi.keygen.TimestampBasedAvroKeyGenerator; +import org.apache.hudi.keygen.constant.KeyGeneratorType; + +import java.io.IOException; +import java.util.Locale; +import java.util.Objects; + +/** + * Factory help to create {@link org.apache.hudi.keygen.KeyGenerator}. + * <p> + * This factory will try {@link HoodieWriteConfig#KEYGENERATOR_CLASS_PROP} firstly, this ensures the class prop + * will not be overwritten by {@link KeyGeneratorType} + */ +public class HoodieAvroKeyGeneratorFactory { + public static BaseKeyGenerator createKeyGenerator(TypedProperties props) throws IOException { + // keyGenerator class name has higher priority + BaseKeyGenerator keyGenerator = createKeyGeneratorByClassName(props); + return Objects.isNull(keyGenerator) ? createKeyGeneratorByType(props) : keyGenerator; + } + + public static BaseKeyGenerator createKeyGeneratorByClassName(TypedProperties props) throws IOException { + BaseKeyGenerator keyGenerator = null; + String keyGeneratorClass = props.getString(HoodieWriteConfig.KEYGENERATOR_CLASS_PROP, null); + if (!StringUtils.isNullOrEmpty(keyGeneratorClass)) { + try { + keyGenerator = (BaseKeyGenerator) ReflectionUtils.loadClass(keyGeneratorClass, props); + } catch (Throwable e) { + throw new IOException("Could not load key generator class " + keyGeneratorClass, e); + } + } + return keyGenerator; + } + + public static BaseKeyGenerator createKeyGeneratorByType(TypedProperties props) throws IOException { Review comment: > same question as above. This one can be private, `createKeyGeneratorByClassName ` is used by `HoodieSparkKeyGeneratorFactory` for code reuse purpose ########## File path: hudi-client/hudi-spark-client/src/main/java/org/apache/hudi/keygen/factory/HoodieSparkKeyGeneratorFactory.java ########## @@ -0,0 +1,82 @@ +/* + * 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.hudi.keygen.factory; + +import org.apache.hudi.common.config.TypedProperties; +import org.apache.hudi.config.HoodieWriteConfig; +import org.apache.hudi.exception.HoodieKeyGeneratorException; +import org.apache.hudi.keygen.BuiltinKeyGenerator; +import org.apache.hudi.keygen.ComplexKeyGenerator; +import org.apache.hudi.keygen.CustomKeyGenerator; +import org.apache.hudi.keygen.GlobalDeleteKeyGenerator; +import org.apache.hudi.keygen.NonpartitionedKeyGenerator; +import org.apache.hudi.keygen.SimpleKeyGenerator; +import org.apache.hudi.keygen.TimestampBasedKeyGenerator; +import org.apache.hudi.keygen.constant.KeyGeneratorType; + +import java.io.IOException; +import java.util.Locale; +import java.util.Objects; + +/** + * Factory help to create {@link org.apache.hudi.keygen.KeyGenerator}. + * <p> + * This factory will try {@link HoodieWriteConfig#KEYGENERATOR_CLASS_PROP} firstly, this ensures the class prop + * will not be overwritten by {@link KeyGeneratorType} + */ +public class HoodieSparkKeyGeneratorFactory { Review comment: > can you help me understand, why do we have 2 keyGen factories? > And I see sparkKeyGenFactory uses AvorKeyGenFactory to intialize keyGen and if its null, proceeds to initialize by its own. whats the case where avro key gen factory will not work, but spark key gen would work? I could not find much diff between both key gen. may be I am missing something. when using `KeyGeneratorType` to create `KeyGenerator`, different engines may have different implementations. pay attention to the difference between `org.apache.hudi.keygen.factory.HoodieAvroKeyGeneratorFactory#createKeyGeneratorByType` and `org.apache.hudi.keygen.factory.HoodieSparkKeyGeneratorFactory#createKeyGeneratorByType` ########## File path: hudi-client/hudi-client-common/src/main/java/org/apache/hudi/keygen/factory/HoodieAvroKeyGeneratorFactory.java ########## @@ -0,0 +1,94 @@ +/* + * 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.hudi.keygen.factory; + +import org.apache.hudi.common.config.TypedProperties; +import org.apache.hudi.common.util.ReflectionUtils; +import org.apache.hudi.common.util.StringUtils; +import org.apache.hudi.config.HoodieWriteConfig; +import org.apache.hudi.exception.HoodieKeyGeneratorException; +import org.apache.hudi.keygen.BaseKeyGenerator; +import org.apache.hudi.keygen.ComplexAvroKeyGenerator; +import org.apache.hudi.keygen.CustomAvroKeyGenerator; +import org.apache.hudi.keygen.GlobalAvroDeleteKeyGenerator; +import org.apache.hudi.keygen.NonpartitionedAvroKeyGenerator; +import org.apache.hudi.keygen.SimpleAvroKeyGenerator; +import org.apache.hudi.keygen.TimestampBasedAvroKeyGenerator; +import org.apache.hudi.keygen.constant.KeyGeneratorType; + +import java.io.IOException; +import java.util.Locale; +import java.util.Objects; + +/** + * Factory help to create {@link org.apache.hudi.keygen.KeyGenerator}. + * <p> + * This factory will try {@link HoodieWriteConfig#KEYGENERATOR_CLASS_PROP} firstly, this ensures the class prop + * will not be overwritten by {@link KeyGeneratorType} + */ +public class HoodieAvroKeyGeneratorFactory { + public static BaseKeyGenerator createKeyGenerator(TypedProperties props) throws IOException { + // keyGenerator class name has higher priority + BaseKeyGenerator keyGenerator = createKeyGeneratorByClassName(props); + return Objects.isNull(keyGenerator) ? createKeyGeneratorByType(props) : keyGenerator; + } + + public static BaseKeyGenerator createKeyGeneratorByClassName(TypedProperties props) throws IOException { Review comment: > minor: do these need to be public? `createKeyGeneratorByClassName` is reused by `org.apache.hudi.keygen.factory.HoodieSparkKeyGeneratorFactory` ########## File path: hudi-client/hudi-spark-client/src/main/java/org/apache/hudi/keygen/factory/HoodieSparkKeyGeneratorFactory.java ########## @@ -0,0 +1,82 @@ +/* + * 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.hudi.keygen.factory; + +import org.apache.hudi.common.config.TypedProperties; +import org.apache.hudi.config.HoodieWriteConfig; +import org.apache.hudi.exception.HoodieKeyGeneratorException; +import org.apache.hudi.keygen.BuiltinKeyGenerator; +import org.apache.hudi.keygen.ComplexKeyGenerator; +import org.apache.hudi.keygen.CustomKeyGenerator; +import org.apache.hudi.keygen.GlobalDeleteKeyGenerator; +import org.apache.hudi.keygen.NonpartitionedKeyGenerator; +import org.apache.hudi.keygen.SimpleKeyGenerator; +import org.apache.hudi.keygen.TimestampBasedKeyGenerator; +import org.apache.hudi.keygen.constant.KeyGeneratorType; + +import java.io.IOException; +import java.util.Locale; +import java.util.Objects; + +/** + * Factory help to create {@link org.apache.hudi.keygen.KeyGenerator}. + * <p> + * This factory will try {@link HoodieWriteConfig#KEYGENERATOR_CLASS_PROP} firstly, this ensures the class prop + * will not be overwritten by {@link KeyGeneratorType} + */ +public class HoodieSparkKeyGeneratorFactory { Review comment: > can you help me understand, why do we have 2 keyGen factories? > And I see sparkKeyGenFactory uses AvorKeyGenFactory to intialize keyGen and if its null, proceeds to initialize by its own. whats the case where avro key gen factory will not work, but spark key gen would work? I could not find much diff between both key gen. may be I am missing something. Different engines may have different implementations. HoodieAvroKeyGeneratorFactory is a common factory for flink and java engine, they have the same KeyGenerators Spark KeyGenerators is different from flink and java pleased pay attention to the difference between `org.apache.hudi.keygen.factory.HoodieAvroKeyGeneratorFactory#createKeyGeneratorByType` and `org.apache.hudi.keygen.factory.HoodieSparkKeyGeneratorFactory#createKeyGeneratorByType` ########## File path: hudi-client/hudi-spark-client/src/main/java/org/apache/hudi/keygen/factory/HoodieSparkKeyGeneratorFactory.java ########## @@ -0,0 +1,82 @@ +/* + * 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.hudi.keygen.factory; + +import org.apache.hudi.common.config.TypedProperties; +import org.apache.hudi.config.HoodieWriteConfig; +import org.apache.hudi.exception.HoodieKeyGeneratorException; +import org.apache.hudi.keygen.BuiltinKeyGenerator; +import org.apache.hudi.keygen.ComplexKeyGenerator; +import org.apache.hudi.keygen.CustomKeyGenerator; +import org.apache.hudi.keygen.GlobalDeleteKeyGenerator; +import org.apache.hudi.keygen.NonpartitionedKeyGenerator; +import org.apache.hudi.keygen.SimpleKeyGenerator; +import org.apache.hudi.keygen.TimestampBasedKeyGenerator; +import org.apache.hudi.keygen.constant.KeyGeneratorType; + +import java.io.IOException; +import java.util.Locale; +import java.util.Objects; + +/** + * Factory help to create {@link org.apache.hudi.keygen.KeyGenerator}. + * <p> + * This factory will try {@link HoodieWriteConfig#KEYGENERATOR_CLASS_PROP} firstly, this ensures the class prop + * will not be overwritten by {@link KeyGeneratorType} + */ +public class HoodieSparkKeyGeneratorFactory { Review comment: > can you help me understand, why do we have 2 keyGen factories? > And I see sparkKeyGenFactory uses AvorKeyGenFactory to intialize keyGen and if its null, proceeds to initialize by its own. whats the case where avro key gen factory will not work, but spark key gen would work? I could not find much diff between both key gen. may be I am missing something. Different engines may have different implementations. HoodieAvroKeyGeneratorFactory is a common factory for flink and java engine, they have the same KeyGenerators Spark KeyGenerators are different from flink and java pleased pay attention to the difference between `org.apache.hudi.keygen.factory.HoodieAvroKeyGeneratorFactory#createKeyGeneratorByType` and `org.apache.hudi.keygen.factory.HoodieSparkKeyGeneratorFactory#createKeyGeneratorByType` ########## File path: hudi-client/hudi-spark-client/src/main/java/org/apache/hudi/keygen/factory/HoodieSparkKeyGeneratorFactory.java ########## @@ -0,0 +1,82 @@ +/* + * 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.hudi.keygen.factory; + +import org.apache.hudi.common.config.TypedProperties; +import org.apache.hudi.config.HoodieWriteConfig; +import org.apache.hudi.exception.HoodieKeyGeneratorException; +import org.apache.hudi.keygen.BuiltinKeyGenerator; +import org.apache.hudi.keygen.ComplexKeyGenerator; +import org.apache.hudi.keygen.CustomKeyGenerator; +import org.apache.hudi.keygen.GlobalDeleteKeyGenerator; +import org.apache.hudi.keygen.NonpartitionedKeyGenerator; +import org.apache.hudi.keygen.SimpleKeyGenerator; +import org.apache.hudi.keygen.TimestampBasedKeyGenerator; +import org.apache.hudi.keygen.constant.KeyGeneratorType; + +import java.io.IOException; +import java.util.Locale; +import java.util.Objects; + +/** + * Factory help to create {@link org.apache.hudi.keygen.KeyGenerator}. + * <p> + * This factory will try {@link HoodieWriteConfig#KEYGENERATOR_CLASS_PROP} firstly, this ensures the class prop + * will not be overwritten by {@link KeyGeneratorType} + */ +public class HoodieSparkKeyGeneratorFactory { Review comment: > can you help me understand, why do we have 2 keyGen factories? > And I see sparkKeyGenFactory uses AvorKeyGenFactory to intialize keyGen and if its null, proceeds to initialize by its own. whats the case where avro key gen factory will not work, but spark key gen would work? I could not find much diff between both key gen. may be I am missing something. Different engines may have different implementations. HoodieAvroKeyGeneratorFactory is a common factory for flink and java engine, they have the same KeyGenerators Spark KeyGenerators are different from flink and java please pay attention to the difference between `org.apache.hudi.keygen.factory.HoodieAvroKeyGeneratorFactory#createKeyGeneratorByType` and `org.apache.hudi.keygen.factory.HoodieSparkKeyGeneratorFactory#createKeyGeneratorByType` ########## File path: hudi-client/hudi-client-common/src/main/java/org/apache/hudi/keygen/factory/HoodieAvroKeyGeneratorFactory.java ########## @@ -0,0 +1,94 @@ +/* + * 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.hudi.keygen.factory; + +import org.apache.hudi.common.config.TypedProperties; +import org.apache.hudi.common.util.ReflectionUtils; +import org.apache.hudi.common.util.StringUtils; +import org.apache.hudi.config.HoodieWriteConfig; +import org.apache.hudi.exception.HoodieKeyGeneratorException; +import org.apache.hudi.keygen.BaseKeyGenerator; +import org.apache.hudi.keygen.ComplexAvroKeyGenerator; +import org.apache.hudi.keygen.CustomAvroKeyGenerator; +import org.apache.hudi.keygen.GlobalAvroDeleteKeyGenerator; +import org.apache.hudi.keygen.NonpartitionedAvroKeyGenerator; +import org.apache.hudi.keygen.SimpleAvroKeyGenerator; +import org.apache.hudi.keygen.TimestampBasedAvroKeyGenerator; +import org.apache.hudi.keygen.constant.KeyGeneratorType; + +import java.io.IOException; +import java.util.Locale; +import java.util.Objects; + +/** + * Factory help to create {@link org.apache.hudi.keygen.KeyGenerator}. + * <p> + * This factory will try {@link HoodieWriteConfig#KEYGENERATOR_CLASS_PROP} firstly, this ensures the class prop + * will not be overwritten by {@link KeyGeneratorType} + */ +public class HoodieAvroKeyGeneratorFactory { + public static BaseKeyGenerator createKeyGenerator(TypedProperties props) throws IOException { + // keyGenerator class name has higher priority + BaseKeyGenerator keyGenerator = createKeyGeneratorByClassName(props); + return Objects.isNull(keyGenerator) ? createKeyGeneratorByType(props) : keyGenerator; + } + + public static BaseKeyGenerator createKeyGeneratorByClassName(TypedProperties props) throws IOException { + BaseKeyGenerator keyGenerator = null; + String keyGeneratorClass = props.getString(HoodieWriteConfig.KEYGENERATOR_CLASS_PROP, null); + if (!StringUtils.isNullOrEmpty(keyGeneratorClass)) { + try { + keyGenerator = (BaseKeyGenerator) ReflectionUtils.loadClass(keyGeneratorClass, props); + } catch (Throwable e) { + throw new IOException("Could not load key generator class " + keyGeneratorClass, e); + } + } + return keyGenerator; + } + + public static BaseKeyGenerator createKeyGeneratorByType(TypedProperties props) throws IOException { Review comment: > same question as above. `createKeyGeneratorByType `can be private, `createKeyGeneratorByClassName ` is reused by `HoodieSparkKeyGeneratorFactory`,need to be public -- 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: [email protected]
