From 85b8629a97046bb26fb8a888ace5bd46aec5a307 Mon Sep 17 00:00:00 2001 From: Gabor Szarnyas Date: Fri, 10 Jan 2025 15:02:34 +0100 Subject: [PATCH] Document file: protocol Fixes #4525 --- _data/menu_docs_dev.json | 4 ++++ docs/guides/file_formats/file_access.md | 17 +++++++++++++++++ docs/guides/overview.md | 1 + 3 files changed, 22 insertions(+) create mode 100644 docs/guides/file_formats/file_access.md diff --git a/_data/menu_docs_dev.json b/_data/menu_docs_dev.json index 5bfc656a0ee..6eb5072a36f 100644 --- a/_data/menu_docs_dev.json +++ b/_data/menu_docs_dev.json @@ -1207,6 +1207,10 @@ { "page": "Querying Parquet Files", "url": "query_parquet" + }, + { + "page": "File Access with the file: Protocol", + "url": "file_access" } ] }, diff --git a/docs/guides/file_formats/file_access.md b/docs/guides/file_formats/file_access.md new file mode 100644 index 00000000000..0a27a9b7f7b --- /dev/null +++ b/docs/guides/file_formats/file_access.md @@ -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. diff --git a/docs/guides/overview.md b/docs/guides/overview.md index d71e4afacfa..abed2168742 100644 --- a/docs/guides/overview.md +++ b/docs/guides/overview.md @@ -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