(webdav)=

# WebDAV

[WebDAV] (Web Distributed Authoring and Versioning) is a set of extensions to
the Hypertext Transfer Protocol (HTTP) allowing user agents to collaboratively
edit content directly in an HTTP server, which may act as a file server.
`omniload` supports WebDAV as a data source.

## URI format

The URI for connecting to WebDAV is structured as follows.

```text
https+webdav://username:password@www.example.org/path/to/data.parquet
```

## Authentication

To integrate `omniload` with WebDAV, you need to authenticate like you
do with any HTTP server.

:::{note}
The module currently forwards parameters for HTTP Basic authentication
using username/password credentials. In theory, all [authentication types
supported by HTTPX] can be unlocked. Please [create an issue] to let us
know about your needs.
:::

## Example: Load CSV file from WebDAV into DuckDB

```sh
omniload ingest \
    --source-uri   'https+webdav://username:password@www.example.org' \
    --source-table 'path/to/user.csv' \
    --dest-uri     'duckdb:///webdav_data.duckdb' \
    --dest-table   'dest.users_details'
```

Running the command creates a table named `users_details` within the
`dest` schema in the DuckDB database file located at `webdav_data.duckdb`.

:::{tip}
Here, instead of defining the remote resource exclusively per source URI
using its `<path>` component, the `--source-table` option can specify the
base directory on the server where `omniload` should start looking for files.
:::


[authentication types supported by HTTPX]: https://www.python-httpx.org/advanced/authentication/
[create an issue]: https://github.com/panodata/omniload/issues
[WebDAV]: https://en.wikipedia.org/wiki/WebDAV