Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document file: protocol #4550

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions _data/menu_docs_dev.json
Original file line number Diff line number Diff line change
Expand Up @@ -1207,6 +1207,10 @@
{
"page": "Querying Parquet Files",
"url": "query_parquet"
},
{
"page": "File Access with the file: Protocol",
"url": "file_access"
}
]
},
Expand Down
17 changes: 17 additions & 0 deletions docs/guides/file_formats/file_access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: docu
title: "File Access with the file: Protocol"
---

DuckDB supports using the `file:` protocol. It currently supports the following formats:

* `file:/some/path` (host omitted completely)
* `file:///some/path` (empty host)
* `file://localhost/some/path` (`localhost` as host)

Note that the following formats are *not* supported because they are non-standard:

* `file:some/relative/path` (relative path)
* `file://some/path` (double-slash path)

Additionally, the `file:` protocol currently does not support remote (non-localhost) hosts.
1 change: 1 addition & 0 deletions docs/guides/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Note that there are many tools using DuckDB, which are not covered in the offici
## Data Import and Export

* [Data import overview]({% link docs/guides/file_formats/overview.md %})
* [File Access with the file: Protocol]({% link docs/guides/file_formats/file_access.md %})

### CSV Files

Expand Down