Skip to main content
Version: PromptQL

Remove a subgraph

Introduction​

In this recipe, you'll learn how to remove a subgraph from your local project directory.

Prerequisites

Before continuing, ensure you have:

Recipe​

Step 1. Delete subgraph directory​

Delete the directory containing the subgraph related config files, connectors and metadata of the subgraph. The subgraph directory is typically located at <subgraph-name>.

Step 2. Update supergraph config files​

Remove the path to the subgraph config files in all supergraph config files located at the project root, i.e., <project-root>/supergraph.yaml.

supergraph.yaml
kind: Supergraph
version: v2
definition:
  subgraphs:
    - globals/subgraph.yaml
    - <subgraph-name>/subgraph.yaml
    ...

Step 3. Update engine compose file​

Remove references to any compose files of connectors in the deleted subgraph from the engine compose file. The engine compose file is typically located at <project-root>/compose.yaml.

<project-root>/compose.yaml
include:
  - path: <subgraph-name>/connector/<connector-1>/compose.yaml
  - path: <subgraph-name>/connector/<connector-2>/compose.yaml
  ...
services:
  engine: ...

Step 4. Remove subgraph config file from context​

The context config file subgraph config file path saved in the context. Remove the subgraph key if set as the deleted subgraph config file.

.hasura/context.yaml
kind: Context
version: v3
definition:
  current: default
  contexts:
    default:
      supergraph: ../supergraph.yaml
      subgraph: ../<subgraph-name>/subgraph.yaml
      ...

Step 5. (Optional) Remove subgraph relevant environment variables​

You can remove the environment variables that were defined for your subgraph from the env files that you might have. The CLI-generated environment variables for a subgraph typically start with the <SUBGRAPH_NAME>_ prefix.

For example, .env
...
<SUBGRAPH_NAME>_<CONNECTOR>_READ_URL="<connector-read-url>"
<SUBGRAPH_NAME>_<CONNECTOR>_WRITE_URL="<connector-write-url>"
<SUBGRAPH_NAME>_<CONNECTOR>_AUTHORIZATION_HEADER="Bearer <roken>"
...

Learn more​