---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: odata
excerpt: |
  DuckDB Community Extensions
  Expose DuckDB tables and views as an authenticated OData v4 HTTP API with query options, generated EDMX metadata, and opt-in writes. Inspired by quack and the OData protocol. Support duckdb v1.5 and v2.0.

extension:
  name: odata
  description: Expose DuckDB tables and views as an authenticated OData v4 HTTP API with query options, generated EDMX metadata, and opt-in writes. Inspired by quack and the OData protocol. Support duckdb v1.5 and v2.0.
  version: 0.1.2
  language: C++
  build: cmake
  license: MIT
  maintainers:
    - cn00

repo:
  github: cn00/duckdb-odata
  ref: a364f28886ba4e0a32025363a757ed501bc536f8

docs:
  hello_world: |
    INSTALL odata;
    LOAD odata;

    CREATE TABLE customers (id BIGINT, name VARCHAR, active BOOLEAN);
    CALL odata_expose('customers');
    CALL odata_entity('customers', key := 'id');
    CALL odata_serve();

  extended_description: |
    Expose selected DuckDB tables or views as OData v4 entity sets. The extension
    generates an EDMX `$metadata` document from the DuckDB catalog and supports
    query options such as `$select`, `$filter`, `$orderby`, `$top`, `$skip`, and
    `$count`. The server is read-only by default and enables bearer-token
    authentication automatically. Setting `read_only := false` enables
    validated, transactional `POST`, `PATCH`, `PUT`, and `DELETE` operations
    for exposed entities.

    ### Publish views over local files

    Use a dedicated schema for views over local CSV and Excel data, then expose
    the entire schema:

    ```sql
    INSTALL excel;
    LOAD excel;

    CREATE SCHEMA odata_sources;
    CREATE VIEW odata_sources.orders AS
        SELECT * FROM read_csv_auto('/data/orders.csv');
    CREATE VIEW odata_sources.customers AS
        SELECT * FROM read_xlsx('/data/customers.xlsx');

    CALL odata_expose_schema('odata_sources');
    CALL odata_serve();
    ```

    ### Publish attached PostgreSQL or SQL Server schemas

    Tables and views from other DuckDB connectors can be exposed without
    copying their data. Install and load the connector, attach the source, then
    expose its schema:

    ```sql
    INSTALL postgres;
    LOAD postgres;
    ATTACH 'host=db.example.com port=5432 dbname=app user=odata_reader password=<password>'
        AS pg (TYPE postgres, READ_ONLY);
    CALL odata_expose_schema('pg.public');
    CALL odata_serve();
    ```

    ```sql
    INSTALL mssql FROM community;
    LOAD mssql;
    ATTACH 'Server=db.example.com,1433;Database=app;User Id=odata_reader;Password=<password>;TrustServerCertificate=yes'
        AS mssql_db (TYPE mssql);
    CALL odata_expose_schema('mssql_db.dbo');
    CALL odata_serve();
    ```

    ### Call the OData API with curl

    `odata_serve()` returns `listen_url` and `auth_token`. Substitute those
    values into a second terminal and use the token as a bearer credential:

    ```bash
    export ODATA_URL='http://localhost:54321' # Replace with listen_url.
    export ODATA_TOKEN='replace-with-auth_token'

    curl -H "Authorization: Bearer $ODATA_TOKEN" "$ODATA_URL/odata/"
    curl -H "Authorization: Bearer $ODATA_TOKEN" "$ODATA_URL/odata/\$metadata"
    curl -H "Authorization: Bearer $ODATA_TOKEN" \
      "$ODATA_URL/odata/customers?\$filter=active%20eq%20true&\$top=10"
    ```

    Keep credentials out of SQL files and use a database account with only the
    read permissions required by the exposed data. Each OData request queries
    the underlying view or attached table, so results remain current.

    See the [project README](https://github.com/cn00/duckdb-odata#readme) for
    setup instructions, examples, and details.

extension_star_count: 0
extension_star_count_pretty: 0
extension_download_count: 20
extension_download_count_pretty: 20
image: '/images/community_extensions/social_preview/preview_community_extension_odata.png'
layout: community_extension_doc
---
### Compatibility Matrix

This table covers all DuckDB releases that have not reached [end-of-life](https://duckdb.org/release_calendar), including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

<div class="extension_compatibility_table"></div>

| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
| :--- | :---: | :---: | :---: | :---: | :---: |
| Linux AMD64 | ❌ | ❌ | ❌ | ❌ | ✅ |
| Linux ARM64 | ❌ | ❌ | ❌ | ❌ | ✅ |
| macOS AMD64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| macOS ARM64 | ❌ | ❌ | ❌ | ❌ | ✅ |
| Windows AMD64 | ❌ | ❌ | ❌ | ❌ | ✅ |
| Windows ARM64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| WebAssembly | ❌ | ❌ | ❌ | ❌ | ✅ |

### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```

{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}

{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions

<div class="extension_functions_table"></div>

|          function_name          | function_type | description | comment | examples |
|---------------------------------|---------------|-------------|---------|----------|
| __internal_odata_compile_filter | scalar        | NULL        | NULL    |          |
| odata_entity                    | table         | NULL        | NULL    |          |
| odata_expose                    | table         | NULL        | NULL    |          |
| odata_expose_schema             | table         | NULL        | NULL    |          |
| odata_serve                     | table         | NULL        | NULL    |          |
| odata_status                    | table         | NULL        | NULL    |          |
| odata_stop                      | table         | NULL        | NULL    |          |

### Overloaded Functions

<div class="extension_functions_table"></div>

This extension does not add any function overloads.

### Added Types

<div class="extension_types_table"></div>

This extension does not add any types.

### Added Settings

<div class="extension_settings_table"></div>

|             name             |                       description                       | input_type | scope  | aliases | typed_value |
|------------------------------|---------------------------------------------------------|------------|--------|---------|-------------|
| odata_max_concurrent_queries | Maximum concurrent OData queries (0 = disabled)         | BIGINT     | GLOBAL | []      | 0           |
| odata_max_filter_depth       | Maximum nesting depth of $filter                        | BIGINT     | GLOBAL | []      | 64          |
| odata_max_response_bytes     | Maximum response body size in bytes                     | BIGINT     | GLOBAL | []      | 104857600   |
| odata_max_top                | Maximum value allowed for $top                          | BIGINT     | GLOBAL | []      | 10000       |
| odata_page_size              | Default OData server-driven page size (0 = disabled)    | BIGINT     | GLOBAL | []      | 0           |
| odata_query_timeout_ms       | Query timeout in ms (0 = disabled)                      | BIGINT     | GLOBAL | []      | 0           |
| temp_directory               | Set the directory to which temporary files are written. | VARCHAR    | GLOBAL | []      | post.db.tmp |