Skip to content
This repository has been archived by the owner on Jun 24, 2024. It is now read-only.

Commit

Permalink
chore: update readme with set api key command
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardo-rp committed Apr 2, 2024
1 parent 5195b0e commit e809f1e
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ The SQL studio enables developers to query SQL-enabled subgraphs on The Graph.
![Demo](https://sql-studio-webapp.vercel.app/studio.gif)

1. Open the extension on the *Activity Bar*
2. Select the Substreams Uniswap v3 Ethereum subgraph (ID: HUZDsRpEVP2AvzDCyzDHtdc64dyDxx8FQjzsmqSg4H3B). You'll know it's selected when the icon next to it becomes a green circle.
3. Run `New Query` or click on the new file button that you see when you hover your mouse over the *Available Subgraphs* menu. This will create a GSQL file with the ID field pre-populated.
4. Type in a query. For instance, `SELECT * FROM token LIMIT 1;`
5. Run the query using either the `Run Query` command or `C-m C-r`
3. Use the `Set Api Key` command to enter your authentication token.
3. Select the Substreams Uniswap v3 Ethereum subgraph (ID: HUZDsRpEVP2AvzDCyzDHtdc64dyDxx8FQjzsmqSg4H3B). You'll know it's selected when the icon next to it becomes a green circle.
4. Run `New Query` or click on the new file button that you see when you hover your mouse over the *Available Subgraphs* menu. This will create a GSQL file with the ID field pre-populated.
5. Type in a query. For instance, `SELECT * FROM token LIMIT 1;`
6. Run the query using either the `Run Query` command or `C-m C-r`

## Features

Expand All @@ -25,11 +26,12 @@ The SQL studio enables developers to query SQL-enabled subgraphs on The Graph.
- `New Query` - Create a GSQL window to write a new query. If you've already selected a subgraph in the *Available Subgraphs* menu, it will automatically populate the `ID` field in the document.
- `Add Subgraph Info` (`C-m C-a`) - If you haven't yet added a subgraph to the document, it will add the name and ID of the currently selected subgraph.
- `Replace Subgraph Info` (`C-m C-p`) - If there is no subgraph metadata in the document, add the metadata associated with the currently selected one. If there is, replace it with the currently selected one.
- `Run Query` (`C-m C-r`) - Execute the query
- `Cancel Query` (`C-m C-c`) - Cancel execution
- `Show Results` (`C-m C-n`) - Show the results of the executed query
- `Load More Subgraphs` (`C-m C-l`) - Load the available subgraphs by signalled amount
- `Search Subgraph by Name and Description` (`C-m C-s`) - Search the subgraph by its name and description
- `Run Query` (`C-m C-r`) - Execute the query.
- `Cancel Query` (`C-m C-c`) - Cancel execution.
- `Show Results` (`C-m C-n`) - Show the results of the executed query.
- `Load More Subgraphs` (`C-m C-l`) - Load the available subgraphs by signalled amount.
- `Search Subgraph by Name and Description` (`C-m C-s`) - Search the subgraph by its name and description.
- `Set gateway API Key` - Prompt to set the API key necessary for querying. Can be run anytime via the command palette.
- `Report a Bug` (`C-m C-b`) - Report a bug to us!
- View result table with
- Sort by clicking column names
Expand Down

0 comments on commit e809f1e

Please sign in to comment.