You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hudi.apache.org by GitBox <gi...@apache.org> on 2021/11/18 18:46:38 UTC

[GitHub] [hudi] yihua commented on a change in pull request #4010: [HUDI-2770] - Docs for (HUDI-2737) - Use earliest instant for async compaction and clustering

yihua commented on a change in pull request #4010:
URL: https://github.com/apache/hudi/pull/4010#discussion_r752521510



##########
File path: website/docs/clustering.md
##########
@@ -165,7 +165,8 @@ With the release of Hudi version 0.9.0, we can schedule as well as execute clust
 specify the `—mode` or `-m` option. There are three modes:
 
 1. `schedule`: Make a clustering plan. This gives an instant which can be passed in execute mode.
-2. `execute`: Execute a clustering plan at given instant which means --instant-time is required here.
+2. `execute`: Execute a clustering plan at a given instant which means --instant-time is required. 

Review comment:
       @nsivabalan are the docs forward-looking, or do they have to capture nuances of all versions as well?  I'm wondering if docs are only looking forward, we don't have to mention that `--instant-time is required` for older versions.

##########
File path: website/docs/compaction.md
##########
@@ -74,22 +67,46 @@ spark-submit --packages org.apache.hudi:hudi-utilities-bundle_2.11:0.6.0 \
 --continous
 ```
 
-### Hudi CLI
-Hudi CLI is yet another way to execute specific compactions asynchronously. Here is an example
+## Executing Async Compaction
+After compactions have been asynchronously scheduled on the Hudi Timeline, you can now execute those compactions with one of the following options
 
-```properties
-hudi:trips->compaction run --tableName <table_name> --parallelism <parallelism> --compactionInstant <InstantTime>
-...
-```
+### Hudi Compactor Utility
+Hudi provides a standalone tool to execute specific compactions asynchronously. Below is an example and you can read more in the [deployment guide](/docs/deployment#compactions)
 
-### Hudi Compactor Script
-Hudi provides a standalone tool to also execute specific compactions asynchronously. Below is an example and you can read more in the [deployment guide](/docs/next/deployment#compactions)
+:::info
+Note: As of version 0.10.0, the `instant-time` parameter is no longer required for the Hudi Compactor Utility. Each spark-submit will execute the earliest scheduled compaction on the Hudi timeline.
+:::
 
 ```properties
 spark-submit --packages org.apache.hudi:hudi-utilities-bundle_2.11:0.6.0 \
 --class org.apache.hudi.utilities.HoodieCompactor \
 --base-path <base_path> \
 --table-name <table_name> \
---instant-time <compaction_instant> \
---schema-file <schema_file>
+--schema-file <schema_file>\
+--instant-time <compaction_instant>
 ```
+
+### Hudi CLI
+Hudi CLI is yet another way to execute specific compactions asynchronously. Here is an example and you can read more in the [deployment guide](/docs/deployment#compactions)
+
+```properties
+hudi:trips->compaction run --tableName <table_name> --parallelism <parallelism> --compactionInstant <InstantTime>
+...
+```
+

Review comment:
       Shall we add a link here to refer to other compaction commands in hudi-cli (https://hudi.apache.org/docs/next/cli#compactions)?  Especially when the user would like to find the compaction instant, `compactions show` commands are helpful.

##########
File path: website/docs/compaction.md
##########
@@ -74,22 +67,46 @@ spark-submit --packages org.apache.hudi:hudi-utilities-bundle_2.11:0.6.0 \
 --continous
 ```
 
-### Hudi CLI
-Hudi CLI is yet another way to execute specific compactions asynchronously. Here is an example
+## Executing Async Compaction
+After compactions have been asynchronously scheduled on the Hudi Timeline, you can now execute those compactions with one of the following options
 
-```properties
-hudi:trips->compaction run --tableName <table_name> --parallelism <parallelism> --compactionInstant <InstantTime>
-...
-```
+### Hudi Compactor Utility
+Hudi provides a standalone tool to execute specific compactions asynchronously. Below is an example and you can read more in the [deployment guide](/docs/deployment#compactions)
 
-### Hudi Compactor Script
-Hudi provides a standalone tool to also execute specific compactions asynchronously. Below is an example and you can read more in the [deployment guide](/docs/next/deployment#compactions)
+:::info
+Note: As of version 0.10.0, the `instant-time` parameter is no longer required for the Hudi Compactor Utility. Each spark-submit will execute the earliest scheduled compaction on the Hudi timeline.
+:::
 
 ```properties
 spark-submit --packages org.apache.hudi:hudi-utilities-bundle_2.11:0.6.0 \
 --class org.apache.hudi.utilities.HoodieCompactor \
 --base-path <base_path> \
 --table-name <table_name> \
---instant-time <compaction_instant> \
---schema-file <schema_file>
+--schema-file <schema_file>\

Review comment:
       nit: space before backslash




-- 
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: commits-unsubscribe@hudi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org