Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
snowch committed Oct 11, 2024
1 parent 416b2e6 commit de6d6a9
Show file tree
Hide file tree
Showing 63 changed files with 160 additions and 157 deletions.
2 changes: 1 addition & 1 deletion _sources/vast_database/sdk_ref/python-sdk-101-03.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"id": "353faac2",
"metadata": {},
"source": [
"# Python SDK Reference"
"# Complete Python SDK Reference"
]
},
{
Expand Down
7 changes: 4 additions & 3 deletions _sources/vast_database/tuning/python/howto.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Tuning
# Tuning Python SDK

<font color='red'><b>NOTE:</b> This documentation is currently under review. Please be aware that the information contained here is subject to change as we finalize our recommendations.
</font>
```{important}
This documentation is currently under review. Please be aware that the information contained here is subject to change as we finalize our recommendations.
```

## **Splits and Subsplits**

Expand Down
2 changes: 1 addition & 1 deletion _sources/vast_database/tuning/trino/howto.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tuning VAST DB for Trino
# Tuning Trino

Example config:

Expand Down
2 changes: 1 addition & 1 deletion _sources/vast_datastore/nifi/tagging_s3/overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Apache Nifi to Tag VAST Datastore S3 objects
# Tagging Datastore S3 Objects

* NIFI Dataflow Overview
* ListS3 Processor
Expand Down
4 changes: 2 additions & 2 deletions feedback/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -225,7 +225,7 @@
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../vast_database/spark/overview.html">Spark Operations Guide</a></li>
Expand Down
4 changes: 2 additions & 2 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -225,7 +225,7 @@
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="vast_database/spark/overview.html">Spark Operations Guide</a></li>
Expand Down
4 changes: 2 additions & 2 deletions intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -227,7 +227,7 @@
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="vast_database/spark/overview.html">Spark Operations Guide</a></li>
Expand Down
Binary file modified objects.inv
Binary file not shown.
4 changes: 2 additions & 2 deletions search.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -227,7 +227,7 @@
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="vast_database/sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="vast_database/spark/overview.html">Spark Operations Guide</a></li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions vast_catalog/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -226,7 +226,7 @@
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../vast_database/spark/overview.html">Spark Operations Guide</a></li>
Expand Down
4 changes: 2 additions & 2 deletions vast_catalog/python-sdk-vast-catalog.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -226,7 +226,7 @@
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vast_database/sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../vast_database/spark/overview.html">Spark Operations Guide</a></li>
Expand Down
4 changes: 2 additions & 2 deletions vast_catalog/trino_quickstart/howto.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -226,7 +226,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../vast_database/sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_database/sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_database/sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_database/sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_database/sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../../vast_database/spark/overview.html">Spark Operations Guide</a></li>
Expand Down
4 changes: 2 additions & 2 deletions vast_database/ingestion/ingestion.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -226,7 +226,7 @@
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../spark/overview.html">Spark Operations Guide</a></li>
Expand Down
4 changes: 2 additions & 2 deletions vast_database/ingestion/nifi.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -226,7 +226,7 @@
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../spark/overview.html">Spark Operations Guide</a></li>
Expand Down
4 changes: 2 additions & 2 deletions vast_database/ingestion/python.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -226,7 +226,7 @@
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../spark/overview.html">Spark Operations Guide</a></li>
Expand Down
4 changes: 2 additions & 2 deletions vast_database/ingestion/python_kafka.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -226,7 +226,7 @@
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../spark/overview.html">Spark Operations Guide</a></li>
Expand Down
4 changes: 2 additions & 2 deletions vast_database/ingestion/spark.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../vast_datastore/nifi/overview.html">Apache NiFi Patterns</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">Apache NiFi Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/quickstart.html">NiFi 2.x Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../vast_datastore/nifi/tagging_s3/overview.html">Tagging Datastore S3 Objects</a></li>
</ul>
</details></li>
Expand Down Expand Up @@ -226,7 +226,7 @@
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/projections.html">Projections</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/limit_n.html">‘LIMIT n’ functionality</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/tuning.html">Performance Tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/python-sdk-101-03.html">Complete Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../sdk_ref/python-sdk-101-03.html">Complete Python SDK Reference</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="../spark/overview.html">Spark Operations Guide</a></li>
Expand Down
Loading

0 comments on commit de6d6a9

Please sign in to comment.