Skip to content

RFC: simplify subgraph getting started and federation #29

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.

Sign up for GitHub

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

Open
art049 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

RFC: simplify subgraph getting started and federation #29

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ab3fa5
20240620-simplify-subgraph-getting-started-and-federation
nullxone Jun 20, 2024
89495d5
Clarify details on env overrides and target flags
nullxone Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions v3/rfcs/dx/20240620-simplify-subgraph-getting-started-and-federation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# DX: simplify subgraphs for getting started and federation workflows

Status: Review required

## subgraph init command
What this is: as a part of making it easier for people to work through the getting started guide, or to scaffold project files, allow the user to go from scratch to an API with only CLI commands.

init-ing a supergraph or connector will create files for both local and cloud environments. This is about what happens for the subgraphs.

```bash
# creates a subgraph folder and subgraph.yaml file
ddn subgraph init app

# add subgraph.yaml to the supergraph.yaml file and create an env file for the env
ddn supergraph add subgraph --supergraph supergraph.local.yaml --subgraph app/subgraph.yaml
touch app/.env.app.local

# create the supergraph build
ddn supergraph build --supergraph supergraph.yaml --env-file app/.env.app.local

# deploy to cloud
touch app/.env.app.cloud
ddn connector build create --connector connector.yaml --target-env-file app/.env.app.cloud
```

Order of env
- specify either as --env flags or --env-file flags, which can be specified multiple times
- all flags override the env specified in the subgraph.yaml file
- later flags override earlier flags

## --subgraph flag should take the file name

What this is about: on introducing federation, we realize that the primitive is the subgraph not the supergraph. The following commands are updated to consider the subgraph.yaml file instead of specifying a supergraph.yaml file and the subgraph by name.

```bash
ddn connector init mydb --subgraph app/subgraph.yaml --hub-connector hasura/postgres

ddn connector build create --connector mydb/connector.yaml --target-subgraph app/subgraph.yaml --target-connector-link mypg # use env file from subgraph.yaml

ddn connector build create --connector mydb/connector.yaml --target-subgraph app/subgraph.yaml --target-connector-link mypg --target-env-file app/.env.app.cloud

ddn model add --subgraph app/subgraph.yaml --connector-link mydb --name Album

ddn connector build get --connector-name mypg --subgraph-name app --project proj-1234

ddn connector build get --connector mypg/connector.yaml
```