This directory contains a Couchbase implementation of a data connector agent. It can use a Couchbase cluster and consume documents of a bucket as referenced by the "DB" config field.

The Couchbase agent currently supports the following capabilities:

• GraphQL Schema
• GraphQL Queries
• Prometheus Metrics
• Exposing Foreign-Key Information
• Mutations
• Subscriptions
• Streaming Subscriptions

Note: You can get detailed metadata about the agent's capabilities by GETting the /capabilities endpoint of the running agent.

• NodeJS 16
• "Couchbase": "^3.2.4"
• Note: NPM is used for the TS Types for the DC-API protocol
• Copy .env.example to .env and define your values to environment vars

Note: Boolean flags {FLAG} can be provided as 1, true, yes, or omitted and default to false.

The agent is configured as per the configuration schema. The valid configuration properties are:

The schema is exposed via introspection, but you can limit which documents are referenced by

The dataset used for testing the couchbase agent is sample buckets

• Travel-sample

Run:

cabal run dc-api:test:tests-dc-api -- test --agent-base-url http://localhost:8100 --agent-config '{"bucket": "travel-sample", "healtCheckStrategy": "ping"}'

From the HGE repo.

• Prometheus metrics hosted at /metrics
• Pull reference types from a package rather than checked-in files
• Health Check
• DB Specific Health Checks
• Schema
• Capabilities
• Query

Replicate by running the agent test-suite.