org.apache.hudi.cli.commands

Class ArchivedCommitsCommand

java.lang.Object

org.apache.hudi.cli.commands.ArchivedCommitsCommand

@ShellComponent
public class ArchivedCommitsCommand
extends Object

CLI command to display archived commits and stats if available.

Constructor Summary

Constructors

Constructor and Description
ArchivedCommitsCommand()

Method Summary

Modifier and Type	Method and Description
String	showArchivedCommits(String folder, Integer limit, String sortByField, boolean descending, boolean headerOnly)
String	showCommits(boolean skipMetadata, Integer limit, String sortByField, boolean descending, boolean headerOnly)
String	triggerArchival(int minCommits, int maxCommits, int retained, boolean enableMetadata, String sparkMemory, String master)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchivedCommitsCommand

public ArchivedCommitsCommand()

Method Detail

triggerArchival

@ShellMethod(key="trigger archival",
             value="trigger archival")
public String triggerArchival(@ShellOption(value="--minCommits",help="Minimum number of instants to retain in the active timeline. See hoodie.keep.min.commits",defaultValue="20")
                                                                                                          int minCommits,
                                                                                                          @ShellOption(value="--maxCommits",help="Maximum number of instants to retain in the active timeline. See hoodie.keep.max.commits",defaultValue="30")
                                                                                                          int maxCommits,
                                                                                                          @ShellOption(value="--commitsRetainedByCleaner",help="Number of commits to retain, without cleaning",defaultValue="10")
                                                                                                          int retained,
                                                                                                          @ShellOption(value="--enableMetadata",help="Enable the internal metadata table which serves table metadata like level file listings",defaultValue="true")
                                                                                                          boolean enableMetadata,
                                                                                                          @ShellOption(value="--sparkMemory",defaultValue="1G",help="Spark executor memory")
                                                                                                          String sparkMemory,
                                                                                                          @ShellOption(value="--sparkMaster",defaultValue="local",help="Spark Master")
                                                                                                          String master)
                                                                                                   throws Exception

Throws:

Exception

showArchivedCommits

@ShellMethod(key="show archived commit stats",
             value="Read commits from archived files and show file group details")
public String showArchivedCommits(@ShellOption(value="--archiveFolderPattern",help="Archive Folder",defaultValue="")
                                                                                                                                                                    String folder,
                                                                                                                                                                    @ShellOption(value="--limit",help="Limit commits",defaultValue="10")
                                                                                                                                                                    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 IOException

Throws:

IOException

showCommits

@ShellMethod(key="show archived commits",
             value="Read commits from archived files and show details")
public String showCommits(@ShellOption(value="--skipMetadata",help="Skip displaying commit metadata",defaultValue="true")
                                                                                                                                            boolean skipMetadata,
                                                                                                                                            @ShellOption(value="--limit",help="Limit commits",defaultValue="10")
                                                                                                                                            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 IOException

Throws:

IOException