org.apache.hudi.cli.commands

Class FileSystemViewCommand

java.lang.Object

org.apache.hudi.cli.commands.FileSystemViewCommand

@ShellComponent
public class FileSystemViewCommand
extends Object

CLI command to display file system options.

Constructor Summary

Constructors

Constructor and Description
FileSystemViewCommand()

Method Summary

Modifier and Type	Method and Description
String	showAllFileSlices(String globRegex, boolean baseFileOnly, String maxInstant, boolean includeMaxInstant, boolean includeInflight, boolean excludeCompaction, Integer limit, String sortByField, boolean descending, boolean headerOnly)
String	showLatestFileSlices(String partition, boolean baseFileOnly, String maxInstant, boolean merge, boolean includeMaxInstant, boolean includeInflight, boolean excludeCompaction, Integer limit, String sortByField, boolean descending, boolean headerOnly)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemViewCommand

public FileSystemViewCommand()

Method Detail

showAllFileSlices

@ShellMethod(key="show fsview all",
             value="Show entire file-system view")
public String showAllFileSlices(@ShellOption(value="--pathRegex",help="regex to select files, eg: par1",defaultValue="*")
                                                                                                                       String globRegex,
                                                                                                                       @ShellOption(value="--baseFileOnly",help="Only display base files view",defaultValue="false")
                                                                                                                       boolean baseFileOnly,
                                                                                                                       @ShellOption(value="--maxInstant",help="File-Slices upto this instant are displayed",defaultValue="")
                                                                                                                       String maxInstant,
                                                                                                                       @ShellOption(value="--includeMax",help="Include Max Instant",defaultValue="false")
                                                                                                                       boolean includeMaxInstant,
                                                                                                                       @ShellOption(value="--includeInflight",help="Include Inflight Instants",defaultValue="false")
                                                                                                                       boolean includeInflight,
                                                                                                                       @ShellOption(value="--excludeCompaction",help="Exclude compaction Instants",defaultValue="false")
                                                                                                                       boolean excludeCompaction,
                                                                                                                       @ShellOption(value="--limit",help="Limit rows to be displayed",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 IOException

Throws:

IOException

showLatestFileSlices

@ShellMethod(key="show fsview latest",
             value="Show latest file-system view")
public String showLatestFileSlices(@ShellOption(value="--partitionPath",help="A valid partition path",defaultValue="")
                                                                                                                             String partition,
                                                                                                                             @ShellOption(value="--baseFileOnly",help="Only display base file view",defaultValue="false")
                                                                                                                             boolean baseFileOnly,
                                                                                                                             @ShellOption(value="--maxInstant",help="File-Slices upto this instant are displayed",defaultValue="")
                                                                                                                             String maxInstant,
                                                                                                                             @ShellOption(value="--merge",help="Merge File Slices due to pending compaction",defaultValue="true")
                                                                                                                             boolean merge,
                                                                                                                             @ShellOption(value="--includeMax",help="Include Max Instant",defaultValue="false")
                                                                                                                             boolean includeMaxInstant,
                                                                                                                             @ShellOption(value="--includeInflight",help="Include Inflight Instants",defaultValue="false")
                                                                                                                             boolean includeInflight,
                                                                                                                             @ShellOption(value="--excludeCompaction",help="Exclude compaction Instants",defaultValue="false")
                                                                                                                             boolean excludeCompaction,
                                                                                                                             @ShellOption(value="--limit",help="Limit rows to be displayed",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 IOException

Throws:

IOException