org.apache.hudi.cli.commands

Class CommitsCommand

java.lang.Object

org.apache.hudi.cli.commands.CommitsCommand

@ShellComponent
public class CommitsCommand
extends Object

CLI command to display commits options.

Constructor Summary

Constructors

Constructor and Description
CommitsCommand()

Method Summary

Modifier and Type	Method and Description
String	compareCommits(String path)
String	showArchivedCommits(boolean includeExtraMetadata, String exportTableName, String startTs, String endTs, Integer limit, String sortByField, boolean descending, boolean headerOnly, String partition)
String	showCommitFiles(String exportTableName, String instantTime, Integer limit, String sortByField, boolean descending, boolean headerOnly, boolean includeArchivedTimeline)
String	showCommitPartitions(String exportTableName, String instantTime, Integer limit, String sortByField, boolean descending, boolean headerOnly, boolean includeArchivedTimeline)
String	showCommits(boolean includeExtraMetadata, String exportTableName, Integer limit, String sortByField, boolean descending, boolean headerOnly, String partition, boolean includeArchivedTimeline)
String	showWriteStats(String exportTableName, String instantTime, Integer limit, String sortByField, boolean descending, boolean headerOnly, boolean includeArchivedTimeline)
String	syncCommits(String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitsCommand

public CommitsCommand()

Method Detail

showCommits

@ShellMethod(key="commits show",
             value="Show the commits")
public String showCommits(@ShellOption(value="--includeExtraMetadata",help="Include extra metadata",defaultValue="false")
                                                                                                  boolean includeExtraMetadata,
                                                                                                  @ShellOption(value="--createView",help="view name to store output table",defaultValue="")
                                                                                                  String exportTableName,
                                                                                                  @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,
                                                                                                  @ShellOption(value="--partition",help="Partition value",defaultValue="__NULL__")
                                                                                                  String partition,
                                                                                                  @ShellOption(value="--includeArchivedTimeline",help="Include archived commits as well",defaultValue="false")
                                                                                                  boolean includeArchivedTimeline)
                                                                                           throws IOException

Throws:

IOException

showArchivedCommits

@ShellMethod(key="commits showarchived",
             value="Show the archived commits")
public String showArchivedCommits(@ShellOption(value="--includeExtraMetadata",help="Include extra metadata",defaultValue="false")
                                                                                                                           boolean includeExtraMetadata,
                                                                                                                           @ShellOption(value="--createView",help="view name to store output table",defaultValue="")
                                                                                                                           String exportTableName,
                                                                                                                           @ShellOption(value="--startTs",defaultValue="__NULL__",help="start time for commits, default: now - 10 days")
                                                                                                                           String startTs,
                                                                                                                           @ShellOption(value="--endTs",defaultValue="__NULL__",help="end time for commits, default: now - 1 day")
                                                                                                                           String endTs,
                                                                                                                           @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,
                                                                                                                           @ShellOption(value="--partition",help="Partition value",defaultValue="__NULL__")
                                                                                                                           String partition)
                                                                                                                    throws IOException

Throws:

IOException

showCommitPartitions

@ShellMethod(key="commit showpartitions",
             value="Show partition level details of a commit")
public String showCommitPartitions(@ShellOption(value="--createView",help="view name to store output table",defaultValue="")
                                                                                                                                            String exportTableName,
                                                                                                                                            @ShellOption(value="--commit",help="Commit 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,
                                                                                                                                            @ShellOption(value="--includeArchivedTimeline",help="Include archived commits as well",defaultValue="false")
                                                                                                                                            boolean includeArchivedTimeline)
                                                                                                                                     throws Exception

Throws:

Exception

showWriteStats

@ShellMethod(key="commit show_write_stats",
             value="Show write stats of a commit")
public String showWriteStats(@ShellOption(value="--createView",help="view name to store output table",defaultValue="")
                                                                                                                            String exportTableName,
                                                                                                                            @ShellOption(value="--commit",help="Commit 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,
                                                                                                                            @ShellOption(value="--includeArchivedTimeline",help="Include archived commits as well",defaultValue="false")
                                                                                                                            boolean includeArchivedTimeline)
                                                                                                                     throws Exception

Throws:

Exception

showCommitFiles

@ShellMethod(key="commit showfiles",
             value="Show file level details of a commit")
public String showCommitFiles(@ShellOption(value="--createView",help="view name to store output table",defaultValue="")
                                                                                                                             String exportTableName,
                                                                                                                             @ShellOption(value="--commit",help="Commit 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,
                                                                                                                             @ShellOption(value="--includeArchivedTimeline",help="Include archived commits as well",defaultValue="false")
                                                                                                                             boolean includeArchivedTimeline)
                                                                                                                      throws Exception

Throws:

Exception

compareCommits

@ShellMethod(key="commits compare",
             value="Compare commits with another Hoodie table")
public String compareCommits(@ShellOption(value="--path",help="Path of the table to compare to")
                                                                                                                                 String path)

syncCommits

@ShellMethod(key="commits sync",
             value="Sync commits with another Hoodie table")
public String syncCommits(@ShellOption(value="--path",help="Path of the table to sync to")
                                                                                                                        String path)