[GitHub] [hudi] nsivabalan commented on a change in pull request #2993: [HUDI-1929] Make HoodieDeltaStreamer support configure KeyGenerator by type
nsivabalan commented on a change in pull request #2993:
URL: https://github.com/apache/hudi/pull/2993#discussion_r643861744
##
File path:
hudi-client/hudi-client-common/src/main/java/org/apache/hudi/keygen/constant/KeyGeneratorType.java
##
@@ -0,0 +1,55 @@
+/*
+ * 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.constant;
+
+/**
+ * Types of {@link org.apache.hudi.keygen.KeyGenerator}.
+ */
+public enum KeyGeneratorType {
+ /**
+ * Simple key generator, which takes names of fields to be used for
recordKey and partitionPath as configs.
+ */
+ SIMPLE,
+
+ /**
+ * Complex key generator, which takes names of fields to be used for
recordKey and partitionPath as configs.
+ */
+ COMPLEX,
+
+ /**
+ * Key generator, that relies on timestamps for partitioning field. Still
picks record key by name.
+ */
+ TIMESTAMP,
+
+ /**
+ * A generic implementation of KeyGenerator where users can configure record
key as a single field or a combination
Review comment:
Can we please add an example for custom key gen type. users might
confuse between complex and custom.
--
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
[GitHub] [hudi] nsivabalan commented on a change in pull request #2993: [HUDI-1929] Make HoodieDeltaStreamer support configure KeyGenerator by type
nsivabalan commented on a change in pull request #2993:
URL: https://github.com/apache/hudi/pull/2993#discussion_r643863514
##
File path:
hudi-client/hudi-spark-client/src/test/java/org/apache/hudi/keygen/TestCustomKeyGenerator.java
##
@@ -98,53 +103,145 @@ private TypedProperties
getPropertiesForNonPartitionedKeyGen() {
}
@Test
- public void testSimpleKeyGenerator() {
-BuiltinKeyGenerator keyGenerator = new
CustomKeyGenerator(getPropertiesForSimpleKeyGen());
+ public void testSimpleKeyGenerator() throws IOException {
+TypedProperties propertiesForSimpleKeyGen = getPropertiesForSimpleKeyGen();
+
+// Test config with HoodieWriteConfig.KEYGENERATOR_CLASS_PROP
+propertiesForSimpleKeyGen.put(HoodieWriteConfig.KEYGENERATOR_CLASS_PROP,
CustomKeyGenerator.class.getName());
+
+BuiltinKeyGenerator keyGenerator =
HoodieSparkKeyGeneratorFactory.createKeyGenerator(propertiesForSimpleKeyGen);
GenericRecord record = getRecord();
HoodieKey key = keyGenerator.getKey(record);
Assertions.assertEquals(key.getRecordKey(), "key1");
Assertions.assertEquals(key.getPartitionPath(), "timestamp=4357686");
Row row = KeyGeneratorTestUtilities.getRow(record);
Assertions.assertEquals(keyGenerator.getRecordKey(row), "key1");
Assertions.assertEquals(keyGenerator.getPartitionPath(row),
"timestamp=4357686");
+
+// Test config with HoodieWriteConfig.KEYGENERATOR_TYPE_PROP
+propertiesForSimpleKeyGen = getPropertiesForSimpleKeyGen();
+propertiesForSimpleKeyGen.put(HoodieWriteConfig.KEYGENERATOR_TYPE_PROP,
KeyGeneratorType.CUSTOM.name());
+
+keyGenerator =
HoodieSparkKeyGeneratorFactory.createKeyGenerator(propertiesForSimpleKeyGen);
Review comment:
we could trying moving this repetitive code to a common private method
and re-use them. I mean lines 125 to 132. Similarly for all key types.
##
File path:
hudi-client/hudi-spark-client/src/test/java/org/apache/hudi/keygen/TestCustomKeyGenerator.java
##
@@ -98,53 +103,145 @@ private TypedProperties
getPropertiesForNonPartitionedKeyGen() {
}
@Test
- public void testSimpleKeyGenerator() {
-BuiltinKeyGenerator keyGenerator = new
CustomKeyGenerator(getPropertiesForSimpleKeyGen());
+ public void testSimpleKeyGenerator() throws IOException {
+TypedProperties propertiesForSimpleKeyGen = getPropertiesForSimpleKeyGen();
+
+// Test config with HoodieWriteConfig.KEYGENERATOR_CLASS_PROP
+propertiesForSimpleKeyGen.put(HoodieWriteConfig.KEYGENERATOR_CLASS_PROP,
CustomKeyGenerator.class.getName());
+
+BuiltinKeyGenerator keyGenerator =
HoodieSparkKeyGeneratorFactory.createKeyGenerator(propertiesForSimpleKeyGen);
GenericRecord record = getRecord();
HoodieKey key = keyGenerator.getKey(record);
Assertions.assertEquals(key.getRecordKey(), "key1");
Assertions.assertEquals(key.getPartitionPath(), "timestamp=4357686");
Row row = KeyGeneratorTestUtilities.getRow(record);
Assertions.assertEquals(keyGenerator.getRecordKey(row), "key1");
Assertions.assertEquals(keyGenerator.getPartitionPath(row),
"timestamp=4357686");
+
+// Test config with HoodieWriteConfig.KEYGENERATOR_TYPE_PROP
+propertiesForSimpleKeyGen = getPropertiesForSimpleKeyGen();
+propertiesForSimpleKeyGen.put(HoodieWriteConfig.KEYGENERATOR_TYPE_PROP,
KeyGeneratorType.CUSTOM.name());
+
+keyGenerator =
HoodieSparkKeyGeneratorFactory.createKeyGenerator(propertiesForSimpleKeyGen);
Review comment:
or better option would be to go with Parameterized tests.
##
File path:
hudi-client/hudi-client-common/src/main/java/org/apache/hudi/keygen/constant/KeyGeneratorType.java
##
@@ -0,0 +1,55 @@
+/*
+ * 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.constant;
+
+/**
+ * Types of {@link org.apache.hudi.keygen.KeyGenerator}.
+ */
+public enum KeyGeneratorType {
+ /**
+ * Simple key generator, which takes names of fields to be used for
recordKey and partitionPath as configs.
+ */
+ SIMPLE,
+
+ /**
+ * Complex key generator, which takes names of fields to be used for
recordKey and partitionPath as configs.
+ */
+ COMPLEX,
+
+ /**
+
[GitHub] [hudi] nsivabalan commented on a change in pull request #2993: [HUDI-1929] Make HoodieDeltaStreamer support configure KeyGenerator by type
nsivabalan commented on a change in pull request #2993:
URL: https://github.com/apache/hudi/pull/2993#discussion_r642503029
##
File path:
hudi-client/hudi-spark-client/src/test/java/org/apache/hudi/keygen/TestCustomKeyGenerator.java
##
@@ -98,8 +105,9 @@ private TypedProperties
getPropertiesForNonPartitionedKeyGen() {
}
@Test
- public void testSimpleKeyGenerator() {
-BuiltinKeyGenerator keyGenerator = new
CustomKeyGenerator(getPropertiesForSimpleKeyGen());
+ public void testSimpleKeyGenerator() throws IOException {
Review comment:
Can you run every tests twice. once with prop config and once with class
config.
--
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
[GitHub] [hudi] nsivabalan commented on a change in pull request #2993: [HUDI-1929] Make HoodieDeltaStreamer support configure KeyGenerator by type
nsivabalan commented on a change in pull request #2993: URL: https://github.com/apache/hudi/pull/2993#discussion_r642498863 ## File path: hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieWriteConfig.java ## @@ -72,8 +71,11 @@ public static final String PRECOMBINE_FIELD_PROP = "hoodie.datasource.write.precombine.field"; public static final String WRITE_PAYLOAD_CLASS = "hoodie.datasource.write.payload.class"; public static final String DEFAULT_WRITE_PAYLOAD_CLASS = OverwriteWithLatestAvroPayload.class.getName(); + public static final String KEYGENERATOR_CLASS_PROP = "hoodie.datasource.write.keygenerator.class"; - public static final String DEFAULT_KEYGENERATOR_CLASS = SimpleAvroKeyGenerator.class.getName(); + public static final String KEYGENERATOR_TYPE_PROP = "hoodie.datasource.write.keygenerator.type"; + public static final String DEFAULT_KEYGENERATOR_TYPE = "simple"; Review comment: makes sense. thanks for clarifying. -- 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
[GitHub] [hudi] nsivabalan commented on a change in pull request #2993: [HUDI-1929] Make HoodieDeltaStreamer support configure KeyGenerator by type
nsivabalan commented on a change in pull request #2993: URL: https://github.com/apache/hudi/pull/2993#discussion_r642184643 ## File path: hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieWriteConfig.java ## @@ -72,8 +71,11 @@ public static final String PRECOMBINE_FIELD_PROP = "hoodie.datasource.write.precombine.field"; public static final String WRITE_PAYLOAD_CLASS = "hoodie.datasource.write.payload.class"; public static final String DEFAULT_WRITE_PAYLOAD_CLASS = OverwriteWithLatestAvroPayload.class.getName(); + public static final String KEYGENERATOR_CLASS_PROP = "hoodie.datasource.write.keygenerator.class"; - public static final String DEFAULT_KEYGENERATOR_CLASS = SimpleAvroKeyGenerator.class.getName(); + public static final String KEYGENERATOR_TYPE_PROP = "hoodie.datasource.write.keygenerator.type"; + public static final String DEFAULT_KEYGENERATOR_TYPE = "simple"; Review comment: oops, missed something. you can't deprecate the old config. user defined key gen will be derived from the same config. So, what we could do is that. check if KEYGENERATOR_TYPE_PROP is set. // there is no default for KEYGENERATOR_TYPE_PROP else use value from KEYGENERATOR_CLASS_PROP. KEYGENERATOR_CLASS_PROP can have a default of SIMPLE key gen. Let me know if this would work. -- 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
[GitHub] [hudi] nsivabalan commented on a change in pull request #2993: [HUDI-1929] Make HoodieDeltaStreamer support configure KeyGenerator by type
nsivabalan commented on a change in pull request #2993: URL: https://github.com/apache/hudi/pull/2993#discussion_r641931702 ## File path: hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieWriteConfig.java ## @@ -72,8 +71,11 @@ public static final String PRECOMBINE_FIELD_PROP = "hoodie.datasource.write.precombine.field"; public static final String WRITE_PAYLOAD_CLASS = "hoodie.datasource.write.payload.class"; public static final String DEFAULT_WRITE_PAYLOAD_CLASS = OverwriteWithLatestAvroPayload.class.getName(); + public static final String KEYGENERATOR_CLASS_PROP = "hoodie.datasource.write.keygenerator.class"; - public static final String DEFAULT_KEYGENERATOR_CLASS = SimpleAvroKeyGenerator.class.getName(); + public static final String KEYGENERATOR_TYPE_PROP = "hoodie.datasource.write.keygenerator.type"; + public static final String DEFAULT_KEYGENERATOR_TYPE = "simple"; Review comment: I would propose to may be deprecate the old config. and convert the old one to new one (within parametersWithWriteDefaults or somewhere). Let's not have two conflicting configs. -- 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
[GitHub] [hudi] nsivabalan commented on a change in pull request #2993: [HUDI-1929] Make HoodieDeltaStreamer support configure KeyGenerator by type
nsivabalan commented on a change in pull request #2993: URL: https://github.com/apache/hudi/pull/2993#discussion_r641931227 ## File path: hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieWriteConfig.java ## @@ -72,8 +71,11 @@ public static final String PRECOMBINE_FIELD_PROP = "hoodie.datasource.write.precombine.field"; public static final String WRITE_PAYLOAD_CLASS = "hoodie.datasource.write.payload.class"; public static final String DEFAULT_WRITE_PAYLOAD_CLASS = OverwriteWithLatestAvroPayload.class.getName(); + public static final String KEYGENERATOR_CLASS_PROP = "hoodie.datasource.write.keygenerator.class"; - public static final String DEFAULT_KEYGENERATOR_CLASS = SimpleAvroKeyGenerator.class.getName(); + public static final String KEYGENERATOR_TYPE_PROP = "hoodie.datasource.write.keygenerator.type"; + public static final String DEFAULT_KEYGENERATOR_TYPE = "simple"; Review comment: Can you set Default as KeyGeneratorType.SIMPLE.name() rather than hardcoding. also, lets standardize if we need to lowercase or leave it as is. @n3nash : is there any guideline in general wrt using enums as vals in configs. do we lower case it or expect users to set enum vals as is(UPPERCASE) ? -- 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
