Kv/query converter #771
Kv/query converter #771
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThis PR adds documentation for two new supported networks (Hoodi and Injective) across HyperIndex, HyperRPC, and HyperSync platforms. It introduces a new Query Conversion Guide to clarify GraphQL syntax differences between TheGraph and Envio, updates the migration guide with references to this guide, and updates sidebar navigation and the supported networks manifest. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/HyperIndex/Guides/query-conversion.md (1)
11-11: Consider tightening the phrasing on introduction.The phrase "important differences to be aware of when migrating" is slightly verbose. Consider alternatives like "important differences to note when migrating" or "important differences you should know about" for more concise writing.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/HyperIndex/Guides/query-conversion.mddocs/HyperIndex/migration-guide.mddocs/HyperRPC/hyperrpc-supported-networks.mddocs/HyperSync/hypersync-supported-networks.mdsidebarsHyperIndex.js
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/HyperIndex/migration-guide.md
- sidebarsHyperIndex.js
- docs/HyperRPC/hyperrpc-supported-networks.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-07-29T14:30:03.677Z
Learnt from: DenhamPreen
Repo: enviodev/docs PR: 673
File: docs/HyperIndex/supported-networks/chainweb-testnet-21.md:14-16
Timestamp: 2025-07-29T14:30:03.677Z
Learning: Chainweb Testnet 20 (ID: 5920) and Chainweb Testnet 21 (ID: 5921) have non-functional HyperSync endpoints that return HTTP 404, indicating these networks are not properly supported and should be removed from documentation.
Applied to files:
docs/HyperSync/hypersync-supported-networks.md
🪛 LanguageTool
docs/HyperIndex/Guides/query-conversion.md
[style] ~11-~11: To make your writing concise, consider an alternative.
Context: ...there are some important differences to be aware of when migrating. This guide covers all ...
(AWARE_OF)
[grammar] ~26-~26: Ensure spelling is correct
Context: ...exer. This allows you to continue using TheGraph query syntax without making any changes...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~311-~311: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 5081 characters long)
Context: ..., BigDecimal|String, numeric|$id: ID!→$id: String!` | --- ## Getting Help If you encoun...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
docs/HyperSync/hypersync-supported-networks.md
95-95: Bare URL used
(MD034, no-bare-urls)
95-95: Bare URL used
(MD034, no-bare-urls)
96-96: Bare URL used
(MD034, no-bare-urls)
96-96: Bare URL used
(MD034, no-bare-urls)
97-97: Bare URL used
(MD034, no-bare-urls)
97-97: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (10)
docs/HyperIndex/Guides/query-conversion.md (9)
15-32: Converter tool section is well-structured and informative.The section effectively introduces the converter tool, provides repository access, explains the hosted endpoint option for dedicated tier users, and includes appropriate beta warnings with issue reporting links. Clear and actionable guidance for users.
36-79: Entity name conversion rules are clear with practical examples.The examples effectively demonstrate the conversion from TheGraph's pluralized camelCase (pools, factories, tokens) to Envio's singular PascalCase (Pool, Factory, Token), including both the
_by_pksyntax andwhereclause alternatives. This gives users flexibility in how they structure their queries.
81-117: Pagination parameter conversions are accurate and well-documented.The
first→limitandskip→offsetconversions are correctly described with clear examples. The distinction between the two approaches is helpful for migration.
119-139: Ordering syntax consolidation is correctly explained.The consolidation of separate
orderByandorderDirectionparameters into a singleorder_by: {field: direction}object is accurately documented with examples for both ascending and descending order.
141-189: Filter operators section provides comprehensive conversion mappings.The equality, comparison, and negation operators are thoroughly covered with correct mappings:
field: value→field: {_eq: value}_not,_not_in→_neq,_nin- Comparison operators (
_gt,_gte,_lt,_lte,_in) correctly preservedThe examples are practical and demonstrate the nesting structure clearly.
191-223: String filter conversions are accurate with proper wildcard usage.The mapping of TheGraph's string operators to Envio's
_ilikewith wildcard patterns is correctly documented:
_contains→_ilike: "%text%"_starts_with→_ilike: "text%"_ends_with→_ilike: "%text"- Negations using
_notwrapper are correctly shownThe examples cover both case-sensitive and case-insensitive variations. Well structured.
225-297: Variable type conversions are comprehensive and accurate.The mappings correctly specify the type system changes:
ID→StringBytes→StringBigInt→numericBigDecimal→numericEach conversion includes practical query examples showing the parameter usage in context. The distinction between required (
!) and optional types is preserved in the examples.
301-311: Summary table provides excellent quick reference.The summary table effectively condenses all conversion rules into an easy-to-scan format with category, TheGraph syntax, Envio syntax, and examples. Users can quickly locate relevant conversions without reading the full sections.
315-320: Getting Help section provides clear support pathways.Directs users to file GitHub issues for converter-specific problems and Discord for general questions. Appropriate triage and clear call-to-action links.
docs/HyperSync/hypersync-supported-networks.md (1)
95-95: The bare URL linting concern applies to the entire table, not just these new entries.Lines 95 (Hoodi) and 97 (Injective) follow the identical URL pattern used consistently across all 87+ network entries in the table. If MD034 violations are a concern, they should be addressed project-wide, not singled out for new additions. Review the existing entries (Chiliz, Citrea Testnet, etc.) which use the same bare URL style, or confirm whether this pattern is intentionally accepted for markdown table formatting in your documentation standards.
Likely an incorrect or invalid review comment.
Added a page in the migrating to envio section on converting queries from thegraph to envio syntax. Includes info on the query converter tool.
Summary by CodeRabbit
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.