Hasura Native Data Connector Hub: ndc-hub

This repository provides:

1. A registry of connectors and
2. Resources to help build connectors to connect new & custom data sources to Hasura.

This allows Hasura users to instantly get a powerful Hasura GraphQL API (pagination, filtering, sorting, relationships) with granular RLS style authorization out of the box on any data-source (DBs, APIs).

Warning

NDC hub (the set of connectors and the SDK to build new connectors) is currently in alpha, and subject to breaking changes. It is shared here to provide an early preview of what can be expected for connector development & deployment in the future, and feedback is welcome! If you have any comments, please create an issue.

Registry

There are 2 connectors you can start trying out today, and we'll gradually add more to this list:

1. hasura/clickhouse
2. hasura/weaviate

SDK & Guides

Connector Developer Guide

The best way to get started developing Hasura native data connectors is to read the specification and familiarise yourself with the reference implementation.

Rust SDK

This repository provides a Rust crate to aid development of Hasura Native Data Connectors. Developers can implement a trait, and derive an executable which can be used to run a connector which is compatible with the specification.

In addition, this library adopts certain conventions which are not covered by the current specification:

• Connector configuration
• State management
• Trace collection

Getting Started with the SDK

cd rust-connector-sdk
cargo build

Run the example connector

cargo run --bin ndc_hub_example -- \
  --configuration <(echo 'null')

Inspect the resulting (empty) schema:

curl http://localhost:8100/schema

(the default port 8100 can be changed using --port)

Tracing

The serve command emits OTLP trace information. This can be used to see details of requests across services.

To enable tracing you must:

• Use the NDC-Hub option --otlp-endpoint e.g. http://localhost:4317
• Or, set the NDC-Hub ENV Variable OTLP_ENDPOINT
• Or, set the tracing ENV Variable OTEL_EXPORTER_OTLP_TRACES_ENDPOINT

For additional service information you can:

• Set OTEL_SERVICE_NAME e.g. ndc_hub_example
• Set OTEL_RESOURCE_ATTRIBUTES e.g. key=value, k = v , a= x, a=z

To view trace information during local development you can run a Jager server via Docker:

docker run --name jaeger -e COLLECTOR_OTLP_ENABLED=true -p 16686:16686 -p 4317:4317 -p 4318:4318 jaegertracing/all-in-one:1.45