Subgraph Best Practices 5 and 6 #825
Open
Conversation
This file contains 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
... and added links to bottom of each best practice
idalithb
reviewed
Dec 10, 2024
| @@ -100,3 +100,17 @@ Note: Declared eth_calls can only be made in subgraphs with specVersion >= 1.2.0 | |||
| ## Conclusion | |||
|
|
|||
| We can significantly improve indexing performance by minimizing or eliminating `eth_calls` in our subgraphs. | |||
There was a problem hiding this comment.
Suggested change
| We can significantly improve indexing performance by minimizing or eliminating `eth_calls` in our subgraphs. | |
| You can significantly improve indexing performance by minimizing or eliminating `eth_calls` in your subgraphs. |
|
|
||
| ## Subgraph Best Practices 1-6 | ||
|
|
||
| 1. [Improve Query Speed with Subgraph Pruning](https://thegraph.com/docs/en/cookbook/pruning/) |
There was a problem hiding this comment.
All
Suggested change
| 1. [Improve Query Speed with Subgraph Pruning](https://thegraph.com/docs/en/cookbook/pruning/) | |
| 1. [Improve Query Speed with Subgraph Pruning](/cookbook/pruning/) |
You should make this modification to all links
@benface correct me if I'm wrong here
There was a problem hiding this comment.
Links that are within the docs*
There was a problem hiding this comment.
Yes, because absolute links have the language (English) hardcoded in them, whereas relative ones keep the current language (and the href is copied over as-is to translated pages).
| @@ -71,3 +71,17 @@ This will not only make our subgraph more efficient, but it will also unlock thr | |||
| Adopting the `@derivedFrom` directive in subgraphs effectively handles dynamically growing arrays, enhancing indexing efficiency and data retrieval. | |||
There was a problem hiding this comment.
Suggested change
| Adopting the `@derivedFrom` directive in subgraphs effectively handles dynamically growing arrays, enhancing indexing efficiency and data retrieval. | |
| Use the `@derivedFrom` directive in subgraphs to effectively manage dynamically growing arrays, enhancing indexing efficiency and data retrieval. |
There was a problem hiding this comment.
I know you didn't edit this section, but adding it your PR since you edited these pages 😉
| @@ -71,3 +71,17 @@ This will not only make our subgraph more efficient, but it will also unlock thr | |||
| Adopting the `@derivedFrom` directive in subgraphs effectively handles dynamically growing arrays, enhancing indexing efficiency and data retrieval. | |||
|
|
|||
| To learn more detailed strategies to avoid large arrays, read this blog from Kevin Jones: [Best Practices in Subgraph Development: Avoiding Large Arrays](https://thegraph.com/blog/improve-subgraph-performance-avoiding-large-arrays/). | |||
There was a problem hiding this comment.
Suggested change
| To learn more detailed strategies to avoid large arrays, read this blog from Kevin Jones: [Best Practices in Subgraph Development: Avoiding Large Arrays](https://thegraph.com/blog/improve-subgraph-performance-avoiding-large-arrays/). | |
| For a more detailed explanation of strategies to avoid large arrays, check out Kevin Jones' blog: [Best Practices in Subgraph Development: Avoiding Large Arrays](https://thegraph.com/blog/improve-subgraph-performance-avoiding-large-arrays/). |
|
|
||
| ## TLDR | ||
|
|
||
| Grafting is a powerful feature in subgraph development that allows you to build and deploy new subgraphs while reusing the indexed data from existing ones. This technique is particularly useful for quickly deploying hotfixes to address critical issues without the need to re-index the entire subgraph from scratch. By preserving historical data, grafting ensures minimal downtime and maintains continuity in data services. |
There was a problem hiding this comment.
Suggested change
| Grafting is a powerful feature in subgraph development that allows you to build and deploy new subgraphs while reusing the indexed data from existing ones. This technique is particularly useful for quickly deploying hotfixes to address critical issues without the need to re-index the entire subgraph from scratch. By preserving historical data, grafting ensures minimal downtime and maintains continuity in data services. | |
| ## TLDR | |
| Grafting is a powerful feature in subgraph development that allows you to build and deploy new subgraphs while reusing the indexed data from existing ones. | |
| ### Overview | |
| This feature enables quick deployment of hotfixes for critical issues, eliminating the need to re-index the entire subgraph from scratch. By preserving historical data, grafting minimizes downtime and ensures continuity in data services. |
To break up for quick readability 😃
|
|
||
| ## Why Timeseries and Aggregations Are a Best Practice | ||
|
|
||
| 1. Improved Indexing Time • Less Data to Load: Mappings handle less data since raw data points are stored as immutable timeseries entities. • Database-Managed Aggregations: Aggregations are automatically computed by the database, reducing the workload on the mappings. |
There was a problem hiding this comment.
Spacing issue that's distorting the formatting. I think the bullet point are suppose to be below the numbers, right?
| - first | ||
| - last | ||
|
|
||
| The arg in @aggregate can be: |
There was a problem hiding this comment.
This seems like it should be a subheading
| - A field name from the timeseries entity. | ||
| - An expression using fields and constants. | ||
|
|
||
| Examples of Aggregation Expressions: |
There was a problem hiding this comment.
This also seems like a subheading
|
|
||
| ### Important Considerations | ||
|
|
||
| - Immutable Data: Timeseries data cannot be altered once written, ensuring data integrity and simplifying indexing. |
There was a problem hiding this comment.
It might be useful to place this closer to the top bc it strikes me as a warning
|
|
||
| ## How to Implement Timeseries and Aggregations | ||
|
|
||
| ### Defining Timeseries Entities |
There was a problem hiding this comment.
Is there a hierarchy to all the headings underneath? They're all level 3 headings, so just double checking 😄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added
Subgraph Best Practice 5andSubgraph Best Practice 6after peer review process was completed.Updated formatting and added links to the bottom of each Subgraph Best Practice as well to improve congruency of this cookbook series.
Thanks!