Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-41410: [C++][FS][Azure][Docs] Add AzureFileSystem to Filesystems API reference #41411

Merged
merged 7 commits into from
May 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions cpp/src/arrow/filesystem/azurefs.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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);

Expand Down Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the \- for? I assumed --- become an em-dash when I wrote this.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was to work around what appears might be a breathe issue, see breathe-doc/breathe#963 for what I think is a similar report. Once whatever the issue is is fixed, we could revert this since it's surprising behavior.

Doxygen turns --- into <mdash/> and turns \--- into ---. For <mdash/>, Sphinx/Breathe generates &amp;#8212; instead of &#8212; so the fix here makes Sphinx output --- which works.

/// - 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.
Expand Down
9 changes: 9 additions & 0 deletions docs/source/cpp/api/filesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Loading