Document support for azure_location (#132)

Documentation for azure_location
tableau · Nov 16, 2024 · 8f6a65e · 8f6a65e
1 parent 1f93b56
commit 8f6a65e
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/website/docs/releases.md b/website/docs/releases.md
@@ -26,6 +26,8 @@ In case you are wondering why all our releases start with `0.0`, read [this FAQ
 
 ###  Upcoming Release
 
+* Support for Microsoft Azure Blob Storage using [`azure_location`](./sql/external/location.md#microsoft-azure-blob-storage)
+
 ###  0.0.20746 [Nov 7 2024]
 
 * Support for `array_contains`, `array_position` and `array_positions` was added

diff --git a/website/docs/sql/external/location.md b/website/docs/sql/external/location.md
@@ -9,6 +9,9 @@ s3_location('amazon_s3_uri'
     [, access_key_id => 'text', secret_access_key => 'text' [, session_token => 'text'] ]
     [, region => 'text']
 )
+azure_location('azure_blob_storage_uri'
+    [, sas_token => 'sas_token']
+)
 ARRAY[ <source_location> [, ...] ]
 ```
 
@@ -54,6 +57,31 @@ techniques such as concurrent requests, request hedging and
 prefetching). For maximum performance, ensure a high network bandwidth
 to Amazon S3, e.g., by running HyperAPI directly on an AWS EC2 instance.
 
+## Microsoft Azure Blob Storage
+
+```
+SELECT * FROM external(
+    azure_location(
+        'abfss://container@account.dfs.core.windows.net/products.parquet', sas_token => 'secret-sas-token'
+    )
+)
+```
+
+To access data stored on Microsoft Azure Blob Storage, you can use the
+`azure_location` syntax. Hyper supports the `DFS` and `BLOB` endpoints and
+recognizes all of the following Azure URL formats:
+* `abfss://container@account.dfs.core.windows.net/...`
+* `https://account.dfs.core.windows.net/container/...`
+* `https://account.blob.core.windows.net/container/...`
+
+Hyper also allows you to enter the non-SSL version of the URLs (`http://` and `abfs://`),
+however it will always establish SSL encrypted connections.
+
+Hyper's Azure support is highly optimized by using techniques such as concurrent
+requests, request hedging and prefetching. For maximum performance, ensure that you
+have a high network bandwidth to Azure Blob Storage, e.g. by running HyperAPI directly
+on Microsoft Azure compute.
+
 ## Multiple files
 
 ```