Filesystems#

Interface#

enum class arrow::fs::FileType : int8_t#

FileSystem entry type.

Values:

enumerator NotFound#: Entry is not found.

enumerator Unknown#

Entry exists but its type is unknown.

This can designate a special file such as a Unix socket or character device, or Windows NUL / CON / …

enumerator File#: Entry is a regular file.

enumerator Directory#: Entry is a directory.

struct FileInfo : public arrow::util::EqualityComparable<FileInfo>#

FileSystem entry info.

Public Functions

inline FileType type() const#: The file type.

inline const std::string &path() const#: The full file path in the filesystem.

std::string base_name() const#: The file base name (component after the last directory separator)

inline int64_t size() const#

The size in bytes, if available.

Only regular files are guaranteed to have a size.

std::string extension() const#: The file extension (excluding the dot)

inline TimePoint mtime() const#: The time of last modification, if available.

struct ByPath#: Function object implementing less-than comparison and hashing by path, to support sorting infos, using them as keys, and other interactions with the STL.

struct FileSelector#

File selector for filesystem APIs.

Public Members

std::string base_dir#

The directory in which to select files.

If the path exists but doesn’t point to a directory, this should be an error.

bool allow_not_found#

The behavior if base_dir isn’t found in the filesystem.

If false, an error is returned. If true, an empty selection is returned.

bool recursive#: Whether to recurse into subdirectories.

int32_t max_recursion#: The maximum number of subdirectories to recurse into.

class FileSystem#

Abstract file system API.

Subclassed by arrow::fs::AzureFileSystem, arrow::fs::GcsFileSystem, arrow::fs::HadoopFileSystem, arrow::fs::LocalFileSystem, arrow::fs::S3FileSystem, arrow::fs::SlowFileSystem, arrow::fs::SubTreeFileSystem, arrow::fs::internal::MockFileSystem

Public Functions

inline const io::IOContext &io_context() const#: EXPERIMENTAL: The IOContext associated with this filesystem.

virtual Result<std::string> NormalizePath(std::string path)#

Normalize path for the given filesystem.

The default implementation of this method is a no-op, but subclasses may allow normalizing irregular path forms (such as Windows local paths).

virtual Result<std::string> PathFromUri(const std::string &uri_string) const#

Ensure a URI (or path) is compatible with the given filesystem and return the path.

This method will check to ensure the given filesystem is compatible with the URI. This can be useful when the user provides both a URI and a filesystem or when a user provides multiple URIs that should be compatible with the same filesystem.

uri_string can be an absolute path instead of a URI. In that case it will ensure the filesystem (if supplied) is the local filesystem (or some custom filesystem that is capable of reading local paths) and will normalize the path’s file separators.

Note, this method only checks to ensure the URI scheme is valid. It will not detect inconsistencies like a mismatching region or endpoint override.

Parameters:: uri_string – A URI representing a resource in the given filesystem.
Returns:: The path inside the filesystem that is indicated by the URI.

virtual Result<std::string> MakeUri(std::string path) const#

Make a URI from which FileSystemFromUri produces an equivalent filesystem.

Parameters:: path – The path component to use in the resulting URI
Returns:: A URI string, or an error if an equivalent URI cannot be produced

virtual Result<FileInfo> GetFileInfo(const std::string &path) = 0#

Get info for the given target.

Any symlink is automatically dereferenced, recursively. A nonexistent or unreachable file returns an Ok status and has a FileType of value NotFound. An error status indicates a truly exceptional condition (low-level I/O error, etc.).

virtual Result<FileInfoVector> GetFileInfo(const std::vector<std::string> &paths)#: Same, for many targets at once.

virtual Result<FileInfoVector> GetFileInfo(const FileSelector &select) = 0#

Same, according to a selector.

The selector’s base directory will not be part of the results, even if it exists. If it doesn’t exist, see FileSelector::allow_not_found.

virtual Future<FileInfoVector> GetFileInfoAsync(const std::vector<std::string> &paths)#: Async version of GetFileInfo.

virtual FileInfoGenerator GetFileInfoGenerator(const FileSelector &select)#

Streaming async version of GetFileInfo.

The returned generator is not async-reentrant, i.e. you need to wait for the returned future to complete before calling the generator again.

virtual Status CreateDir(const std::string &path, bool recursive) = 0#

Create a directory and subdirectories.

This function succeeds if the directory already exists.

virtual Status DeleteDir(const std::string &path) = 0#: Delete a directory and its contents, recursively.

virtual Status DeleteDirContents(const std::string &path, bool missing_dir_ok) = 0#

Delete a directory’s contents, recursively.

Like DeleteDir, but doesn’t delete the directory itself. Passing an empty path (”” or “/”) is disallowed, see DeleteRootDirContents.

virtual Future DeleteDirContentsAsync(const std::string &path, bool missing_dir_ok)#: Async version of DeleteDirContents.

Future DeleteDirContentsAsync(const std::string &path)#

Async version of DeleteDirContents.

This overload allows missing directories.

virtual Status DeleteRootDirContents() = 0#

EXPERIMENTAL: Delete the root directory’s contents, recursively.

Implementations may decide to raise an error if this operation is too dangerous.

virtual Status DeleteFile(const std::string &path) = 0#: Delete a file.

virtual Status DeleteFiles(const std::vector<std::string> &paths)#

Delete many files.

The default implementation issues individual delete operations in sequence.

virtual Status Move(const std::string &src, const std::string &dest) = 0#

Move / rename a file or directory.

If the destination exists:

if it is a non-empty directory, an error is returned
otherwise, if it has the same type as the source, it is replaced
otherwise, behavior is unspecified (implementation-dependent).

virtual Status CopyFile(const std::string &src, const std::string &dest) = 0#

Copy a file.

If the destination exists and is a directory, an error is returned. Otherwise, it is replaced.

virtual Result<std::shared_ptr<io::InputStream>> OpenInputStream(const std::string &path) = 0#: Open an input stream for sequential reading.

virtual Result<std::shared_ptr<io::InputStream>> OpenInputStream(const FileInfo &info)#

Open an input stream for sequential reading.

This override assumes the given FileInfo validly represents the file’s characteristics, and may optimize access depending on them (for example avoid querying the file size or its existence).

virtual Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(const std::string &path) = 0#: Open an input file for random access reading.

virtual Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(const FileInfo &info)#

Open an input file for random access reading.

This override assumes the given FileInfo validly represents the file’s characteristics, and may optimize access depending on them (for example avoid querying the file size or its existence).

virtual Future<std::shared_ptr<io::InputStream>> OpenInputStreamAsync(const std::string &path)#: Async version of OpenInputStream.

virtual Future<std::shared_ptr<io::InputStream>> OpenInputStreamAsync(const FileInfo &info)#: Async version of OpenInputStream.

virtual Future<std::shared_ptr<io::RandomAccessFile>> OpenInputFileAsync(const std::string &path)#: Async version of OpenInputFile.

virtual Future<std::shared_ptr<io::RandomAccessFile>> OpenInputFileAsync(const FileInfo &info)#: Async version of OpenInputFile.

virtual Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) = 0#

Open an output stream for sequential writing.

If the target already exists, existing data is truncated.

virtual Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) = 0#

Open an output stream for appending.

If the target doesn’t exist, a new empty file is created.

Note: some filesystem implementations do not support efficient appending to an existing file, in which case this method will return NotImplemented. Consider writing to multiple files (using e.g. the dataset layer) instead.

void arrow::fs::EnsureFinalized()#

Ensure all registered filesystem implementations are finalized.

Individual finalizers may wait for concurrent calls to finish so as to avoid race conditions. After this function has been called, all filesystem APIs will fail with an error.

The user is responsible for synchronization of calls to this function.

High-level factory functions#

Result<std::shared_ptr<FileSystem>> FileSystemFromUri(const std::string &uri, std::string *out_path = NULLPTR)#

Create a new FileSystem by URI.

Recognized schemes are “file”, “mock”, “hdfs”, “viewfs”, “s3”, “gs” and “gcs”.

Support for other schemes can be added using RegisterFileSystemFactory.

Parameters:

uri – [in] a URI-based path, ex: file:///some/local/path
out_path – [out] (optional) Path inside the filesystem.

Returns:

out_fs FileSystem instance.

Result<std::shared_ptr<FileSystem>> FileSystemFromUri(const std::string &uri, const io::IOContext &io_context, std::string *out_path = NULLPTR)#

Create a new FileSystem by URI with a custom IO context.

Recognized schemes are “file”, “mock”, “hdfs”, “viewfs”, “s3”, “gs” and “gcs”.

Support for other schemes can be added using RegisterFileSystemFactory.

Parameters:

uri – [in] a URI-based path, ex: file:///some/local/path
io_context – [in] an IOContext which will be associated with the filesystem
out_path – [out] (optional) Path inside the filesystem.

Returns:

out_fs FileSystem instance.

Result<std::shared_ptr<FileSystem>> FileSystemFromUriOrPath(const std::string &uri, std::string *out_path = NULLPTR)#

Create a new FileSystem by URI.

Support for other schemes can be added using RegisterFileSystemFactory.

Same as FileSystemFromUri, but in addition also recognize non-URIs and treat them as local filesystem paths. Only absolute local filesystem paths are allowed.

Result<std::shared_ptr<FileSystem>> FileSystemFromUriOrPath(const std::string &uri, const io::IOContext &io_context, std::string *out_path = NULLPTR)#

Create a new FileSystem by URI with a custom IO context.

Support for other schemes can be added using RegisterFileSystemFactory.

Same as FileSystemFromUri, but in addition also recognize non-URIs and treat them as local filesystem paths. Only absolute local filesystem paths are allowed.

Factory registration functions#

Status RegisterFileSystemFactory(std::string scheme, FileSystemFactory factory, std::function<void()> finalizer = {})#

Register a FileSystem factory.

Support for custom URI schemes can be added by registering a factory for the corresponding FileSystem.

Parameters:

scheme – [in] a Uri scheme which the factory will handle. If a factory has already been registered for a scheme, the new factory will be ignored.
factory – [in] a function which can produce a FileSystem for Uris which match scheme.
finalizer – [in] a function which must be called to finalize the factory before the process exits, or nullptr if no finalization is necessary.

Returns:

raises KeyError if a name collision occurs.

Status LoadFileSystemFactories(const char *libpath)#

Register FileSystem factories from a shared library.

FileSystem implementations may be housed in separate shared libraries and only registered when the shared library is explicitly loaded. FileSystemRegistrar is provided to simplify definition of such libraries: each instance at namespace scope in the library will register a factory for a scheme. Any library which uses FileSystemRegistrars and which must be dynamically loaded should be loaded using LoadFileSystemFactories(), which will additionally merge registries are if necessary (static linkage to arrow can produce isolated registries).

ARROW_REGISTER_FILESYSTEM(scheme, factory_function, finalizer)#

struct FileSystemRegistrar#: #include <arrow/filesystem/filesystem.h>

Concrete implementations#

“Subtree” filesystem wrapper#

class SubTreeFileSystem : public arrow::fs::FileSystem #

A FileSystem implementation that delegates to another implementation after prepending a fixed base path.

This is useful to expose a logical view of a subtree of a filesystem, for example a directory in a LocalFileSystem. This works on abstract paths, i.e. paths using forward slashes and and a single root “/”. Windows paths are not guaranteed to work. This makes no security guarantee. For example, symlinks may allow to “escape” the subtree and access other parts of the underlying filesystem.

Public Functions

virtual Result<std::string> NormalizePath(std::string path) override#

Normalize path for the given filesystem.

The default implementation of this method is a no-op, but subclasses may allow normalizing irregular path forms (such as Windows local paths).

virtual Result<std::string> PathFromUri(const std::string &uri_string) const override#

Ensure a URI (or path) is compatible with the given filesystem and return the path.

This method will check to ensure the given filesystem is compatible with the URI. This can be useful when the user provides both a URI and a filesystem or when a user provides multiple URIs that should be compatible with the same filesystem.

uri_string can be an absolute path instead of a URI. In that case it will ensure the filesystem (if supplied) is the local filesystem (or some custom filesystem that is capable of reading local paths) and will normalize the path’s file separators.

Note, this method only checks to ensure the URI scheme is valid. It will not detect inconsistencies like a mismatching region or endpoint override.

Parameters:: uri_string – A URI representing a resource in the given filesystem.
Returns:: The path inside the filesystem that is indicated by the URI.

virtual Result<FileInfo> GetFileInfo(const std::string &path) override#

Get info for the given target.

Any symlink is automatically dereferenced, recursively. A nonexistent or unreachable file returns an Ok status and has a FileType of value NotFound. An error status indicates a truly exceptional condition (low-level I/O error, etc.).

virtual Result<FileInfoVector> GetFileInfo(const FileSelector &select) override#

Same, according to a selector.

The selector’s base directory will not be part of the results, even if it exists. If it doesn’t exist, see FileSelector::allow_not_found.

virtual FileInfoGenerator GetFileInfoGenerator(const FileSelector &select) override#

Streaming async version of GetFileInfo.

The returned generator is not async-reentrant, i.e. you need to wait for the returned future to complete before calling the generator again.

virtual Status CreateDir(const std::string &path, bool recursive) override#

Create a directory and subdirectories.

This function succeeds if the directory already exists.

virtual Status DeleteDir(const std::string &path) override#: Delete a directory and its contents, recursively.

virtual Status DeleteDirContents(const std::string &path, bool missing_dir_ok) override#

Delete a directory’s contents, recursively.

Like DeleteDir, but doesn’t delete the directory itself. Passing an empty path (”” or “/”) is disallowed, see DeleteRootDirContents.

virtual Status DeleteRootDirContents() override#

EXPERIMENTAL: Delete the root directory’s contents, recursively.

Implementations may decide to raise an error if this operation is too dangerous.

virtual Status DeleteFile(const std::string &path) override#: Delete a file.

virtual Status Move(const std::string &src, const std::string &dest) override#

Move / rename a file or directory.

If the destination exists:

if it is a non-empty directory, an error is returned
otherwise, if it has the same type as the source, it is replaced
otherwise, behavior is unspecified (implementation-dependent).

virtual Status CopyFile(const std::string &src, const std::string &dest) override#

Copy a file.

If the destination exists and is a directory, an error is returned. Otherwise, it is replaced.

virtual Result<std::shared_ptr<io::InputStream>> OpenInputStream(const std::string &path) override#: Open an input stream for sequential reading.

virtual Result<std::shared_ptr<io::InputStream>> OpenInputStream(const FileInfo &info) override#

Open an input stream for sequential reading.

This override assumes the given FileInfo validly represents the file’s characteristics, and may optimize access depending on them (for example avoid querying the file size or its existence).

virtual Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(const std::string &path) override#: Open an input file for random access reading.

virtual Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(const FileInfo &info) override#

Open an input file for random access reading.

This override assumes the given FileInfo validly represents the file’s characteristics, and may optimize access depending on them (for example avoid querying the file size or its existence).

virtual Future<std::shared_ptr<io::InputStream>> OpenInputStreamAsync(const std::string &path) override#: Async version of OpenInputStream.

virtual Future<std::shared_ptr<io::InputStream>> OpenInputStreamAsync(const FileInfo &info) override#: Async version of OpenInputStream.

virtual Future<std::shared_ptr<io::RandomAccessFile>> OpenInputFileAsync(const std::string &path) override#: Async version of OpenInputFile.

virtual Future<std::shared_ptr<io::RandomAccessFile>> OpenInputFileAsync(const FileInfo &info) override#: Async version of OpenInputFile.

virtual Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) override#

Open an output stream for sequential writing.

If the target already exists, existing data is truncated.

virtual Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) override#

Open an output stream for appending.

If the target doesn’t exist, a new empty file is created.

Note: some filesystem implementations do not support efficient appending to an existing file, in which case this method will return NotImplemented. Consider writing to multiple files (using e.g. the dataset layer) instead.

Local filesystem#

struct LocalFileSystemOptions#

Options for the LocalFileSystem implementation.

Public Members

bool use_mmap = false#: Whether OpenInputStream and OpenInputFile return a mmap’ed file, or a regular one.

int32_t directory_readahead = kDefaultDirectoryReadahead#

Options related to GetFileInfoGenerator interface.

EXPERIMENTAL: The maximum number of directories processed in parallel by GetFileInfoGenerator.

int32_t file_info_batch_size = kDefaultFileInfoBatchSize#

EXPERIMENTAL: The maximum number of entries aggregated into each FileInfoVector chunk by GetFileInfoGenerator.

Since each FileInfo entry needs a separate stat system call, a directory with a very large number of files may take a lot of time to process entirely. By generating a FileInfoVector after this chunk size is reached, we ensure FileInfo entries can start being consumed from the FileInfoGenerator with less initial latency.

Public Static Functions

static LocalFileSystemOptions Defaults()#: Initialize with defaults.

class LocalFileSystem : public arrow::fs::FileSystem #

A FileSystem implementation accessing files on the local machine.

This class handles only /-separated paths. If desired, conversion from Windows backslash-separated paths should be done by the caller. Details such as symlinks are abstracted away (symlinks are always followed, except when deleting an entry).

Public Functions

virtual Result<std::string> NormalizePath(std::string path) override#

Normalize path for the given filesystem.

The default implementation of this method is a no-op, but subclasses may allow normalizing irregular path forms (such as Windows local paths).

virtual Result<std::string> PathFromUri(const std::string &uri_string) const override#

Ensure a URI (or path) is compatible with the given filesystem and return the path.

This method will check to ensure the given filesystem is compatible with the URI. This can be useful when the user provides both a URI and a filesystem or when a user provides multiple URIs that should be compatible with the same filesystem.

uri_string can be an absolute path instead of a URI. In that case it will ensure the filesystem (if supplied) is the local filesystem (or some custom filesystem that is capable of reading local paths) and will normalize the path’s file separators.

Note, this method only checks to ensure the URI scheme is valid. It will not detect inconsistencies like a mismatching region or endpoint override.

Parameters:: uri_string – A URI representing a resource in the given filesystem.
Returns:: The path inside the filesystem that is indicated by the URI.

virtual Result<std::string> MakeUri(std::string path) const override#

Make a URI from which FileSystemFromUri produces an equivalent filesystem.

Parameters:: path – The path component to use in the resulting URI
Returns:: A URI string, or an error if an equivalent URI cannot be produced

virtual Result<FileInfo> GetFileInfo(const std::string &path) override#

Get info for the given target.

Any symlink is automatically dereferenced, recursively. A nonexistent or unreachable file returns an Ok status and has a FileType of value NotFound. An error status indicates a truly exceptional condition (low-level I/O error, etc.).

virtual Result<std::vector<FileInfo>> GetFileInfo(const FileSelector &select) override#

Same, according to a selector.

The selector’s base directory will not be part of the results, even if it exists. If it doesn’t exist, see FileSelector::allow_not_found.

virtual FileInfoGenerator GetFileInfoGenerator(const FileSelector &select) override#

Streaming async version of GetFileInfo.

The returned generator is not async-reentrant, i.e. you need to wait for the returned future to complete before calling the generator again.

virtual Status CreateDir(const std::string &path, bool recursive) override#

Create a directory and subdirectories.

This function succeeds if the directory already exists.

virtual Status DeleteDir(const std::string &path) override#: Delete a directory and its contents, recursively.

virtual Status DeleteDirContents(const std::string &path, bool missing_dir_ok) override#

Delete a directory’s contents, recursively.

Like DeleteDir, but doesn’t delete the directory itself. Passing an empty path (”” or “/”) is disallowed, see DeleteRootDirContents.

virtual Status DeleteRootDirContents() override#

EXPERIMENTAL: Delete the root directory’s contents, recursively.

Implementations may decide to raise an error if this operation is too dangerous.

virtual Status DeleteFile(const std::string &path) override#: Delete a file.

virtual Status Move(const std::string &src, const std::string &dest) override#

Move / rename a file or directory.

If the destination exists:

if it is a non-empty directory, an error is returned
otherwise, if it has the same type as the source, it is replaced
otherwise, behavior is unspecified (implementation-dependent).

virtual Status CopyFile(const std::string &src, const std::string &dest) override#

Copy a file.

If the destination exists and is a directory, an error is returned. Otherwise, it is replaced.

virtual Result<std::shared_ptr<io::InputStream>> OpenInputStream(const std::string &path) override#: Open an input stream for sequential reading.

virtual Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(const std::string &path) override#: Open an input file for random access reading.

virtual Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) override#

Open an output stream for sequential writing.

If the target already exists, existing data is truncated.

virtual Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) override#

Open an output stream for appending.

If the target doesn’t exist, a new empty file is created.

Note: some filesystem implementations do not support efficient appending to an existing file, in which case this method will return NotImplemented. Consider writing to multiple files (using e.g. the dataset layer) instead.

S3 filesystem#

struct S3Options#

Options for the S3FileSystem implementation.

Public Functions

void ConfigureDefaultCredentials()#: Configure with the default AWS credentials provider chain.

void ConfigureAnonymousCredentials()#: Configure with anonymous credentials. This will only let you access public buckets.

void ConfigureAccessKey(const std::string &access_key, const std::string &secret_key, const std::string &session_token = "")#: Configure with explicit access and secret key.

void ConfigureAssumeRoleCredentials(const std::string &role_arn, const std::string &session_name = "", const std::string &external_id = "", int load_frequency = 900, const std::shared_ptr<Aws::STS::STSClient> &stsClient = NULLPTR)#: Configure with credentials from an assumed role.

void ConfigureAssumeRoleWithWebIdentityCredentials()#: Configure with credentials from role assumed using a web identity token.

Public Members

std::string region#

AWS region to connect to.

If unset, the AWS SDK will choose a default value. The exact algorithm depends on the SDK version. Before 1.8, the default is hardcoded to “us-east-1”. Since 1.8, several heuristics are used to determine the region (environment variables, configuration profile, EC2 metadata server).

double connect_timeout = -1#

Socket connection timeout, in seconds.

If negative, the AWS SDK default value is used (typically 1 second).

double request_timeout = -1#

Socket read timeout on Windows and macOS, in seconds.

If negative, the AWS SDK default value is used (typically 3 seconds). This option is ignored on non-Windows, non-macOS systems.

std::string endpoint_override#: If non-empty, override region with a connect string such as “localhost:9000”.

std::string scheme = "https"#: S3 connection transport, default “https”.

std::string role_arn#: ARN of role to assume.

std::string session_name#: Optional identifier for an assumed role session.

std::string external_id#: Optional external identifier to pass to STS when assuming a role.

int load_frequency = 900#: Frequency (in seconds) to refresh temporary credentials from assumed role.

S3ProxyOptions proxy_options#: If connection is through a proxy, set options here.

std::shared_ptr<Aws::Auth::AWSCredentialsProvider> credentials_provider#: AWS credentials provider.

S3CredentialsKind credentials_kind = S3CredentialsKind::Default#: Type of credentials being used. Set along with credentials_provider.

bool force_virtual_addressing = false#

Whether to use virtual addressing of buckets.

If true, then virtual addressing is always enabled. If false, then virtual addressing is only enabled if endpoint_override is empty.

This can be used for non-AWS backends that only support virtual hosted-style access.

bool background_writes = true#: Whether OutputStream writes will be issued in the background, without blocking.

bool allow_bucket_creation = false#

Whether to allow creation of buckets.

When S3FileSystem creates new buckets, it does not pass any non-default settings. In AWS S3, the bucket and all objects will be not publicly visible, and there will be no bucket policies and no resource tags. To have more control over how buckets are created, use a different API to create them.

bool allow_bucket_deletion = false#: Whether to allow deletion of buckets.

bool check_directory_existence_before_creation = false#

Whether to allow pessimistic directory creation in CreateDir function.

By default, CreateDir function will try to create the directory without checking its existence. It’s an optimization to try directory creation and catch the error, rather than issue two dependent I/O calls. Though for key/value storage like Google Cloud Storage, too many creation calls will breach the rate limit for object mutation operations and cause serious consequences. It’s also possible you don’t have creation access for the parent directory. Set it to be true to address these scenarios.

bool allow_delayed_open = false#

Whether to allow file-open methods to return before the actual open.

Enabling this may reduce the latency of OpenInputStream, OpenOutputStream, and similar methods, by reducing the number of roundtrips necessary. It may also allow usage of more efficient S3 APIs for small files. The downside is that failure conditions such as attempting to open a file in a non-existing bucket will only be reported when actual I/O is done (at worse, when attempting to close the file).

std::shared_ptr<const KeyValueMetadata> default_metadata#

Default metadata for OpenOutputStream.

This will be ignored if non-empty metadata is passed to OpenOutputStream.

std::shared_ptr<S3RetryStrategy> retry_strategy#: Optional retry strategy to determine which error types should be retried, and the delay between retries.

std::string sse_customer_key#

Optional customer-provided key for server-side encryption (SSE-C).

This should be the 32-byte AES-256 key, unencoded.

std::string tls_ca_file_path#

Optional path to a single PEM file holding all TLS CA certificates.

If empty, global filesystem options will be used (see FileSystemGlobalOptions); if the corresponding global filesystem option is also empty, the underlying TLS library’s defaults will be used.

Note this option may be ignored on some systems (Windows, macOS).

std::string tls_ca_dir_path#

Optional path to a directory holding TLS CA.

The given directory should contain CA certificates as individual PEM files named along the OpenSSL “hashed” format.

If empty, global filesystem options will be used (see FileSystemGlobalOptions); if the corresponding global filesystem option is also empty, the underlying TLS library’s defaults will be used.

Note this option may be ignored on some systems (Windows, macOS).

bool tls_verify_certificates = true#

Whether to verify the S3 endpoint’s TLS certificate.

This option applies if the scheme is “https”.

Public Static Functions

static S3Options Defaults()#

Initialize with default credentials provider chain.

This is recommended if you use the standard AWS environment variables and/or configuration file.

static S3Options Anonymous()#

Initialize with anonymous credentials.

This will only let you access public buckets.

static S3Options FromAccessKey(const std::string &access_key, const std::string &secret_key, const std::string &session_token = "")#

Initialize with explicit access and secret key.

Optionally, a session token may also be provided for temporary credentials (from STS).

static S3Options FromAssumeRole(const std::string &role_arn, const std::string &session_name = "", const std::string &external_id = "", int load_frequency = 900, const std::shared_ptr<Aws::STS::STSClient> &stsClient = NULLPTR)#: Initialize from an assumed role.

static S3Options FromAssumeRoleWithWebIdentity()#

Initialize from an assumed role with web-identity.

Uses the AWS SDK which uses environment variables to generate temporary credentials.

class S3FileSystem : public arrow::fs::FileSystem #

S3-backed FileSystem implementation.

Some implementation notes:

buckets are special and the operations available on them may be limited or more expensive than desired.

Public Functions

S3Options options() const#: Return the original S3 options when constructing the filesystem.

std::string region() const#: Return the actual region this filesystem connects to.

virtual Result<std::string> PathFromUri(const std::string &uri_string) const override#

Ensure a URI (or path) is compatible with the given filesystem and return the path.

This method will check to ensure the given filesystem is compatible with the URI. This can be useful when the user provides both a URI and a filesystem or when a user provides multiple URIs that should be compatible with the same filesystem.

uri_string can be an absolute path instead of a URI. In that case it will ensure the filesystem (if supplied) is the local filesystem (or some custom filesystem that is capable of reading local paths) and will normalize the path’s file separators.

Note, this method only checks to ensure the URI scheme is valid. It will not detect inconsistencies like a mismatching region or endpoint override.

Parameters:: uri_string – A URI representing a resource in the given filesystem.
Returns:: The path inside the filesystem that is indicated by the URI.

virtual Result<FileInfo> GetFileInfo(const std::string &path) override#

Get info for the given target.

Any symlink is automatically dereferenced, recursively. A nonexistent or unreachable file returns an Ok status and has a FileType of value NotFound. An error status indicates a truly exceptional condition (low-level I/O error, etc.).

virtual Result<std::vector<FileInfo>> GetFileInfo(const FileSelector &select) override#

Same, according to a selector.

The selector’s base directory will not be part of the results, even if it exists. If it doesn’t exist, see FileSelector::allow_not_found.

virtual FileInfoGenerator GetFileInfoGenerator(const FileSelector &select) override#

Streaming async version of GetFileInfo.

The returned generator is not async-reentrant, i.e. you need to wait for the returned future to complete before calling the generator again.

virtual Status CreateDir(const std::string &path, bool recursive) override#

Create a directory and subdirectories.

This function succeeds if the directory already exists.

virtual Status DeleteDir(const std::string &path) override#: Delete a directory and its contents, recursively.

virtual Status DeleteDirContents(const std::string &path, bool missing_dir_ok) override#

Delete a directory’s contents, recursively.

Like DeleteDir, but doesn’t delete the directory itself. Passing an empty path (”” or “/”) is disallowed, see DeleteRootDirContents.

virtual Future DeleteDirContentsAsync(const std::string &path, bool missing_dir_ok) override#: Async version of DeleteDirContents.

virtual Status DeleteRootDirContents() override#

EXPERIMENTAL: Delete the root directory’s contents, recursively.

Implementations may decide to raise an error if this operation is too dangerous.

virtual Status DeleteFile(const std::string &path) override#: Delete a file.

virtual Status Move(const std::string &src, const std::string &dest) override#

Move / rename a file or directory.

If the destination exists:

if it is a non-empty directory, an error is returned
otherwise, if it has the same type as the source, it is replaced
otherwise, behavior is unspecified (implementation-dependent).

virtual Status CopyFile(const std::string &src, const std::string &dest) override#

Copy a file.

If the destination exists and is a directory, an error is returned. Otherwise, it is replaced.

virtual Result<std::shared_ptr<io::InputStream>> OpenInputStream(const std::string &path) override#

Create a sequential input stream for reading from a S3 object.

NOTE: Reads from the stream will be synchronous and unbuffered. You way want to wrap the stream in a BufferedInputStream or use a custom readahead strategy to avoid idle waits.

virtual Result<std::shared_ptr<io::InputStream>> OpenInputStream(const FileInfo &info) override#

Create a sequential input stream for reading from a S3 object.

This override avoids a HEAD request by assuming the FileInfo contains correct information.

virtual Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(const std::string &path) override#

Create a random access file for reading from a S3 object.

See OpenInputStream for performance notes.

virtual Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(const FileInfo &info) override#

Create a random access file for reading from a S3 object.

This override avoids a HEAD request by assuming the FileInfo contains correct information.

virtual Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) override#

Create a sequential output stream for writing to a S3 object.

NOTE: Writes to the stream will be buffered. Depending on S3Options.background_writes, they can be synchronous or not. It is recommended to enable background_writes unless you prefer implementing your own background execution strategy.

virtual Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) override#

Open an output stream for appending.

If the target doesn’t exist, a new empty file is created.

Note: some filesystem implementations do not support efficient appending to an existing file, in which case this method will return NotImplemented. Consider writing to multiple files (using e.g. the dataset layer) instead.

Public Static Functions

static Result<std::shared_ptr<S3FileSystem>> Make(const S3Options &options, const io::IOContext& = io::default_io_context())#: Create a S3FileSystem instance from the given options.

Status arrow::fs::InitializeS3(const S3GlobalOptions &options)#

Initialize the S3 APIs with the specified set of options.

It is required to call this function at least once before using S3FileSystem.

Once this function is called you MUST call FinalizeS3 before the end of the application in order to avoid a segmentation fault at shutdown.

Hadoop filesystem#

struct HdfsOptions#

Options for the HDFS implementation.

Public Members

io::HdfsConnectionConfig connection_config#: Hdfs configuration options, contains host, port, driver.

int32_t buffer_size = 0#: Used by Hdfs OpenWritable Interface.

class HadoopFileSystem : public arrow::fs::FileSystem #

HDFS-backed FileSystem implementation.

implementation notes:

This is a wrapper of arrow/io/hdfs, so we can use FileSystem API to handle hdfs.

Public Functions

virtual Result<std::string> PathFromUri(const std::string &uri_string) const override#

Ensure a URI (or path) is compatible with the given filesystem and return the path.

This method will check to ensure the given filesystem is compatible with the URI. This can be useful when the user provides both a URI and a filesystem or when a user provides multiple URIs that should be compatible with the same filesystem.

uri_string can be an absolute path instead of a URI. In that case it will ensure the filesystem (if supplied) is the local filesystem (or some custom filesystem that is capable of reading local paths) and will normalize the path’s file separators.

Note, this method only checks to ensure the URI scheme is valid. It will not detect inconsistencies like a mismatching region or endpoint override.

Parameters:: uri_string – A URI representing a resource in the given filesystem.
Returns:: The path inside the filesystem that is indicated by the URI.

virtual Result<FileInfo> GetFileInfo(const std::string &path) override#

Get info for the given target.

Any symlink is automatically dereferenced, recursively. A nonexistent or unreachable file returns an Ok status and has a FileType of value NotFound. An error status indicates a truly exceptional condition (low-level I/O error, etc.).

virtual Result<std::vector<FileInfo>> GetFileInfo(const FileSelector &select) override#

Same, according to a selector.

The selector’s base directory will not be part of the results, even if it exists. If it doesn’t exist, see FileSelector::allow_not_found.

virtual Status CreateDir(const std::string &path, bool recursive) override#

Create a directory and subdirectories.

This function succeeds if the directory already exists.

virtual Status DeleteDir(const std::string &path) override#: Delete a directory and its contents, recursively.

virtual Status DeleteDirContents(const std::string &path, bool missing_dir_ok) override#

Delete a directory’s contents, recursively.

Like DeleteDir, but doesn’t delete the directory itself. Passing an empty path (”” or “/”) is disallowed, see DeleteRootDirContents.

virtual Status DeleteRootDirContents() override#

EXPERIMENTAL: Delete the root directory’s contents, recursively.

Implementations may decide to raise an error if this operation is too dangerous.

virtual Status DeleteFile(const std::string &path) override#: Delete a file.

virtual Status Move(const std::string &src, const std::string &dest) override#

Move / rename a file or directory.

If the destination exists:

if it is a non-empty directory, an error is returned
otherwise, if it has the same type as the source, it is replaced
otherwise, behavior is unspecified (implementation-dependent).

virtual Status CopyFile(const std::string &src, const std::string &dest) override#

Copy a file.

If the destination exists and is a directory, an error is returned. Otherwise, it is replaced.

virtual Result<std::shared_ptr<io::InputStream>> OpenInputStream(const std::string &path) override#: Open an input stream for sequential reading.

virtual Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(const std::string &path) override#: Open an input file for random access reading.

virtual Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) override#

Open an output stream for sequential writing.

If the target already exists, existing data is truncated.

virtual Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) override#

Open an output stream for appending.

If the target doesn’t exist, a new empty file is created.

Note: some filesystem implementations do not support efficient appending to an existing file, in which case this method will return NotImplemented. Consider writing to multiple files (using e.g. the dataset layer) instead.

Public Static Functions

static Result<std::shared_ptr<HadoopFileSystem>> Make(const HdfsOptions &options, const io::IOContext& = io::default_io_context())#: Create a HdfsFileSystem instance from the given options.

Google Cloud Storage filesystem#

struct GcsOptions#

Options for the GcsFileSystem implementation.

Public Functions

GcsOptions()#: Equivalent to GcsOptions::Defaults().

Public Members

std::string default_bucket_location#: Location to use for creating buckets.

std::optional<double> retry_limit_seconds#

If set used to control total time allowed for retrying underlying errors.

The default policy is to retry for up to 15 minutes.

std::shared_ptr<const KeyValueMetadata> default_metadata#

Default metadata for OpenOutputStream.

This will be ignored if non-empty metadata is passed to OpenOutputStream.

std::optional<std::string> project_id#

The project to use for creating buckets.

If not set, the library uses the GOOGLE_CLOUD_PROJECT environment variable. Most I/O operations do not need a project id, only applications that create new buckets need a project id.

Public Static Functions

static GcsOptions Defaults()#

Initialize with Google Default Credentials.

Create options configured to use Application Default Credentials. The details of this mechanism are too involved to describe here, but suffice is to say that applications can override any defaults using an environment variable (GOOGLE_APPLICATION_CREDENTIALS), and that the defaults work with most Google Cloud Platform deployment environments (GCE, GKE, Cloud Run, etc.), and that have the same behavior as the gcloud CLI tool on your workstation.

Azure filesystem#

struct AzureOptions#

Options for the AzureFileSystem implementation.

By default, authentication is handled by the Azure SDK’s credential chain which may read from multiple environment variables, such as:

AZURE_TENANT_ID
AZURE_CLIENT_ID
AZURE_CLIENT_SECRET
AZURE_AUTHORITY_HOST
AZURE_CLIENT_CERTIFICATE_PATH
AZURE_FEDERATED_TOKEN_FILE

Functions are provided for explicit configuration of credentials if that is preferred.

Public Members

std::string account_name#

The name of the Azure Storage Account being accessed.

All service URLs will be constructed using this storage account name. ConfigureAccountKeyCredential assumes the user wants to authenticate this account.

std::string blob_storage_authority = ".blob.core.windows.net"#

hostname[:port] of the Azure Blob Storage Service.

If the hostname is a relative domain name (one that starts with a ‘.’), then storage account URLs will be constructed by prepending the account name to the hostname. If the hostname is a fully qualified domain name, then the hostname will be used as-is and the account name will follow the hostname in the URL path.

Default: “.blob.core.windows.net”

std::string dfs_storage_authority = ".dfs.core.windows.net"#

hostname[:port] of the Azure Data Lake Storage Gen 2 Service.

If the hostname is a relative domain name (one that starts with a ‘.’), then storage account URLs will be constructed by prepending the account name to the hostname. If the hostname is a fully qualified domain name, then the hostname will be used as-is and the account name will follow the hostname in the URL path.

Default: “.dfs.core.windows.net”

std::string blob_storage_scheme = "https"#

Azure Blob Storage connection transport.

Default: “https”

std::string dfs_storage_scheme = "https"#

Azure Data Lake Storage Gen 2 connection transport.

Default: “https”

std::shared_ptr<const KeyValueMetadata> default_metadata#

Default metadata for OpenOutputStream.

This will be ignored if non-empty metadata is passed to OpenOutputStream.

bool background_writes = true#: Whether OutputStream writes will be issued in the background, without blocking.

Public Static Functions

static Result<AzureOptions> FromUri(const Uri &uri, std::string *out_path)#

Construct a new AzureOptions from an URI.

Supported formats:

abfs[s]://<account>.blob.core.windows.net[/<container>[/<path>]]
abfs[s]://<container>@<account>.dfs.core.windows.net[/path]
abfs[s]://[<account@]<host[.domain]>[<:port>][/<container>[/path]]
abfs[s]://[<account@]<container>[/path]

(1) and (2) are compatible with the Azure Data Lake Storage Gen2 URIs 1, (3) is for Azure Blob Storage compatible service including Azurite, and (4) is a shorter version of (1) and (2).

Note that there is no difference between abfs and abfss. HTTPS is used with abfs by default. You can force to use HTTP by specifying “enable_tls=false” query.

Supported query parameters:

blob_storage_authority: Set AzureOptions::blob_storage_authority
dfs_storage_authority: Set AzureOptions::dfs_storage_authority
enable_tls: If it’s “false” or “0”, HTTP not HTTPS is used.
credential_kind: One of “default”, “anonymous”, “workload_identity”, “environment” or “cli”. If “default” is specified, it’s just ignored. If “anonymous” is specified, AzureOptions::ConfigureAnonymousCredential() is called. If “workload_identity” is specified, AzureOptions::ConfigureWorkloadIdentityCredential() is called. If “environment” is specified, AzureOptions::ConfigureEnvironmentCredential() is called. If “cli” is specified, AzureOptions::ConfigureCLICredential() is called.
tenant_id: You must specify “client_id” and “client_secret” too. AzureOptions::ConfigureClientSecretCredential() is called.
client_id: If you don’t specify “tenant_id” and “client_secret”, AzureOptions::ConfigureManagedIdentityCredential() is called. If you specify “tenant_id” and “client_secret” too, AzureOptions::ConfigureClientSecretCredential() is called.
client_secret: You must specify “tenant_id” and “client_id” too. AzureOptions::ConfigureClientSecretCredential() is called.
A SAS token is made up of several query parameters. Appending a SAS token to the URI configures SAS token auth by calling AzureOptions::ConfigureSASCredential().

class AzureFileSystem : public arrow::fs::FileSystem #

FileSystem implementation backed by Azure Blob Storage (ABS) 1 and Azure Data Lake Storage Gen2 (ADLS Gen2) 2.

ADLS Gen2 isn’t a dedicated service or account type. It’s a set of capabilities that support high throughput analytic workloads, built on Azure Blob Storage. All the data ingested via the ADLS Gen2 APIs is persisted as blobs in the storage account. ADLS Gen2 provides filesystem semantics, file-level security, and Hadoop compatibility. ADLS Gen1 exists as a separate object that will retired on 2024-02-29 and new ADLS accounts use Gen2 instead.

ADLS Gen2 and Blob APIs can operate on the same data, but there are some limitations 3. The ones that are relevant to this implementation are listed here:

You can’t use Blob APIs, and ADLS APIs to write to the same instance of a file. If you write to a file by using ADLS APIs then that file’s blocks won’t be visible to calls to the GetBlockList Blob API. The only exception is when you’re overwriting.
When you use the ListBlobs operation without specifying a delimiter, the results include both directories and blobs. If you choose to use a delimiter, use only a forward slash (/) — the only supported delimiter.
If you use the DeleteBlob API to delete a directory, that directory is deleted only if it’s empty. This means that you can’t use the Blob API delete directories recursively.

Public Functions

const AzureOptions &options() const#: Return the original Azure options when constructing the filesystem.

virtual Result<FileInfo> GetFileInfo(const std::string &path) override#

Get info for the given target.

Any symlink is automatically dereferenced, recursively. A nonexistent or unreachable file returns an Ok status and has a FileType of value NotFound. An error status indicates a truly exceptional condition (low-level I/O error, etc.).

virtual Result<FileInfoVector> GetFileInfo(const FileSelector &select) override#

Same, according to a selector.

The selector’s base directory will not be part of the results, even if it exists. If it doesn’t exist, see FileSelector::allow_not_found.

virtual Status CreateDir(const std::string &path, bool recursive) override#

Create a directory and subdirectories.

This function succeeds if the directory already exists.

virtual Status DeleteDir(const std::string &path) override#

Delete a directory and its contents recursively.

Atomicity is guaranteed only on Hierarchical Namespace Storage accounts.

virtual Status DeleteDirContents(const std::string &path, bool missing_dir_ok) override#

Non-atomically deletes the contents of a directory.

This function can return a bad Status after only partially deleting the contents of the directory.

virtual Status DeleteRootDirContents() override#

Deletion of all the containers in the storage account (not implemented for safety reasons).

Returns:: Status::NotImplemented

virtual Status DeleteFile(const std::string &path) override#

Deletes a file.

Supported on both flat namespace and Hierarchical Namespace storage accounts. A check is made to guarantee the parent directory doesn’t disappear after the blob is deleted and while this operation is running, no other client can delete the parent directory due to the use of leases.

This means applications can safely retry this operation without coordination to guarantee only one client/process is trying to delete the same file.

virtual Status Move(const std::string &src, const std::string &dest) override#

Move/rename a file or directory.

There are no files immediately at the root directory, so paths like “/segment” always refer to a container of the storage account and are treated as directories.

If dest exists but the operation fails for some reason, Move guarantees dest is not lost.

Conditions for a successful move:

src must exist.
dest can’t contain a strict path prefix of src. More generally, a directory can’t be made a subdirectory of itself.
If dest already exists and it’s a file, src must also be a file. dest is then replaced by src.
All components of dest must exist, except for the last.
If dest already exists and it’s a directory, src must also be a directory and dest must be empty. dest is then replaced by src and its contents.

Leases are used to guarantee the pre-condition checks and the rename operation are atomic: other clients can’t invalidate the pre-condition in the time between the checks and the actual rename operation.

This is possible because Move() is only support on storage accounts with Hierarchical Namespace Support enabled.

Limitations

Moves are not supported on storage accounts without Hierarchical Namespace support enabled
Moves across different containers are not supported
Moving a path of the form /container is not supported as it would require moving all the files in a container to another container. The only exception is a Move("/container_a", "/container_b") where both containers are empty or container_b doesn’t even exist. The atomicity of the emptiness checks followed by the renaming operation is guaranteed by the use of leases.

virtual Status CopyFile(const std::string &src, const std::string &dest) override#

Copy a file.

If the destination exists and is a directory, an error is returned. Otherwise, it is replaced.

virtual Result<std::shared_ptr<io::InputStream>> OpenInputStream(const std::string &path) override#: Open an input stream for sequential reading.

virtual Result<std::shared_ptr<io::InputStream>> OpenInputStream(const FileInfo &info) override#

Open an input stream for sequential reading.

This override assumes the given FileInfo validly represents the file’s characteristics, and may optimize access depending on them (for example avoid querying the file size or its existence).

virtual Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(const std::string &path) override#: Open an input file for random access reading.

virtual Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(const FileInfo &info) override#

Open an input file for random access reading.

This override assumes the given FileInfo validly represents the file’s characteristics, and may optimize access depending on them (for example avoid querying the file size or its existence).

virtual Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) override#

Open an output stream for sequential writing.

If the target already exists, existing data is truncated.

virtual Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(const std::string &path, const std::shared_ptr<const KeyValueMetadata> &metadata) override#

Open an output stream for appending.

If the target doesn’t exist, a new empty file is created.

Note: some filesystem implementations do not support efficient appending to an existing file, in which case this method will return NotImplemented. Consider writing to multiple files (using e.g. the dataset layer) instead.

virtual Result<std::string> PathFromUri(const std::string &uri_string) const override#

Ensure a URI (or path) is compatible with the given filesystem and return the path.

This method will check to ensure the given filesystem is compatible with the URI. This can be useful when the user provides both a URI and a filesystem or when a user provides multiple URIs that should be compatible with the same filesystem.

uri_string can be an absolute path instead of a URI. In that case it will ensure the filesystem (if supplied) is the local filesystem (or some custom filesystem that is capable of reading local paths) and will normalize the path’s file separators.

Note, this method only checks to ensure the URI scheme is valid. It will not detect inconsistencies like a mismatching region or endpoint override.

Parameters:: uri_string – A URI representing a resource in the given filesystem.
Returns:: The path inside the filesystem that is indicated by the URI.