Skip to content

Latest commit

 

History

History
112 lines (83 loc) · 3.49 KB

README.md

File metadata and controls

112 lines (83 loc) · 3.49 KB
Raw

e# Hasura NDC V3 JVM Repository

This repository contains the source code for the Hasura NDC V3 Connectors deployed on the JVM.

It consists of the following components:

  • /ndc-ir: The intermediate representation for the NDC V3 Connectors
  • /ndc-sqlgen: Common SQL generation utilities for the NDC V3 Connectors
  • /ndc-cli: The CLI tool used to introspect databases and generate NDC V3 metadata configuration
  • /ndc-app: The base web service skeleton for NDC V3 Connectors
  • /ndc-connector-oracle: The Oracle NDC V3 Connector

Prerequisites

  • Docker
  • Java 21
    • The easiest way to install Java is via SDKMAN
      • curl -s "https://get.sdkman.io" | bash
      • sdk install java 21
  • A .env file containing jOOQ Enterprise license keys 
    • JOOQ_PRO_EMAIL=
JOOQ_PRO_LICENSE=

Building the Connectors

To build the connectors, run the following command:

./gradlew build -x test

This will run the build and skip tests for each of the services.

When finished, the following files should be present:

  • /ndc-connector-oracle/build/quarkus-app/quarkus-run.jar - The executable service JAR

Running the Connectors

NOTE:

Before a connector can be run, an environment variable HASURA_CONFIGURATION_DIRECTORY must be present and point to the directory containing the connector.config.json for that connector.

For example, to use the provided Oracle test configuration file, you can use: export HASURA_CONFIGURATION_DIRECTORY=$(pwd)/ndc-connector-oracle.

There are two ways to run the connectors:

  1. In Development Mode
    • To run the connector in development mode, run the following command: 
      ./gradlew :ndc-connector-oracle:quarkusDev --console=plain
    • This will start the connectors in hot-reload mode, which will automatically reload when changes are made to the source code.
  2. In Production Mode
    • To run the connector in production mode, run the following command: 
      java -jar ndc-connector-oracle/build/quarkus-app/quarkus-run.jar

Running the CLI

To run the CLI, either launch it via the Gradle task, or build a distribution and run the bundled executable.

  • To run it as a Gradle task: 
    ./gradlew :ndc-cli:run --args="update jdbc:oracle:thin:@//localhost:1521/XE?user=chinook&password=Password123 --database ORACLE"
  • To build a distribution and run the bundled executable: 
    ./gradlew :ndc-cli:installDist
./ndc-cli/build/install/ndc-cli/bin/ndc-cli update "jdbc:oracle:thin:@//localhost:1521/XE?user=chinook&password=Password123" --database ORACLE

A bundled distribution .zip and .tar can be found in the ndc-cli/build/distributions directory.

Docker

To build the Docker images, run the following commands:

docker compose build ndc-connector-oracle

To run the Docker images, run the following commands:

config_file_location=$(pwd)/ndc-connector-oracle/configuration.json
docker run \
  --rm \
  -p 8100:8100 \
  -v $config_file_location:/etc/connector/configuration.json \
  ndc-connector-oracle:latest

Testing

To run the tests against the Oracle connector, use the ndc-spec test binary.

This comes from the ndc-spec repo, which can be found here:

git clone https://github.com/hasura/ndc-spec
cd ndc-spec
cargo run --bin ndc-test -- test \
  --endpoint http://localhost:8100 \
  --snapshots-dir snapshots