Skip to content

Commit ee4101a

Browse files
committed
Deploying to gh-pages from @ 9147fd2 🚀
1 parent 06855a3 commit ee4101a

4 files changed

Lines changed: 56 additions & 2 deletions

File tree

config/blob-store.html

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ <h1 id="blob-store"><a class="header" href="#blob-store">Blob store</a></h1>
187187
<li>HTTP/HTTPS</li>
188188
<li>S3</li>
189189
<li>GCS</li>
190+
<li>Azure Storage</li>
190191
</ul>
191192
<h2 id="filesystem"><a class="header" href="#filesystem">Filesystem</a></h2>
192193
<p>Filesystem store can be specified using <code>file:</code> or <code>filesystem:</code> schemes. In a
@@ -245,6 +246,32 @@ <h2 id="gcs"><a class="header" href="#gcs">GCS</a></h2>
245246
<li><code>GOOGLE_SERVICE_ACCOUNT</code></li>
246247
</ul>
247248
<p>Note that GCP Workload Identity is NOT supported yet, blocked by <a href="https://github.com/apache/arrow-rs/issues/3490">https://github.com/apache/arrow-rs/issues/3490</a>.</p>
249+
<h2 id="azure-storage"><a class="header" href="#azure-storage">Azure Storage</a></h2>
250+
<p>ROAPI can build tables from datasets hosted in Azure Storage. Configuration is
251+
similar to filesystem store:</p>
252+
<pre><code class="language-yaml">tables:
253+
- name: &quot;TABLE_NAME&quot;
254+
uri: &quot;az://BUCKET/TABLE/KEY&quot;
255+
option:
256+
format: &quot;csv&quot;
257+
</code></pre>
258+
<p>The supported url schemas are</p>
259+
<ul>
260+
<li><code>abfs[s]://&lt;container&gt;/&lt;path&gt;</code></li>
261+
<li><code>az://&lt;container&gt;/&lt;path&gt;</code></li>
262+
<li><code>adl://&lt;container&gt;/&lt;path&gt;</code></li>
263+
<li><code>azure://&lt;container&gt;/&lt;path&gt;</code></li>
264+
</ul>
265+
<p>To configure Azure credentials, you can set the following
266+
environment variables:</p>
267+
<ul>
268+
<li><code>AZURE_STORAGE_ACCOUNT_NAME</code></li>
269+
<li><code>AZURE_STORAGE_ACCOUNT_KEY</code></li>
270+
<li><code>AZURE_STORAGE_CLIENT_ID</code></li>
271+
<li><code>AZURE_STORAGE_TENANT_ID</code></li>
272+
<li><code>AZURE_STORAGE_SAS_KEY</code></li>
273+
<li><code>AZURE_STORAGE_TOKEN</code></li>
274+
</ul>
248275
<footer id="open-on-gh">Found a bug? <a href="https://github.com/roapi/docs/edit/main/src/config/blob-store.md">Edit this file on GitHub.</a></footer>
249276
</main>
250277

print.html

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -715,6 +715,7 @@ <h2 id="large-datasets-1"><a class="header" href="#large-datasets-1">Large Datas
715715
<li>HTTP/HTTPS</li>
716716
<li>S3</li>
717717
<li>GCS</li>
718+
<li>Azure Storage</li>
718719
</ul>
719720
<h2 id="filesystem"><a class="header" href="#filesystem">Filesystem</a></h2>
720721
<p>Filesystem store can be specified using <code>file:</code> or <code>filesystem:</code> schemes. In a
@@ -773,6 +774,32 @@ <h2 id="gcs"><a class="header" href="#gcs">GCS</a></h2>
773774
<li><code>GOOGLE_SERVICE_ACCOUNT</code></li>
774775
</ul>
775776
<p>Note that GCP Workload Identity is NOT supported yet, blocked by <a href="https://github.com/apache/arrow-rs/issues/3490">https://github.com/apache/arrow-rs/issues/3490</a>.</p>
777+
<h2 id="azure-storage"><a class="header" href="#azure-storage">Azure Storage</a></h2>
778+
<p>ROAPI can build tables from datasets hosted in Azure Storage. Configuration is
779+
similar to filesystem store:</p>
780+
<pre><code class="language-yaml">tables:
781+
- name: &quot;TABLE_NAME&quot;
782+
uri: &quot;az://BUCKET/TABLE/KEY&quot;
783+
option:
784+
format: &quot;csv&quot;
785+
</code></pre>
786+
<p>The supported url schemas are</p>
787+
<ul>
788+
<li><code>abfs[s]://&lt;container&gt;/&lt;path&gt;</code></li>
789+
<li><code>az://&lt;container&gt;/&lt;path&gt;</code></li>
790+
<li><code>adl://&lt;container&gt;/&lt;path&gt;</code></li>
791+
<li><code>azure://&lt;container&gt;/&lt;path&gt;</code></li>
792+
</ul>
793+
<p>To configure Azure credentials, you can set the following
794+
environment variables:</p>
795+
<ul>
796+
<li><code>AZURE_STORAGE_ACCOUNT_NAME</code></li>
797+
<li><code>AZURE_STORAGE_ACCOUNT_KEY</code></li>
798+
<li><code>AZURE_STORAGE_CLIENT_ID</code></li>
799+
<li><code>AZURE_STORAGE_TENANT_ID</code></li>
800+
<li><code>AZURE_STORAGE_SAS_KEY</code></li>
801+
<li><code>AZURE_STORAGE_TOKEN</code></li>
802+
</ul>
776803
<footer id="open-on-gh">Found a bug? <a href="https://github.com/roapi/docs/edit/main/src/config/blob-store.md">Edit this file on GitHub.</a></footer><h1 id="databases"><a class="header" href="#databases">Databases</a></h1>
777804
<p>Thanks to the <a href="https://github.com/sfu-db/connector-x">connector-x</a> Rust crate,
778805
ROAPI is able to load tables from popular relational databases like MySQL,

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

searchindex.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)