org.apache.hudi.cli.commands

Class CleansCommand

java.lang.Object

org.apache.hudi.cli.commands.CleansCommand

@ShellComponent
public class CleansCommand
extends Object

CLI command to show cleans options.

Constructor Summary

Constructors

Constructor and Description
CleansCommand()

Method Summary

Modifier and Type	Method and Description
String	runClean(String sparkMemory, String propsFilePath, String[] configs, String master)
String	showCleanPartitions(String instantTime, Integer limit, String sortByField, boolean descending, boolean headerOnly)
String	showCleans(Integer limit, String sortByField, String startTs, String endTs, boolean includeArchivedTimeline, boolean descending, boolean headerOnly)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CleansCommand

public CleansCommand()

Method Detail

showCleans

@ShellMethod(key="cleans show",
             value="Show the cleans")
public String showCleans(@ShellOption(value="--limit",help="Limit commits",defaultValue="-1")
                                                                                               Integer limit,
                                                                                               @ShellOption(value="--sortBy",help="Sorting Field",defaultValue="")
                                                                                               String sortByField,
                                                                                               @ShellOption(value="--startTs",help="start time for cleans, default: now - 10 days",defaultValue="__NULL__")
                                                                                               String startTs,
                                                                                               @ShellOption(value="--endTs",help="end time for clean, default: upto latest",defaultValue="__NULL__")
                                                                                               String endTs,
                                                                                               @ShellOption(value="--includeArchivedTimeline",help="Include archived commits as well",defaultValue="false")
                                                                                               boolean includeArchivedTimeline,
                                                                                               @ShellOption(value="--desc",help="Ordering",defaultValue="false")
                                                                                               boolean descending,
                                                                                               @ShellOption(value="--headeronly",help="Print Header Only",defaultValue="false")
                                                                                               boolean headerOnly)
                                                                                        throws IOException

Throws:

IOException

showCleanPartitions

@ShellMethod(key="clean showpartitions",
             value="Show partition level details of a clean")
public String showCleanPartitions(@ShellOption(value="--clean",help="clean to show")
                                                                                                                                         String instantTime,
                                                                                                                                         @ShellOption(value="--limit",help="Limit commits",defaultValue="-1")
                                                                                                                                         Integer limit,
                                                                                                                                         @ShellOption(value="--sortBy",help="Sorting Field",defaultValue="")
                                                                                                                                         String sortByField,
                                                                                                                                         @ShellOption(value="--desc",help="Ordering",defaultValue="false")
                                                                                                                                         boolean descending,
                                                                                                                                         @ShellOption(value="--headeronly",help="Print Header Only",defaultValue="false")
                                                                                                                                         boolean headerOnly)
                                                                                                                                  throws Exception

Throws:

Exception

runClean

@ShellMethod(key="cleans run",
             value="run clean")
public String runClean(@ShellOption(value="--sparkMemory",defaultValue="4G",help="Spark executor memory")
                                                                                      String sparkMemory,
                                                                                      @ShellOption(value="--propsFilePath",help="path to properties file on localfs or dfs with configurations for hoodie client for cleaning",defaultValue="")
                                                                                      String propsFilePath,
                                                                                      @ShellOption(value="--hoodieConfigs",help="Any configuration that can be set in the properties file can be passed here in the form of an array",defaultValue="")
                                                                                      String[] configs,
                                                                                      @ShellOption(value="--sparkMaster",defaultValue="",help="Spark Master ")
                                                                                      String master)
                                                                               throws IOException,
                                                                                      InterruptedException,
                                                                                      URISyntaxException

Throws:

IOException

InterruptedException

URISyntaxException