Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add native toolchain definition to connector metadata #60

Merged
merged 4 commits into from
Feb 25, 2025

Conversation

paritosh-08
Copy link
Contributor

@paritosh-08 paritosh-08 commented Feb 11, 2025

This PR adds native toolchains in ndc-bigquery.

It also adds CLI snapshot tests (similar to what we have in ndc-postgres).
image

What

This PR adds the native toolchain definition to the connector metadata.

It also adds two commands in the initial metadata generated by the CLI:

nativeToolchainDefinition:
  commands:
    start:
      type: ShellScript
      bash: |-
        #!/usr/bin/env bash
        set -eu -o pipefail
        HASURA_CONFIGURATION_DIRECTORY="$HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH" "$HASURA_DDN_NATIVE_CONNECTOR_DIR/ndc-bigquery" serve
      powershell: |-
        $ErrorActionPreference = "Stop"
        $env:HASURA_CONFIGURATION_DIRECTORY="$env:HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH"; & "$env:HASURA_DDN_NATIVE_CONNECTOR_DIR\ndc-bigquery.exe" serve
    update:
      type: ShellScript
      bash: |-
        #!/usr/bin/env bash
        set -eu -o pipefail
        "$HASURA_DDN_NATIVE_CONNECTOR_PLUGIN_DIR/hasura-ndc-bigquery" update
      powershell: |-
        $ErrorActionPreference = "Stop"
        & "$env:HASURA_DDN_NATIVE_CONNECTOR_PLUGIN_DIR\hasura-ndc-bigquery.exe" update
Click here for the CLI command output
❯ mkdir test; cd test; ndc-bigquery-cli initialize --with-metadata
❯ cat .hasura-connector/connector-metadata.yaml
packagingDefinition:
  type: PrebuiltDockerImage
  dockerImage: ghcr.io/hasura/ndc-bigquery:latest
supportedEnvironmentVariables:
- name: HASURA_BIGQUERY_SERVICE_KEY
  description: The BigQuery service key
- name: HASURA_BIGQUERY_PROJECT_ID
  description: The BigQuery project ID/name
- name: HASURA_BIGQUERY_DATASET_ID
  description: The BigQuery dataset ID/name
commands:
  update: hasura-ndc-bigquery update
cliPlugin:
  name: ndc-bigquery
  version: latest
dockerComposeWatch:
- path: ./
  target: /etc/connector
  action: sync+restart
nativeToolchainDefinition:
  commands:
    start:
      type: ShellScript
      bash: |-
        #!/usr/bin/env bash
        set -eu -o pipefail
        HASURA_CONFIGURATION_DIRECTORY="$HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH" "$HASURA_DDN_NATIVE_CONNECTOR_DIR/ndc-bigquery" serve
      powershell: |-
        $ErrorActionPreference = "Stop"
        $env:HASURA_CONFIGURATION_DIRECTORY="$env:HASURA_PLUGIN_CONNECTOR_CONTEXT_PATH"; & "$env:HASURA_DDN_NATIVE_CONNECTOR_DIR\ndc-bigquery.exe" serve
    update:
      type: ShellScript
      bash: |-
        #!/usr/bin/env bash
        set -eu -o pipefail
        "$HASURA_DDN_NATIVE_CONNECTOR_PLUGIN_DIR/hasura-ndc-bigquery" update
      powershell: |-
        $ErrorActionPreference = "Stop"
        & "$env:HASURA_DDN_NATIVE_CONNECTOR_PLUGIN_DIR\hasura-ndc-bigquery.exe" update

How

Copy link
Contributor

@daniel-chambers daniel-chambers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems legit :)

@paritosh-08 paritosh-08 merged commit 5894ac4 into main Feb 25, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants