org.apache.hadoop.fs.s3a.select

Class SelectTool

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.s3a.s3guard.S3GuardTool

org.apache.hadoop.fs.s3a.select.SelectTool

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

public class SelectTool
extends S3GuardTool

This is a CLI tool for the select operation, which is available through the S3Guard command. Usage:

   hadoop s3guard select [options] Path Statement
 

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.fs.s3a.s3guard.S3GuardTool

S3GuardTool.BucketInfo

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME
static String	OPT_COMPRESSION
static String	OPT_EXPECTED
static String	OPT_HEADER
static String	OPT_INPUTFORMAT
static String	OPT_LIMIT
static String	OPT_OUTPUT
static String	OPT_OUTPUTFORMAT
static String	PURPOSE

Fields inherited from class org.apache.hadoop.fs.s3a.s3guard.S3GuardTool

AGE_OPTIONS_USAGE, CMK_FLAG, DAYS_FLAG, HOURS_FLAG, META_FLAG, MINUTES_FLAG, READ_FLAG, REGION_FLAG, SECONDS_FLAG, SSE_FLAG, TAG_FLAG, VERBOSE, WRITE_FLAG, WRONG_FILESYSTEM

Constructor Summary

Constructors

Constructor and Description
SelectTool(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
static double	bandwidthMBs(long bytes, long durationMillisNS) Work out the bandwidth in MB/s.
long	getBytesRead()
long	getLinesRead() Number of lines read, when printing to the console.
String	getName() Return sub-command name.
org.apache.hadoop.util.OperationDuration	getSelectDuration()
String	getUsage()
int	run(String[] args, PrintStream out) Execute the select operation.

Methods inherited from class org.apache.hadoop.fs.s3a.s3guard.S3GuardTool

addAgeOptions, badState, bindFilesystem, checkBucketNameOrDDBTableNameProvided, checkIfS3BucketIsGuarded, close, dumpFileSystemStatistics, errorln, errorln, exit, exitException, getCommandFormat, getFilesystem, getStore, initMetadataStore, initS3AFileSystem, invalidArgs, main, parseArgs, parseDynamoDBRegion, println, printStoreDiagnostics, resetBindings, run, run, setStore, storeNotFound, toUri, userAborted

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

PURPOSE

public static final String PURPOSE

See Also:

Constant Field Values

OPT_COMPRESSION

public static final String OPT_COMPRESSION

See Also:

Constant Field Values

OPT_EXPECTED

public static final String OPT_EXPECTED

See Also:

Constant Field Values

OPT_HEADER

public static final String OPT_HEADER

See Also:

Constant Field Values

OPT_INPUTFORMAT

public static final String OPT_INPUTFORMAT

See Also:

Constant Field Values

OPT_LIMIT

public static final String OPT_LIMIT

See Also:

Constant Field Values

OPT_OUTPUT

public static final String OPT_OUTPUT

See Also:

Constant Field Values

OPT_OUTPUTFORMAT

public static final String OPT_OUTPUTFORMAT

See Also:

Constant Field Values

Constructor Detail

SelectTool

public SelectTool(org.apache.hadoop.conf.Configuration conf)

Method Detail

getName

public String getName()

Description copied from class: S3GuardTool

Return sub-command name.

Specified by:

getName in class S3GuardTool

Returns:

sub-command name.

getUsage

public String getUsage()

Specified by:

getUsage in class S3GuardTool

getSelectDuration

public org.apache.hadoop.util.OperationDuration getSelectDuration()

getBytesRead

public long getBytesRead()

getLinesRead

public long getLinesRead()

Number of lines read, when printing to the console.

Returns:

line count. 0 if writing direct to a file.

run

public int run(String[] args,
               PrintStream out)
        throws IOException,
               org.apache.hadoop.util.ExitUtil.ExitException

Execute the select operation.

Specified by:

run in class S3GuardTool

Parameters:

args - argument list

out - output stream

Returns:

an exit code

Throws:

IOException - IO failure

ExitUtil.ExitException - managed failure

bandwidthMBs

public static double bandwidthMBs(long bytes,
                                  long durationMillisNS)

Work out the bandwidth in MB/s.

Parameters:

bytes - bytes

durationMillisNS - duration in nanos

Returns:

the number of megabytes/second of the recorded operation