This is an automated email from the ASF dual-hosted git repository.
kou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 22f88fa4a8 GH-41410: [C++][FS][Azure][Docs] Add AzureFileSystem to
Filesystems API reference (#41411)
22f88fa4a8 is described below
commit 22f88fa4a8f5ac7250f1845aace5a78d20006ef2
Author: Bryce Mecum <[email protected]>
AuthorDate: Wed May 1 00:12:37 2024 -0800
GH-41410: [C++][FS][Azure][Docs] Add AzureFileSystem to Filesystems API
reference (#41411)
### Rationale for this change
See https://github.com/apache/arrow/issues/41410.
### What changes are included in this PR?
Just changes to filesystem.rst.
### Are these changes tested?
Yes, locally.
### Are there any user-facing changes?
These are those changes.
* GitHub Issue: #41410
Authored-by: Bryce Mecum <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
---
cpp/src/arrow/filesystem/azurefs.h | 17 ++++++++---------
docs/source/cpp/api/filesystem.rst | 9 +++++++++
2 files changed, 17 insertions(+), 9 deletions(-)
diff --git a/cpp/src/arrow/filesystem/azurefs.h
b/cpp/src/arrow/filesystem/azurefs.h
index 667b4e372a..b71a5ae73b 100644
--- a/cpp/src/arrow/filesystem/azurefs.h
+++ b/cpp/src/arrow/filesystem/azurefs.h
@@ -141,18 +141,14 @@ struct ARROW_EXPORT AzureOptions {
///
/// 1. abfs[s]://[:\<password\>@]\<account\>.blob.core.windows.net
/// [/\<container\>[/\<path\>]]
- /// 2.
abfs[s]://\<container\>[:\<password\>]@\<account\>.dfs.core.windows.net
- /// [/path]
+ /// 2.
abfs[s]://\<container\>[:\<password\>]\@\<account\>.dfs.core.windows.net[/path]
/// 3. abfs[s]://[\<account[:\<password\>]@]\<host[.domain]\>[\<:port\>]
/// [/\<container\>[/path]]
/// 4. abfs[s]://[\<account[:\<password\>]@]\<container\>[/path]
///
- /// 1. and 2. are compatible with the Azure Data Lake Storage Gen2 URIs:
- ///
https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri
- ///
- /// 3. is for Azure Blob Storage compatible service including Azurite.
- ///
- /// 4. is a shorter version of 1. and 2.
+ /// (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
@@ -178,6 +174,9 @@ struct ARROW_EXPORT AzureOptions {
/// AzureOptions::ConfigureClientSecretCredential() is called.
/// * client_secret: You must specify "tenant_id" and "client_id"
/// too. AzureOptions::ConfigureClientSecretCredential() is called.
+ ///
+ /// [1]:
+ ///
https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri
static Result<AzureOptions> FromUri(const Uri& uri, std::string* out_path);
static Result<AzureOptions> FromUri(const std::string& uri, std::string*
out_path);
@@ -226,7 +225,7 @@ struct ARROW_EXPORT AzureOptions {
/// 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.
+/// 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.
diff --git a/docs/source/cpp/api/filesystem.rst
b/docs/source/cpp/api/filesystem.rst
index 02b1266832..599e9fedb6 100644
--- a/docs/source/cpp/api/filesystem.rst
+++ b/docs/source/cpp/api/filesystem.rst
@@ -97,3 +97,12 @@ Google Cloud Storage filesystem
.. doxygenclass:: arrow::fs::GcsFileSystem
:members:
+
+Azure filesystem
+----------------
+
+.. doxygenstruct:: arrow::fs::AzureOptions
+ :members:
+
+.. doxygenclass:: arrow::fs::AzureFileSystem
+ :members:
