Package io.trino.hdfs.s3

Class TrinoS3FileSystem

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.FileSystem

io.trino.hdfs.s3.TrinoS3FileSystem

All Implemented Interfaces:

FileSystemWithBatchDelete, MemoryAwareFileSystem, OpenTelemetryAwareFileSystem, Closeable, AutoCloseable, org.apache.hadoop.conf.Configurable, org.apache.hadoop.fs.PathCapabilities, org.apache.hadoop.security.token.DelegationTokenIssuer

Direct Known Subclasses:

TrinoCosFileSystem

public class TrinoS3FileSystem
extends org.apache.hadoop.fs.FileSystem
implements FileSystemWithBatchDelete, MemoryAwareFileSystem, OpenTelemetryAwareFileSystem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TrinoS3FileSystem.UnrecoverableS3OperationException	This exception is for stopping retries for S3 calls that shouldn't be retried.

Nested classes/interfaces inherited from class org.apache.hadoop.fs.FileSystem

org.apache.hadoop.fs.FileSystem.DirectoryEntries, org.apache.hadoop.fs.FileSystem.DirListingIterator<T extends org.apache.hadoop.fs.FileStatus>, org.apache.hadoop.fs.FileSystem.Statistics

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DELETE_BATCH_SIZE
static final String	S3_ACCESS_KEY
static final String	S3_ACL_TYPE
static final String	S3_CONNECT_TIMEOUT
static final String	S3_CONNECT_TTL
static final String	S3_CREDENTIALS_PROVIDER
static final String	S3_ENCRYPTION_MATERIALS_PROVIDER
static final String	S3_ENDPOINT
static final String	S3_EXTERNAL_ID
static final String	S3_IAM_ROLE
static final String	S3_KMS_KEY_ID
static final String	S3_MAX_BACKOFF_TIME
static final String	S3_MAX_CLIENT_RETRIES
static final String	S3_MAX_CONNECTIONS
static final String	S3_MAX_ERROR_RETRIES
static final String	S3_MAX_RETRY_TIME
static final String	S3_MULTIPART_MIN_FILE_SIZE
static final String	S3_MULTIPART_MIN_PART_SIZE
static final String	S3_NON_PROXY_HOSTS
static final String	S3_PATH_STYLE_ACCESS
static final String	S3_PIN_CLIENT_TO_CURRENT_REGION
static final String	S3_PREEMPTIVE_BASIC_PROXY_AUTH
static final String	S3_PROXY_HOST
static final String	S3_PROXY_PASSWORD
static final String	S3_PROXY_PORT
static final String	S3_PROXY_PROTOCOL
static final String	S3_PROXY_USERNAME
static final String	S3_REGION
static final String	S3_REQUESTER_PAYS_ENABLED
static final String	S3_ROLE_SESSION_NAME
static final String	S3_SECRET_KEY
static final String	S3_SESSION_TOKEN
static final String	S3_SIGNER_CLASS
static final String	S3_SIGNER_TYPE
static final String	S3_SKIP_GLACIER_OBJECTS
static final String	S3_SOCKET_TIMEOUT
static final String	S3_SSE_ENABLED
static final String	S3_SSE_KMS_KEY_ID
static final String	S3_SSE_TYPE
static final String	S3_SSL_ENABLED
static final String	S3_STAGING_DIRECTORY
static final String	S3_STORAGE_CLASS
static final String	S3_STREAMING_UPLOAD_ENABLED
static final String	S3_STREAMING_UPLOAD_PART_SIZE
static final String	S3_STS_ENDPOINT
static final String	S3_STS_REGION
static final String	S3_USER_AGENT_PREFIX

Fields inherited from class org.apache.hadoop.fs.FileSystem

DEFAULT_FS, FS_DEFAULT_NAME_KEY, LOG, SHUTDOWN_HOOK_PRIORITY, statistics, TRASH_PREFIX, USER_HOME_PREFIX

Constructor Summary

Constructors

Constructor	Description
TrinoS3FileSystem()

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.fs.FSDataOutputStream	append(org.apache.hadoop.fs.Path f, int bufferSize, org.apache.hadoop.util.Progressable progress)
void	close()
org.apache.hadoop.fs.FSDataOutputStream	create(org.apache.hadoop.fs.Path path, AggregatedMemoryContext aggregatedMemoryContext)
org.apache.hadoop.fs.FSDataOutputStream	create(org.apache.hadoop.fs.Path path, org.apache.hadoop.fs.permission.FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, org.apache.hadoop.util.Progressable progress)
boolean	delete(org.apache.hadoop.fs.Path path, boolean recursive)
void	deleteFiles(Collection<org.apache.hadoop.fs.Path> paths)
static String	extractBucketName(URI uri)	Helper function used to work around the fact that if you use an S3 bucket with an '_' that java.net.URI behaves differently and sets the host value to null whereas S3 buckets without '_' have a properly set host field.
protected String	getBucketName(URI uri)
org.apache.hadoop.fs.FileStatus	getFileStatus(org.apache.hadoop.fs.Path path)
static TrinoS3FileSystemStats	getFileSystemStats()
com.amazonaws.services.s3.AmazonS3	getS3Client()
String	getScheme()
URI	getUri()
org.apache.hadoop.fs.Path	getWorkingDirectory()
void	initialize(URI uri, org.apache.hadoop.conf.Configuration conf)
static String	keyFromPath(org.apache.hadoop.fs.Path path)
org.apache.hadoop.fs.RemoteIterator<org.apache.hadoop.fs.LocatedFileStatus>	listFiles(org.apache.hadoop.fs.Path path, boolean recursive)
org.apache.hadoop.fs.RemoteIterator<org.apache.hadoop.fs.LocatedFileStatus>	listLocatedStatus(org.apache.hadoop.fs.Path path)
org.apache.hadoop.fs.FileStatus[]	listStatus(org.apache.hadoop.fs.Path path)
boolean	mkdirs(org.apache.hadoop.fs.Path f, org.apache.hadoop.fs.permission.FsPermission permission)
org.apache.hadoop.fs.FSDataInputStream	open(org.apache.hadoop.fs.Path path, int bufferSize)
boolean	rename(org.apache.hadoop.fs.Path src, org.apache.hadoop.fs.Path dst)
void	setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)
void	setWorkingDirectory(org.apache.hadoop.fs.Path path)

Methods inherited from class org.apache.hadoop.fs.FileSystem

access, append, append, appendFile, areSymlinksEnabled, cancelDeleteOnExit, canonicalizeUri, checkPath, clearStatistics, closeAll, closeAllForUGI, completeLocalOutput, concat, copyFromLocalFile, copyFromLocalFile, copyFromLocalFile, copyFromLocalFile, copyToLocalFile, copyToLocalFile, copyToLocalFile, create, create, create, create, create, create, create, create, create, create, create, create, createDataInputStreamBuilder, createDataInputStreamBuilder, createDataOutputStreamBuilder, createFile, createMultipartUploader, createNewFile, createNonRecursive, createNonRecursive, createNonRecursive, createPathHandle, createSnapshot, createSnapshot, createSymlink, delete, deleteOnExit, deleteSnapshot, enableSymlinks, exists, fixRelativePart, get, get, get, getAclStatus, getAdditionalTokenIssuers, getAllStatistics, getAllStoragePolicies, getBlockSize, getCanonicalServiceName, getCanonicalUri, getChildFileSystems, getContentSummary, getDefaultBlockSize, getDefaultBlockSize, getDefaultPort, getDefaultReplication, getDefaultReplication, getDefaultUri, getDelegationToken, getFileBlockLocations, getFileBlockLocations, getFileChecksum, getFileChecksum, getFileLinkStatus, getFileSystemClass, getFSofPath, getGlobalStorageStatistics, getHomeDirectory, getInitialWorkingDirectory, getLength, getLinkTarget, getLocal, getName, getNamed, getPathHandle, getQuotaUsage, getReplication, getServerDefaults, getServerDefaults, getStatistics, getStatistics, getStatus, getStatus, getStoragePolicy, getStorageStatistics, getTrashRoot, getTrashRoots, getUsed, getUsed, getXAttr, getXAttrs, getXAttrs, globStatus, globStatus, hasPathCapability, isDirectory, isFile, listCorruptFileBlocks, listLocatedStatus, listStatus, listStatus, listStatus, listStatusBatch, listStatusIterator, listXAttrs, makeQualified, mkdirs, mkdirs, modifyAclEntries, moveFromLocalFile, moveFromLocalFile, moveToLocalFile, msync, newInstance, newInstance, newInstance, newInstanceLocal, open, open, open, openFile, openFile, openFileWithOptions, openFileWithOptions, primitiveCreate, primitiveMkdir, primitiveMkdir, printStatistics, processDeleteOnExit, removeAcl, removeAclEntries, removeDefaultAcl, removeXAttr, rename, renameSnapshot, resolveLink, resolvePath, satisfyStoragePolicy, setAcl, setDefaultUri, setDefaultUri, setOwner, setPermission, setQuota, setQuotaByStorageType, setReplication, setStoragePolicy, setTimes, setVerifyChecksum, setWriteChecksum, setXAttr, setXAttr, startLocalOutput, supportsSymlinks, truncate, unsetStoragePolicy

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.security.token.DelegationTokenIssuer

addDelegationTokens

Field Details

S3_USER_AGENT_PREFIX

public static final String S3_USER_AGENT_PREFIX

See Also:

• Constant Field Values

S3_CREDENTIALS_PROVIDER

public static final String S3_CREDENTIALS_PROVIDER

See Also:

• Constant Field Values

S3_SSE_TYPE

public static final String S3_SSE_TYPE

See Also:

• Constant Field Values

S3_SSE_ENABLED

public static final String S3_SSE_ENABLED

See Also:

• Constant Field Values

S3_SSE_KMS_KEY_ID

public static final String S3_SSE_KMS_KEY_ID

See Also:

• Constant Field Values

S3_KMS_KEY_ID

public static final String S3_KMS_KEY_ID

See Also:

• Constant Field Values

S3_ENCRYPTION_MATERIALS_PROVIDER

public static final String S3_ENCRYPTION_MATERIALS_PROVIDER

See Also:

• Constant Field Values

S3_PIN_CLIENT_TO_CURRENT_REGION

public static final String S3_PIN_CLIENT_TO_CURRENT_REGION

See Also:

• Constant Field Values

S3_MULTIPART_MIN_PART_SIZE

public static final String S3_MULTIPART_MIN_PART_SIZE

See Also:

• Constant Field Values

S3_MULTIPART_MIN_FILE_SIZE

public static final String S3_MULTIPART_MIN_FILE_SIZE

See Also:

• Constant Field Values

S3_STAGING_DIRECTORY

public static final String S3_STAGING_DIRECTORY

See Also:

• Constant Field Values

S3_MAX_CONNECTIONS

public static final String S3_MAX_CONNECTIONS

See Also:

• Constant Field Values

S3_SOCKET_TIMEOUT

public static final String S3_SOCKET_TIMEOUT

See Also:

• Constant Field Values

S3_CONNECT_TIMEOUT

public static final String S3_CONNECT_TIMEOUT

See Also:

• Constant Field Values

S3_CONNECT_TTL

public static final String S3_CONNECT_TTL

See Also:

• Constant Field Values

S3_MAX_RETRY_TIME

public static final String S3_MAX_RETRY_TIME

See Also:

• Constant Field Values

S3_MAX_BACKOFF_TIME

public static final String S3_MAX_BACKOFF_TIME

See Also:

• Constant Field Values

S3_MAX_CLIENT_RETRIES

public static final String S3_MAX_CLIENT_RETRIES

See Also:

• Constant Field Values

S3_MAX_ERROR_RETRIES

public static final String S3_MAX_ERROR_RETRIES

See Also:

• Constant Field Values

S3_SSL_ENABLED

public static final String S3_SSL_ENABLED

See Also:

• Constant Field Values

S3_PATH_STYLE_ACCESS

public static final String S3_PATH_STYLE_ACCESS

See Also:

• Constant Field Values

S3_SIGNER_TYPE

public static final String S3_SIGNER_TYPE

See Also:

• Constant Field Values

S3_SIGNER_CLASS

public static final String S3_SIGNER_CLASS

See Also:

• Constant Field Values

S3_ENDPOINT

public static final String S3_ENDPOINT

See Also:

• Constant Field Values

S3_REGION

public static final String S3_REGION

See Also:

• Constant Field Values

S3_SECRET_KEY

public static final String S3_SECRET_KEY

See Also:

• Constant Field Values

S3_ACCESS_KEY

public static final String S3_ACCESS_KEY

See Also:

• Constant Field Values

S3_SESSION_TOKEN

public static final String S3_SESSION_TOKEN

See Also:

• Constant Field Values

S3_IAM_ROLE

public static final String S3_IAM_ROLE

See Also:

• Constant Field Values

S3_EXTERNAL_ID

public static final String S3_EXTERNAL_ID

See Also:

• Constant Field Values

S3_ACL_TYPE

public static final String S3_ACL_TYPE

See Also:

• Constant Field Values

S3_SKIP_GLACIER_OBJECTS

public static final String S3_SKIP_GLACIER_OBJECTS

See Also:

• Constant Field Values

S3_REQUESTER_PAYS_ENABLED

public static final String S3_REQUESTER_PAYS_ENABLED

See Also:

• Constant Field Values

S3_STREAMING_UPLOAD_ENABLED

public static final String S3_STREAMING_UPLOAD_ENABLED

See Also:

• Constant Field Values

S3_STREAMING_UPLOAD_PART_SIZE

public static final String S3_STREAMING_UPLOAD_PART_SIZE

See Also:

• Constant Field Values

S3_STORAGE_CLASS

public static final String S3_STORAGE_CLASS

See Also:

• Constant Field Values

S3_ROLE_SESSION_NAME

public static final String S3_ROLE_SESSION_NAME

See Also:

• Constant Field Values

S3_PROXY_HOST

public static final String S3_PROXY_HOST

See Also:

• Constant Field Values

S3_PROXY_PORT

public static final String S3_PROXY_PORT

See Also:

• Constant Field Values

S3_PROXY_PROTOCOL

public static final String S3_PROXY_PROTOCOL

See Also:

• Constant Field Values

S3_NON_PROXY_HOSTS

public static final String S3_NON_PROXY_HOSTS

See Also:

• Constant Field Values

S3_PROXY_USERNAME

public static final String S3_PROXY_USERNAME

See Also:

• Constant Field Values

S3_PROXY_PASSWORD

public static final String S3_PROXY_PASSWORD

See Also:

• Constant Field Values

S3_PREEMPTIVE_BASIC_PROXY_AUTH

public static final String S3_PREEMPTIVE_BASIC_PROXY_AUTH

See Also:

• Constant Field Values

S3_STS_ENDPOINT

public static final String S3_STS_ENDPOINT

See Also:

• Constant Field Values

S3_STS_REGION

public static final String S3_STS_REGION

See Also:

• Constant Field Values

DELETE_BATCH_SIZE

public static final int DELETE_BATCH_SIZE

See Also:

• Constant Field Values

Constructor Details

TrinoS3FileSystem

public TrinoS3FileSystem()

Method Details

initialize

public void initialize(URI uri,
 org.apache.hadoop.conf.Configuration conf)
                throws IOException

Overrides:

initialize in class org.apache.hadoop.fs.FileSystem

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class org.apache.hadoop.fs.FileSystem

Throws:

IOException

setOpenTelemetry

public void setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)

Specified by:

setOpenTelemetry in interface OpenTelemetryAwareFileSystem

getScheme

public String getScheme()

Overrides:

getScheme in class org.apache.hadoop.fs.FileSystem

getUri

public URI getUri()

Specified by:

getUri in class org.apache.hadoop.fs.FileSystem

getWorkingDirectory

public org.apache.hadoop.fs.Path getWorkingDirectory()

Specified by:

getWorkingDirectory in class org.apache.hadoop.fs.FileSystem

setWorkingDirectory

public void setWorkingDirectory(org.apache.hadoop.fs.Path path)

Specified by:

setWorkingDirectory in class org.apache.hadoop.fs.FileSystem

listStatus

public org.apache.hadoop.fs.FileStatus[] listStatus(org.apache.hadoop.fs.Path path)
                                             throws IOException

Specified by:

listStatus in class org.apache.hadoop.fs.FileSystem

Throws:

IOException

listFiles

public org.apache.hadoop.fs.RemoteIterator<org.apache.hadoop.fs.LocatedFileStatus> listFiles(org.apache.hadoop.fs.Path path,
 boolean recursive)

Overrides:

listFiles in class org.apache.hadoop.fs.FileSystem

listLocatedStatus

public org.apache.hadoop.fs.RemoteIterator<org.apache.hadoop.fs.LocatedFileStatus> listLocatedStatus(org.apache.hadoop.fs.Path path)

Overrides:

listLocatedStatus in class org.apache.hadoop.fs.FileSystem

getFileStatus

public org.apache.hadoop.fs.FileStatus getFileStatus(org.apache.hadoop.fs.Path path)
                                              throws IOException

Specified by:

getFileStatus in class org.apache.hadoop.fs.FileSystem

Throws:

IOException

open

public org.apache.hadoop.fs.FSDataInputStream open(org.apache.hadoop.fs.Path path,
 int bufferSize)

Specified by:

open in class org.apache.hadoop.fs.FileSystem

create

public org.apache.hadoop.fs.FSDataOutputStream create(org.apache.hadoop.fs.Path path,
 org.apache.hadoop.fs.permission.FsPermission permission,
 boolean overwrite,
 int bufferSize,
 short replication,
 long blockSize,
 org.apache.hadoop.util.Progressable progress)
                                               throws IOException

Specified by:

create in class org.apache.hadoop.fs.FileSystem

Throws:

IOException

create

public org.apache.hadoop.fs.FSDataOutputStream create(org.apache.hadoop.fs.Path path,
 AggregatedMemoryContext aggregatedMemoryContext)
                                               throws IOException

Specified by:

create in interface MemoryAwareFileSystem

Throws:

IOException

append

public org.apache.hadoop.fs.FSDataOutputStream append(org.apache.hadoop.fs.Path f,
 int bufferSize,
 org.apache.hadoop.util.Progressable progress)

Specified by:

append in class org.apache.hadoop.fs.FileSystem

rename

public boolean rename(org.apache.hadoop.fs.Path src,
 org.apache.hadoop.fs.Path dst)
               throws IOException

Specified by:

rename in class org.apache.hadoop.fs.FileSystem

Throws:

IOException

delete

public boolean delete(org.apache.hadoop.fs.Path path,
 boolean recursive)
               throws IOException

Specified by:

delete in class org.apache.hadoop.fs.FileSystem

Throws:

IOException

deleteFiles

public void deleteFiles(Collection<org.apache.hadoop.fs.Path> paths)
                 throws IOException

Specified by:

deleteFiles in interface FileSystemWithBatchDelete

Throws:

IOException

mkdirs

public boolean mkdirs(org.apache.hadoop.fs.Path f,
 org.apache.hadoop.fs.permission.FsPermission permission)

Specified by:

mkdirs in class org.apache.hadoop.fs.FileSystem

keyFromPath

public static String keyFromPath(org.apache.hadoop.fs.Path path)

getS3Client

public com.amazonaws.services.s3.AmazonS3 getS3Client()

getBucketName

protected String getBucketName(URI uri)

extractBucketName

public static String extractBucketName(URI uri)

Helper function used to work around the fact that if you use an S3 bucket with an '_' that java.net.URI behaves differently and sets the host value to null whereas S3 buckets without '_' have a properly set host field. '_' is only allowed in S3 bucket names in us-east-1.

Parameters:

uri - The URI from which to extract a host value.

Returns:

The host value where uri.getAuthority() is used when uri.getHost() returns null as long as no UserInfo is present.

Throws:

IllegalArgumentException - If the bucket cannot be determined from the URI.

getFileSystemStats

public static TrinoS3FileSystemStats getFileSystemStats()