File¶
The file:// source reads local files in various
file formats through the same
readers used by the local and remote filesystem sources.
URI format¶
Everything after file:// is treated as a filesystem path. Relative paths
resolve against the current working directory; an extra leading slash gives an
absolute path.
file://<path>
Form |
Example |
Resolves to |
|---|---|---|
Relative path |
|
|
Absolute path (POSIX) |
|
|
Windows drive |
|
|
Windows UNC |
|
|
Path via |
|
|
Glob |
|
all matching files in |
Format hint |
|
|
Tip
file:// intentionally treats the first path segment as part of the path, not
as an RFC-8089 host. This is what makes the two-slash form file://data/x.csv
(relative to the working directory) work. Use the three-slash form
file:///abs/x.csv for absolute paths.
Note
Windows paths are supported: file:///C:/data/x.csv (or file://C:/data/x.csv)
reads the drive path C:\data\x.csv, and file:////server/share/x.csv reads the
UNC path \\server\share\x.csv. Backslash input (file://\\server\share\x.csv)
is accepted as well.
Glob patterns¶
The path may contain a glob pattern to load multiple files at once. The split
into directory and pattern happens at the first segment containing a glob
character (*, ?, [), so recursive patterns work:
Pattern |
Description |
|---|---|
|
All CSV files at the top level of |
|
All JSONL files under |
|
All gzipped CSV files under |
Compressed files¶
Gzipped files (.gz) are detected and decompressed automatically, so
file://data/events.csv.gz loads without any extra configuration.
Destination connector¶
When addressing filesystems for writing, the output format is taken from the
destination file extension or from an explicit format hint
(#format), exactly like the source side is doing it. The written file drops dlt’s internal bookkeeping columns, so it
round-trips cleanly.
omniload ingest \
--source-uri 'postgres://user:password@host:5432/db' \
--source-table 'public.users' \
--dest-uri 'file://export/users.parquet' \
--dest-table 'public.users'
Destination URI |
Output |
|---|---|
|
CSV written to |
|
JSONL written to |
|
Feather written to |
|
JSON written to |
|
ORC written to |
|
Parquet written to |
|
YAML written to |
|
CSV written to |
The path grammar is identical to the source (relative-to-cwd, absolute,
Windows drive and UNC forms all resolve the same way). Supported output formats
are csv, feather, json, jsonl, orc, parquet and yaml; any other extension
(or none) is rejected with the supported-format list. --dest-table must be
<dataset>.<table>; it only names the intermediate layout, the output file is
the URI path.
Parent directories in the destination path are created if they don’t exist, and an existing file at the destination is overwritten. Globs are a read-only feature and are not supported when writing.
Relationship to csv://¶
csv:// is the same connector with the file format pinned to CSV. It
shares these readers, this writer and this path grammar, and differs only in
rejecting every non-CSV format. file:// is the canonical spelling for local
files, covering Feather, JSONL, ORC, Parquet and workbooks as well as CSV;
csv:// is kept so existing commands keep working.
Examples¶
Load CSV into DuckDB¶
omniload ingest \
--source-uri 'file://data/users.csv' \
--source-table 'users' \
--dest-uri 'duckdb:///local.duckdb' \
--dest-table 'public.users'
The --source-table value is only used as the path when the URI path is empty
(the split form above); otherwise it is ignored, and the destination table is
controlled by --dest-table.
Load spreadsheet into DuckDB¶
omniload ingest \
--source-uri 'file://users.xlsx#sheet_name=staff' \
--dest-uri 'duckdb:///local.duckdb' \
--dest-table 'public.staff'
Here, sheet_name is a reader hint to address the worksheet within the workbook
by name. If the parameter is omitted, the reader will read the first sheet of the
workbook. The loader is using polars.read_excel, please consult its documentation
about all available parameters and their descriptions.