Skip to content

Commit 8f6a65e

Browse files
authored
Document support for azure_location (#132)
Documentation for azure_location
1 parent 1f93b56 commit 8f6a65e

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

website/docs/releases.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ In case you are wondering why all our releases start with `0.0`, read [this FAQ
2626

2727
### Upcoming Release
2828

29+
* Support for Microsoft Azure Blob Storage using [`azure_location`](./sql/external/location.md#microsoft-azure-blob-storage)
30+
2931
### 0.0.20746 [Nov 7 2024]
3032

3133
* Support for `array_contains`, `array_position` and `array_positions` was added

website/docs/sql/external/location.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ s3_location('amazon_s3_uri'
99
[, access_key_id => 'text', secret_access_key => 'text' [, session_token => 'text'] ]
1010
[, region => 'text']
1111
)
12+
azure_location('azure_blob_storage_uri'
13+
[, sas_token => 'sas_token']
14+
)
1215
ARRAY[ <source_location> [, ...] ]
1316
```
1417

@@ -54,6 +57,31 @@ techniques such as concurrent requests, request hedging and
5457
prefetching). For maximum performance, ensure a high network bandwidth
5558
to Amazon S3, e.g., by running HyperAPI directly on an AWS EC2 instance.
5659

60+
## Microsoft Azure Blob Storage
61+
62+
```
63+
SELECT * FROM external(
64+
azure_location(
65+
'abfss://container@account.dfs.core.windows.net/products.parquet', sas_token => 'secret-sas-token'
66+
)
67+
)
68+
```
69+
70+
To access data stored on Microsoft Azure Blob Storage, you can use the
71+
`azure_location` syntax. Hyper supports the `DFS` and `BLOB` endpoints and
72+
recognizes all of the following Azure URL formats:
73+
* `abfss://container@account.dfs.core.windows.net/...`
74+
* `https://account.dfs.core.windows.net/container/...`
75+
* `https://account.blob.core.windows.net/container/...`
76+
77+
Hyper also allows you to enter the non-SSL version of the URLs (`http://` and `abfs://`),
78+
however it will always establish SSL encrypted connections.
79+
80+
Hyper's Azure support is highly optimized by using techniques such as concurrent
81+
requests, request hedging and prefetching. For maximum performance, ensure that you
82+
have a high network bandwidth to Azure Blob Storage, e.g. by running HyperAPI directly
83+
on Microsoft Azure compute.
84+
5785
## Multiple files
5886

5987
```

0 commit comments

Comments
 (0)