You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hudi.apache.org by vi...@apache.org on 2019/11/30 19:12:49 UTC
[incubator-hudi] branch master updated: [HUDI-357] Refactor
hudi-cli based on new comment and code style rules (#1051)
This is an automated email from the ASF dual-hosted git repository.
vinoth pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hudi.git
The following commit(s) were added to refs/heads/master by this push:
new 75132c1 [HUDI-357] Refactor hudi-cli based on new comment and code style rules (#1051)
75132c1 is described below
commit 75132c139f0faf9ef68bb461b3a551238a377455
Author: Gurudatt Kulkarni <Gu...@users.noreply.github.com>
AuthorDate: Sun Dec 1 00:42:41 2019 +0530
[HUDI-357] Refactor hudi-cli based on new comment and code style rules (#1051)
---
hudi-cli/src/main/java/org/apache/hudi/cli/HoodieCLI.java | 6 ++++++
.../org/apache/hudi/cli/HoodieHistoryFileNameProvider.java | 3 +++
.../src/main/java/org/apache/hudi/cli/HoodiePrintHelper.java | 12 ++++++------
hudi-cli/src/main/java/org/apache/hudi/cli/HoodiePrompt.java | 3 +++
.../main/java/org/apache/hudi/cli/HoodieSplashScreen.java | 3 +++
hudi-cli/src/main/java/org/apache/hudi/cli/Main.java | 6 +++---
hudi-cli/src/main/java/org/apache/hudi/cli/Table.java | 10 +++++-----
hudi-cli/src/main/java/org/apache/hudi/cli/TableHeader.java | 12 ++++++------
.../org/apache/hudi/cli/commands/ArchivedCommitsCommand.java | 3 +++
.../java/org/apache/hudi/cli/commands/CleansCommand.java | 3 +++
.../java/org/apache/hudi/cli/commands/CommitsCommand.java | 3 +++
.../java/org/apache/hudi/cli/commands/CompactionCommand.java | 3 +++
.../java/org/apache/hudi/cli/commands/DatasetsCommand.java | 7 +++++--
.../org/apache/hudi/cli/commands/FileSystemViewCommand.java | 5 ++++-
.../apache/hudi/cli/commands/HDFSParquetImportCommand.java | 3 +++
.../org/apache/hudi/cli/commands/HoodieLogFileCommand.java | 3 +++
.../java/org/apache/hudi/cli/commands/HoodieSyncCommand.java | 3 +++
.../java/org/apache/hudi/cli/commands/RepairsCommand.java | 3 +++
.../java/org/apache/hudi/cli/commands/RollbacksCommand.java | 5 ++++-
.../java/org/apache/hudi/cli/commands/SavepointsCommand.java | 3 +++
.../main/java/org/apache/hudi/cli/commands/SparkMain.java | 5 ++++-
.../main/java/org/apache/hudi/cli/commands/StatsCommand.java | 3 +++
.../main/java/org/apache/hudi/cli/commands/UtilsCommand.java | 3 +++
.../src/main/java/org/apache/hudi/cli/utils/CommitUtil.java | 3 +++
.../src/main/java/org/apache/hudi/cli/utils/HiveUtil.java | 3 +++
.../java/org/apache/hudi/cli/utils/InputStreamConsumer.java | 3 +++
.../src/main/java/org/apache/hudi/cli/utils/SparkUtil.java | 5 ++++-
27 files changed, 98 insertions(+), 26 deletions(-)
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieCLI.java b/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieCLI.java
index d2e6f99..0dafdc4 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieCLI.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieCLI.java
@@ -25,6 +25,9 @@ import org.apache.hudi.common.table.HoodieTableMetaClient;
import org.apache.hudi.common.util.ConsistencyGuardConfig;
import org.apache.hudi.common.util.FSUtils;
+/**
+ * This class is responsible to load table metadata and hoodie related configs.
+ */
public class HoodieCLI {
public static Configuration conf;
@@ -35,6 +38,9 @@ public class HoodieCLI {
public static HoodieTableMetaClient tableMetadata;
public static HoodieTableMetaClient syncTableMetadata;
+ /**
+ * Enum for CLI state.
+ */
public enum CLIState {
INIT, DATASET, SYNC
}
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieHistoryFileNameProvider.java b/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieHistoryFileNameProvider.java
index eeb2ff2..af01f66 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieHistoryFileNameProvider.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieHistoryFileNameProvider.java
@@ -23,6 +23,9 @@ import org.springframework.core.annotation.Order;
import org.springframework.shell.plugin.support.DefaultHistoryFileNameProvider;
import org.springframework.stereotype.Component;
+/**
+ * CLI history file provider.
+ */
@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class HoodieHistoryFileNameProvider extends DefaultHistoryFileNameProvider {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/HoodiePrintHelper.java b/hudi-cli/src/main/java/org/apache/hudi/cli/HoodiePrintHelper.java
index 3cce301..0e48911 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/HoodiePrintHelper.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/HoodiePrintHelper.java
@@ -25,12 +25,12 @@ import java.util.function.Function;
import org.apache.hudi.common.util.Option;
/**
- * Helper class to render table for hoodie-cli
+ * Helper class to render table for hoodie-cli.
*/
public class HoodiePrintHelper {
/**
- * Print header and raw rows
+ * Print header and raw rows.
*
* @param header Header
* @param rows Raw Rows
@@ -41,7 +41,7 @@ public class HoodiePrintHelper {
}
/**
- * Serialize Table to printable string
+ * Serialize Table to printable string.
*
* @param rowHeader Row Header
* @param fieldNameToConverterMap Field Specific Converters
@@ -71,7 +71,7 @@ public class HoodiePrintHelper {
}
/**
- * Render rows in Table
+ * Render rows in Table.
*
* @param buffer Table
* @return output
@@ -86,7 +86,7 @@ public class HoodiePrintHelper {
}
/**
- * Render only header of the table
+ * Render only header of the table.
*
* @param header Table Header
* @return output
@@ -98,7 +98,7 @@ public class HoodiePrintHelper {
}
/**
- * Print Text table
+ * Print Text table.
*
* @param headers Headers
* @param data Table
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/HoodiePrompt.java b/hudi-cli/src/main/java/org/apache/hudi/cli/HoodiePrompt.java
index 4ad0ad2..8b1c7e1 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/HoodiePrompt.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/HoodiePrompt.java
@@ -23,6 +23,9 @@ import org.springframework.core.annotation.Order;
import org.springframework.shell.plugin.support.DefaultPromptProvider;
import org.springframework.stereotype.Component;
+/**
+ * This class deals with displaying prompt on CLI based on the state.
+ */
@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class HoodiePrompt extends DefaultPromptProvider {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieSplashScreen.java b/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieSplashScreen.java
index 085680d..53709d6 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieSplashScreen.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/HoodieSplashScreen.java
@@ -24,6 +24,9 @@ import org.springframework.shell.plugin.support.DefaultBannerProvider;
import org.springframework.shell.support.util.OsUtils;
import org.springframework.stereotype.Component;
+/**
+ * This class is responsible to print the splash screen at the start of the application.
+ */
@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class HoodieSplashScreen extends DefaultBannerProvider {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/Main.java b/hudi-cli/src/main/java/org/apache/hudi/cli/Main.java
index b960336..99627b0 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/Main.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/Main.java
@@ -21,11 +21,11 @@ package org.apache.hudi.cli;
import java.io.IOException;
import org.springframework.shell.Bootstrap;
+/**
+ * Main class that delegates to Spring Shell's Bootstrap class in order to simplify debugging inside an IDE.
+ */
public class Main {
- /**
- * Main class that delegates to Spring Shell's Bootstrap class in order to simplify debugging inside an IDE
- */
public static void main(String[] args) throws IOException {
System.out.println("Main called");
new HoodieSplashScreen();
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/Table.java b/hudi-cli/src/main/java/org/apache/hudi/cli/Table.java
index 3569451..5a446e7 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/Table.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/Table.java
@@ -63,7 +63,7 @@ public class Table implements Iterable<List<String>> {
}
/**
- * Main API to add row to the table
+ * Main API to add row to the table.
*
* @param row Row
*/
@@ -82,7 +82,7 @@ public class Table implements Iterable<List<String>> {
}
/**
- * Add all rows
+ * Add all rows.
*
* @param rows Rows to be aded
* @return
@@ -93,7 +93,7 @@ public class Table implements Iterable<List<String>> {
}
/**
- * Add all rows
+ * Add all rows.
*
* @param rows Rows to be added
* @return
@@ -104,7 +104,7 @@ public class Table implements Iterable<List<String>> {
}
/**
- * API to let the table know writing is over and reading is going to start
+ * API to let the table know writing is over and reading is going to start.
*/
public Table flip() {
this.finishedAdding = true;
@@ -113,7 +113,7 @@ public class Table implements Iterable<List<String>> {
}
/**
- * Sorting of rows by a specified field
+ * Sorting of rows by a specified field.
*
* @return
*/
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/TableHeader.java b/hudi-cli/src/main/java/org/apache/hudi/cli/TableHeader.java
index e257e36..8ec392d 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/TableHeader.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/TableHeader.java
@@ -22,7 +22,7 @@ import java.util.ArrayList;
import java.util.List;
/**
- * Header for the table to be rendered
+ * Header for the table to be rendered.
*/
public class TableHeader {
@@ -30,7 +30,7 @@ public class TableHeader {
private final List<String> fieldNames = new ArrayList<>();
/**
- * Add a field (column) to table
+ * Add a field (column) to table.
*
* @param fieldName field Name
*/
@@ -40,14 +40,14 @@ public class TableHeader {
}
/**
- * Get all field names
+ * Get all field names.
*/
public List<String> getFieldNames() {
return fieldNames;
}
/**
- * Index of the field in the table
+ * Index of the field in the table.
*
* @param fieldName Field Name
*/
@@ -56,14 +56,14 @@ public class TableHeader {
}
/**
- * Lookup field by offset
+ * Lookup field by offset.
*/
public String get(int index) {
return fieldNames.get(index);
}
/**
- * Get number of fields in the table
+ * Get number of fields in the table.
*/
public int getNumFields() {
return fieldNames.size();
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/ArchivedCommitsCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/ArchivedCommitsCommand.java
index 9a0eff1..cafe641 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/ArchivedCommitsCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/ArchivedCommitsCommand.java
@@ -45,6 +45,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to display archived commits and stats if available.
+ */
@Component
public class ArchivedCommitsCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CleansCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CleansCommand.java
index 1257b17..b5edeae 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CleansCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CleansCommand.java
@@ -39,6 +39,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to show cleans options.
+ */
@Component
public class CleansCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CommitsCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CommitsCommand.java
index ad94865..4ae8e80 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CommitsCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CommitsCommand.java
@@ -44,6 +44,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to display commits options.
+ */
@Component
public class CommitsCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CompactionCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CompactionCommand.java
index 3d10592..8520912 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CompactionCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/CompactionCommand.java
@@ -59,6 +59,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to display compaction related options.
+ */
@Component
public class CompactionCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/DatasetsCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/DatasetsCommand.java
index b6b1a38..2ecafa9 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/DatasetsCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/DatasetsCommand.java
@@ -35,6 +35,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to display hudi dataset options.
+ */
@Component
public class DatasetsCommand implements CommandMarker {
@@ -67,7 +70,7 @@ public class DatasetsCommand implements CommandMarker {
}
/**
- * Create a Hoodie Table if it does not exist
+ * Create a Hoodie Table if it does not exist.
*
* @param path Base Path
* @param name Hoodie Table Name
@@ -113,7 +116,7 @@ public class DatasetsCommand implements CommandMarker {
}
/**
- * Describes table properties
+ * Describes table properties.
*/
@CliCommand(value = "desc", help = "Describle Hoodie Table properties")
public String descTable() {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/FileSystemViewCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/FileSystemViewCommand.java
index 6e9bde6..5d0ef50 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/FileSystemViewCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/FileSystemViewCommand.java
@@ -47,6 +47,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to display file system options.
+ */
@Component
public class FileSystemViewCommand implements CommandMarker {
@@ -206,7 +209,7 @@ public class FileSystemViewCommand implements CommandMarker {
}
/**
- * Build File System View
+ * Build File System View.
*
* @param globRegex Path Regex
* @param maxInstant Max Instants to be used for displaying file-instants
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HDFSParquetImportCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HDFSParquetImportCommand.java
index e78b735..1765840 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HDFSParquetImportCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HDFSParquetImportCommand.java
@@ -33,6 +33,9 @@ import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
import scala.collection.JavaConverters;
+/**
+ * CLI command for importing parquet dataset to hudi dataset.
+ */
@Component
public class HDFSParquetImportCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HoodieLogFileCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HoodieLogFileCommand.java
index 927909f..8c0d526 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HoodieLogFileCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HoodieLogFileCommand.java
@@ -59,6 +59,9 @@ import org.springframework.stereotype.Component;
import scala.Tuple2;
import scala.Tuple3;
+/**
+ * CLI command to display log file options.
+ */
@Component
public class HoodieLogFileCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HoodieSyncCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HoodieSyncCommand.java
index ecd15b8..024a57f 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HoodieSyncCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/HoodieSyncCommand.java
@@ -32,6 +32,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to display sync options.
+ */
@Component
public class HoodieSyncCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/RepairsCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/RepairsCommand.java
index d0365b5..3d18865 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/RepairsCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/RepairsCommand.java
@@ -34,6 +34,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to display and trigger repair options.
+ */
@Component
public class RepairsCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/RollbacksCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/RollbacksCommand.java
index 90a716f..0eac7ee 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/RollbacksCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/RollbacksCommand.java
@@ -42,6 +42,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to display rollback options.
+ */
@Component
public class RollbacksCommand implements CommandMarker {
@@ -115,7 +118,7 @@ public class RollbacksCommand implements CommandMarker {
}
/**
- * An Active timeline containing only rollbacks
+ * An Active timeline containing only rollbacks.
*/
class RollbackTimeline extends HoodieActiveTimeline {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/SavepointsCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/SavepointsCommand.java
index c243035..2481578 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/SavepointsCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/SavepointsCommand.java
@@ -40,6 +40,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to display savepoint options.
+ */
@Component
public class SavepointsCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/SparkMain.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/SparkMain.java
index 0f4cf79..34149d1 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/SparkMain.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/SparkMain.java
@@ -35,12 +35,15 @@ import org.apache.log4j.Logger;
import org.apache.spark.api.java.JavaSparkContext;
import org.apache.spark.sql.SQLContext;
+/**
+ * This class deals with initializing spark context based on command entered to hudi-cli.
+ */
public class SparkMain {
protected static final Logger LOG = Logger.getLogger(SparkMain.class);
/**
- * Commands
+ * Commands.
*/
enum SparkCommand {
ROLLBACK, DEDUPLICATE, ROLLBACK_TO_SAVEPOINT, SAVEPOINT, IMPORT, UPSERT, COMPACT_SCHEDULE, COMPACT_RUN, COMPACT_UNSCHEDULE_PLAN, COMPACT_UNSCHEDULE_FILE, COMPACT_VALIDATE, COMPACT_REPAIR
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/StatsCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/StatsCommand.java
index 8b7546b..84eb481 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/StatsCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/StatsCommand.java
@@ -47,6 +47,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to displays stats options.
+ */
@Component
public class StatsCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/UtilsCommand.java b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/UtilsCommand.java
index 514a3f8..eebcfbb 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/commands/UtilsCommand.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/commands/UtilsCommand.java
@@ -23,6 +23,9 @@ import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.core.annotation.CliOption;
import org.springframework.stereotype.Component;
+/**
+ * CLI command to display utils.
+ */
@Component
public class UtilsCommand implements CommandMarker {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/utils/CommitUtil.java b/hudi-cli/src/main/java/org/apache/hudi/cli/utils/CommitUtil.java
index 26568e7..e91d20a 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/utils/CommitUtil.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/utils/CommitUtil.java
@@ -25,6 +25,9 @@ import org.apache.hudi.common.table.HoodieTableMetaClient;
import org.apache.hudi.common.table.HoodieTimeline;
import org.apache.hudi.common.table.timeline.HoodieInstant;
+/**
+ * Utilities related to commit operation.
+ */
public class CommitUtil {
public static long countNewRecords(HoodieTableMetaClient target, List<String> commitsToCatchup) throws IOException {
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/utils/HiveUtil.java b/hudi-cli/src/main/java/org/apache/hudi/cli/utils/HiveUtil.java
index dfeae26..8ebb41c 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/utils/HiveUtil.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/utils/HiveUtil.java
@@ -26,6 +26,9 @@ import java.sql.Statement;
import org.apache.hudi.common.table.HoodieTableMetaClient;
import org.joda.time.DateTime;
+/**
+ * Hive connection related utilities.
+ */
public class HiveUtil {
private static final String driverName = "org.apache.hive.jdbc.HiveDriver";
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/utils/InputStreamConsumer.java b/hudi-cli/src/main/java/org/apache/hudi/cli/utils/InputStreamConsumer.java
index ec00154..625793c 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/utils/InputStreamConsumer.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/utils/InputStreamConsumer.java
@@ -24,6 +24,9 @@ import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.logging.Logger;
+/**
+ * This class is responsible to read a Process output.
+ */
public class InputStreamConsumer extends Thread {
protected static final Logger LOG = Logger.getLogger(InputStreamConsumer.class.getName());
diff --git a/hudi-cli/src/main/java/org/apache/hudi/cli/utils/SparkUtil.java b/hudi-cli/src/main/java/org/apache/hudi/cli/utils/SparkUtil.java
index e8d2a08..3011981 100644
--- a/hudi-cli/src/main/java/org/apache/hudi/cli/utils/SparkUtil.java
+++ b/hudi-cli/src/main/java/org/apache/hudi/cli/utils/SparkUtil.java
@@ -29,13 +29,16 @@ import org.apache.spark.SparkConf;
import org.apache.spark.api.java.JavaSparkContext;
import org.apache.spark.launcher.SparkLauncher;
+/**
+ * Utility functions dealing with Spark.
+ */
public class SparkUtil {
public static Logger logger = Logger.getLogger(SparkUtil.class);
public static final String DEFUALT_SPARK_MASTER = "yarn-client";
/**
- * TODO: Need to fix a bunch of hardcoded stuff here eg: history server, spark distro
+ * TODO: Need to fix a bunch of hardcoded stuff here eg: history server, spark distro.
*/
public static SparkLauncher initLauncher(String propertiesFile) throws URISyntaxException {
String currentJar = new File(SparkUtil.class.getProtectionDomain().getCodeSource().getLocation().toURI().getPath())