-
Notifications
You must be signed in to change notification settings - Fork 19
Introduce the ENSDb Interactive Playground to ENSNode Docs #2321
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
a888fd4
Create a page including the ENSDb SQL Viewer
tk-o 7a99537
Apply feedback
tk-o c230031
Use production URL for the ENSDb Interactive Playground app
tk-o d9e5465
Merge remote-tracking branch 'origin/main' into docs/ensdb-sql-viewer
tk-o e905db0
Add a warning addressing perf issues with Drizzle Gateway
tk-o 0bb0f18
Apply AI PR feedback
tk-o 2ad8436
Apply suggestions from code review
tk-o 6585099
Apply PR feedback
tk-o File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
.../ensnode.io/src/content/docs/docs/integrate/unigraph/interactive-playground.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: ENSDb Interactive Playground | ||
| description: Use an interactive ENSDb playground to query the ENS Unigraph from a read-only ENSDb Snapshot. | ||
| tableOfContents: false | ||
| sidebarDocked: true | ||
| --- | ||
|
|
||
| import { LinkCard } from "@astrojs/starlight/components"; | ||
|
|
||
| Use an interactive ENSDb playground to query the [ENS Unigraph](/docs/integrate/unigraph/concepts#indexed-data-model) from a read-only [ENSDb Snapshot](/docs/integrate/integration-options/ensdb-cli). | ||
|
|
||
| <LinkCard | ||
| title="Open fullscreen view" | ||
| description="Open the ENSDb Interactive Playground in a new tab to have a fullscreen view." | ||
| href="https://ensdb-playground.ensnode.io/" | ||
| target="_blank" | ||
| /> | ||
|
|
||
| ## Get started | ||
|
|
||
| 1. Click the "_ENSDb Alpha (read-only snapshot)_" button below to connect to a read-only ENSDb Snapshot Server. | ||
|
|
||
| :::caution[This playground hosts a point-in-time snapshot, not a live ENSDb] | ||
| This interactive playground hosts a [point-in-time snapshot](/docs/integrate/integration-options/ensdb-cli) of an [ENSDb instance](/docs/services/ensdb/concepts/database-schemas#ensdb-instance), and does not expose a live ENSDb with the current state of ENS. However, it is still a convenient way to explore the ENS Unigraph data model and run some test queries without needing to deploy ENSNode in order to access your own live ENSDb instance. | ||
|
|
||
| This snapshot was taken at a single point in time from the [ENSNode Alpha `v1.16.0` hosted instance](/docs/hosted-instances#ensnode-alpha). | ||
| ::: | ||
|
|
||
| 2. Browse tables in the [ENSDb Writer Schema](/docs/services/ensdb/concepts/database-schemas#ensdb-writer-schema) (named as `alpha` in this example ENSDb instance) and the [ENSNode Schema](/docs/services/ensdb/concepts/database-schemas#ensnode-schema) (always named as `ensnode`). | ||
|
|
||
| 3. Use the "_SQL Console_" to explore possible queries against the ENS Unigraph data model. | ||
|
|
||
| 4. Use "_Schema_" to view the schema of each table, including columns and indexes. | ||
|
|
||
| :::caution[Interactive Playground Performance] | ||
|
|
||
| The interactive playground is powered by a [Drizzle Gateway](https://gateway.drizzle.team/) instance. Occasional slow query performance is a known limitation of Drizzle Gateway and is not indicative of an issue with ENSNode or the underlying ENSDb instance. If you experience this, please try again shortly. | ||
|
|
||
| ::: | ||
|
|
||
| <iframe title="ENSDb Interactive Playground" loading="lazy" src="https://ensdb-playground.ensnode.io/" width="100%" height="100%" style="min-height: 800px;" /> | ||
|
tk-o marked this conversation as resolved.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggest to also add a "card" to open this interactive playground in a fullscreen view. This would open to https://ensdb-playground.ensnode.io/ in a new tab without any iframe.
tk-o marked this conversation as resolved.
tk-o marked this conversation as resolved.
|
||
1 change: 1 addition & 0 deletions
1
docs/ensnode.io/src/content/docs/docs/integrate/unigraph/schema-reference.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.