Skip to content

hasura/ndc-odata

Repository files navigation

OData NDC

A Native Data Connector (NDC) for OData APIs, specifically for those adhering to OData v4.01.

See the example/ directory for sample metadata corresponding to the OData reference service: TripPin.

Getting started

  • just config-server will run the configuration server.
  • just update will use the running configuration server to update a given metadata file (or, by default, example/metadata.json).
  • just start will run the NDC with the given metadata file (or, by default, example/metadata.json).

A Docker setup is also provided: docker compose up will run the NDC with the example configuration, or whatever file METADATA_PATH points to.

Roadmap

The connector currently implements the following features. This list was taken from the ndc-spec list.

  • Service Health
  • Metrics
  • Telemetry
  • Capabilities
  • Schema
    • Scalar Types
    • Object Types
    • Collections
    • Functions
    • Procedures
  • Queries
    • Field Selection
    • Filtering
      • Equality with scalars
      • Equality between local columns
      • Equality with root columns
      • Nullability checks
      • Existential predicates
    • Sorting
    • Pagination
    • Aggregates
    • Arguments
    • Relationships
    • Variables
  • Mutations
    • Procedures
  • Explain

Releases

No releases published

Packages

No packages published