You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/pages/en/deploying/deploy-using-subgraph-studio.mdx
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,23 @@
2
2
title: Deploy Using Subgraph Studio
3
3
---
4
4
5
-
Learn how to deploy your subgraph in Subgraph Studio.
5
+
Learn how to deploy your subgraph to Subgraph Studio.
6
6
7
7
> Note: When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to test it. It's important to remember that deploying is not the same as publishing. When you publish a subgraph, you're publishing it on-chain.
8
8
9
9
## Subgraph Studio Overview
10
10
11
11
In [Subgraph Studio](https://thegraph.com/studio/), you can do the following:
12
12
13
+
- View a list of subgraphs you've created
14
+
- Manage, view details, and visualize the status of a specific subgraph
13
15
- Create and manage your API keys for specific subgraphs
16
+
- Restrict your API keys to specific domains and allow only certain Indexers to query with them
14
17
- Create your subgraph through the Studio UI
15
18
- Deploy your subgraph using the The Graph CLI
16
-
- Integrate your subgraph in staging using the query URL
17
-
- Publish your subgraph with the Studio UI
18
19
- Test your subgraph in the playground environment
19
-
- Restrict your API keys to specific domains and allow only certain Indexers to query with them
20
-
- View a list of subgraphs you've created
21
-
- Manage, view details, and visualize the status of a specific subgraph
20
+
- Integrate your subgraph in staging using the development query URL
21
+
- Publish your subgraph with the Studio UI
22
22
- Manage your billing
23
23
24
24
## Install The Graph CLI
@@ -39,9 +39,9 @@ yarn global add @graphprotocol/graph-cli
39
39
npm install -g @graphprotocol/graph-cli
40
40
```
41
41
42
-
## Create your Subgraph
42
+
## Create Your Subgraph
43
43
44
-
Before deploying your subgraph you need to create a subgraph in [Subgraph Studio](https://thegraph.com/studio/).
44
+
Before deploying your subgraph you need to create an account in [Subgraph Studio](https://thegraph.com/studio/).
45
45
46
46
1. Open [Subgraph Studio](https://thegraph.com/studio/).
47
47
2. Connect your wallet to sign in.
@@ -67,7 +67,7 @@ In order to be supported by Indexers on The Graph Network, subgraphs must:
67
67
- Non-fatal errors
68
68
- Grafting
69
69
70
-
## Initialize your Subgraph
70
+
## Initialize Your Subgraph
71
71
72
72
Once your subgraph has been created in Subgraph Studio, you can initialize its code through the CLI using this command:
73
73
@@ -108,17 +108,17 @@ After running this command, the CLI will ask for a version label.
108
108
- It's strongly recommended to use [semver](https://semver.org/) for versioning like `0.0.1`. That said, you are free to choose any string as version such as `v1`, `version1`, or `asdf`.
109
109
- The labels you create will be visible in Graph Explorer and can be used by curators to decide if they want to signal on a specific version or not, so choose them wisely.
110
110
111
-
## Testing your Subgraph
111
+
## Testing Your Subgraph
112
112
113
113
After deploying, you can test your subgraph (either in Subgraph Studio or in your own app, with the deployment query URL), deploy another version, update the metadata, and publish to [Graph Explorer](https://thegraph.com/explorer) when you are ready.
114
114
115
115
Use Subgraph Studio to check the logs on the dashboard and look for any errors with your subgraph.
116
116
117
-
## Publish your Subgraph
117
+
## Publish Your Subgraph
118
118
119
119
In order to publish your subgraph successfully, review [publishing a subgraph](/publishing/publishing-a-subgraph/).
120
120
121
-
## Versioning your Subgraph with the CLI
121
+
## Versioning Your Subgraph with the CLI
122
122
123
123
If you want to update your subgraph, you can do the following:
124
124
@@ -132,7 +132,7 @@ You can also update your subgraph's metadata without publishing a new version. Y
132
132
133
133
## Automatic Archiving of Subgraph Versions
134
134
135
-
Whenever you deploy a new subgraph version in Subgraph Studio, the previous version will be archived. Archived versions won't be indexed/synced and therefore cannot be queried. You can unarchive an archived version of your subgraph in Studio UI.
135
+
Whenever you deploy a new subgraph version in Subgraph Studio, the previous version will be archived. Archived versions won't be indexed/synced and therefore cannot be queried. You can unarchive an archived version of your subgraph in Subgraph Studio.
136
136
137
137
> Note: Previous versions of non-published subgraphs deployed to Studio will be automatically archived.
0 commit comments