Skip to content

kamu-data/datafusion-odata

Repository files navigation

OData Adapter For Apache Datafusion

About

This is an OData API adapter for Apache Datafusion SQL engine.

OData protocol is positioned as "The SQL of REST", but is a somewhat legacy protocol used by some older systems. We wouldn't recommend using it as an integration protocol for some new project, but this adapter is useful if you have to integrate your Datafusion app with some existing OData-focused system.

Quick Start

Start example:

RUST_LOG=debug cargo run --example simple_service

Query using xh:

Service root:

xh GET 'http://localhost:50051/'

Metadata:

xh GET 'http://localhost:50051/$metadata'

Query collection:

xh GET 'http://localhost:50051/tickers.spy?$select=offset,from_symbol,to_symbol,close&$top=5'

Status

This code is super raw and experimental. Very far from prod-ready. Use at your own risk.

  • Only support small subset of OData 3.0
  • Only supports atom format in responses
  • Service root resource
  • $metadata resource
  • Collection resource
    • $select
    • $orderby
    • $skip
    • $top
    • $filter
    • pagination
    • real object IDs
  • Collection entry by ID (service/collection(id))
    • Numeric IDs
    • Other ID types
  • Parameters
  • Nested collections
  • Functions
  • ...