org.apache.hudi.cli.commands

Class DiffCommand

java.lang.Object

org.apache.hudi.cli.commands.DiffCommand

@ShellComponent
public class DiffCommand
extends Object

Given a file id or partition value, this command line utility tracks the changes to the file group or partition across range of commits. Usage: diff file --fileId

Constructor Summary

Constructors

Constructor and Description
DiffCommand()

Method Summary

Modifier and Type	Method and Description
String	diffFile(String fileId, String startTs, String endTs, Integer limit, String sortByField, boolean descending, boolean headerOnly, boolean includeArchivedTimeline)
String	diffPartition(String partitionPath, String startTs, String endTs, Integer limit, String sortByField, boolean descending, boolean headerOnly, boolean includeArchivedTimeline)

Methods inherited from class java.lang.Object

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

Constructor Detail

DiffCommand

public DiffCommand()

Method Detail

diffFile

@ShellMethod(key="diff file",
             value="Check how file differs across range of commits")
public String diffFile(@ShellOption(value="--fileId",help="File ID to diff across range of commits")
                                                                                                                          String fileId,
                                                                                                                          @ShellOption(value="--startTs",help="start time for compactions, default: now - 10 days",defaultValue="__NULL__")
                                                                                                                          String startTs,
                                                                                                                          @ShellOption(value="--endTs",help="end time for compactions, default: now - 1 day",defaultValue="__NULL__")
                                                                                                                          String endTs,
                                                                                                                          @ShellOption(value="--limit",help="Limit compactions",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 IOException

Throws:

IOException

diffPartition

@ShellMethod(key="diff partition",
             value="Check how file differs across range of commits. It is meant to be used only for partitioned tables.")
public String diffPartition(@ShellOption(value="--partitionPath",help="Relative partition path to diff across range of commits")
                                                                                                                                                                                         String partitionPath,
                                                                                                                                                                                         @ShellOption(value="--startTs",help="start time for compactions, default: now - 10 days",defaultValue="__NULL__")
                                                                                                                                                                                         String startTs,
                                                                                                                                                                                         @ShellOption(value="--endTs",help="end time for compactions, default: now - 1 day",defaultValue="__NULL__")
                                                                                                                                                                                         String endTs,
                                                                                                                                                                                         @ShellOption(value="--limit",help="Limit compactions",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 IOException

Throws:

IOException