org.apache.hadoop.fs.s3a.s3guard

Class PurgeS3GuardDynamoTable

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.service.launcher.AbstractLaunchableService

org.apache.hadoop.fs.s3a.s3guard.AbstractS3GuardDynamoDBDiagnostic

org.apache.hadoop.fs.s3a.s3guard.PurgeS3GuardDynamoTable

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.service.launcher.LaunchableService, org.apache.hadoop.service.Service

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class PurgeS3GuardDynamoTable
extends AbstractS3GuardDynamoDBDiagnostic

Purge the S3Guard table of a FileSystem from all entries related to that table. Will fail if there is no table, or the store is in auth mode.

   hadoop org.apache.hadoop.fs.s3a.s3guard.PurgeS3GuardDynamoTable \
   -force s3a://example-bucket/
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORCE Name of the force option.
static String	NAME

Constructor Summary

Constructors

Constructor and Description
PurgeS3GuardDynamoTable()
PurgeS3GuardDynamoTable(S3AFileSystem filesystem, DynamoDBMetadataStore store, URI uri, boolean force)
PurgeS3GuardDynamoTable(String name)

Method Summary

Modifier and Type	Method and Description
int	execute() Extract the host from the FS URI, then scan and delete all entries from that bucket.
static void	main(String[] args) This is the Main entry point for the service launcher.
static org.apache.commons.lang3.tuple.Pair<Long,Long>	purgeStore(S3AFileSystem fs, DynamoDBMetadataStore store, org.apache.hadoop.conf.Configuration conf, URI uri, boolean force) API Entry point to dump the metastore and S3 store world views
protected void	serviceStart() Bind to the argument list, including validating the CLI.

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

bindArgs, bindFromCLI, failure, failure, getArgumentList, getArguments, getFilesystem, getStore, getUri, require, setUri, setUri

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, serviceInit, serviceStop, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.service.Service

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, registerServiceListener, start, stop, unregisterServiceListener, waitForServiceToStop

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

FORCE

public static final String FORCE

Name of the force option.

See Also:

Constant Field Values

Constructor Detail

PurgeS3GuardDynamoTable

public PurgeS3GuardDynamoTable(String name)

PurgeS3GuardDynamoTable

public PurgeS3GuardDynamoTable()

PurgeS3GuardDynamoTable

public PurgeS3GuardDynamoTable(S3AFileSystem filesystem,
                               DynamoDBMetadataStore store,
                               URI uri,
                               boolean force)

Method Detail

serviceStart

protected void serviceStart()
                     throws Exception

Bind to the argument list, including validating the CLI.

Overrides:

serviceStart in class org.apache.hadoop.service.AbstractService

Throws:

Exception - failure.

execute

public int execute()
            throws org.apache.hadoop.service.launcher.ServiceLaunchException,
                   IOException

Extract the host from the FS URI, then scan and delete all entries from that bucket.

Specified by:

execute in interface org.apache.hadoop.service.launcher.LaunchableService

Overrides:

execute in class org.apache.hadoop.service.launcher.AbstractLaunchableService

Returns:

the exit code.

Throws:

org.apache.hadoop.service.launcher.ServiceLaunchException - on failure.

IOException - IO failure.

main

public static void main(String[] args)

This is the Main entry point for the service launcher. Converts the arguments to a list, instantiates a instance of the class then executes it.

Parameters:

args - command line arguments.

purgeStore

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public static org.apache.commons.lang3.tuple.Pair<Long,Long> purgeStore(@Nullable
                                                                                                                                 S3AFileSystem fs,
                                                                                                                                 @Nullable
                                                                                                                                 DynamoDBMetadataStore store,
                                                                                                                                 @Nullable
                                                                                                                                 org.apache.hadoop.conf.Configuration conf,
                                                                                                                                 @Nullable
                                                                                                                                 URI uri,
                                                                                                                                 boolean force)
                                                                                                                          throws org.apache.hadoop.util.ExitUtil.ExitException

API Entry point to dump the metastore and S3 store world views

Both the FS and the store will be dumped: the store is scanned before and after the sequence to show what changes were made to the store during the list operation.

Parameters:

fs - fs to dump. If null a store must be provided.

store - store to dump (fallback to FS)

conf - configuration to use (fallback to fs)

uri - URI of store -only needed if FS is null.

force - force the actual delete

Returns:

(filesFound, filesDeleted)

Throws:

ExitUtil.ExitException - failure.