Add a section about partial reads in Mount (Everest) docs (#8724)

* Add a section about partial reads in Mount (Everest) docs * accept Ariel's suggestion Co-authored-by: Ariel Shaqed (Scolnicov) <[email protected]> * accept Ariel's suggestion (2) Co-authored-by: Ariel Shaqed (Scolnicov) <[email protected]> * [CR] add example command --------- Co-authored-by: Ariel Shaqed (Scolnicov) <[email protected]>
treeverse · Feb 27, 2025 · 2727542 · 2727542
1 parent 627a82b
commit 2727542
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/reference/mount.md b/docs/reference/mount.md
@@ -112,6 +112,22 @@ Flags
 --presign: Use presign for downloading.
 ```
 
+### Partial Reads
+
+{: .d-inline-block }
+experimental
+{: .label .label-red }
+
+When reading large files, Everest can fetch from lakeFS only the parts actually accessed.
+This can be useful for streaming workloads or for applications handling file formats such as Parquet, m4a, zip, tar that do not need to read the entire file.
+
+To enable partial reads, pass the `--partial-reads` flag to the `mount` (or `mount-server`) command:
+
+```bash
+everest mount --partial-reads "lakefs://image-repo/main/datasets/pets/" "./pets"
+```
+
+
 ## Examples
 
 **Note**