From be2a66ed93761d35000dd79593e0170fd7bf034e Mon Sep 17 00:00:00 2001 From: nikbhintade <29760727+nikbhintade@users.noreply.github.com> Date: Tue, 24 Mar 2026 13:00:28 +0530 Subject: [PATCH] remove persisted_files page --- docs/HyperIndex/Advanced/persisted_files.md | 38 --------------------- docusaurus.config.js | 5 --- sidebarsHyperIndex.js | 1 - 3 files changed, 44 deletions(-) delete mode 100644 docs/HyperIndex/Advanced/persisted_files.md diff --git a/docs/HyperIndex/Advanced/persisted_files.md b/docs/HyperIndex/Advanced/persisted_files.md deleted file mode 100644 index fd0afa5b..00000000 --- a/docs/HyperIndex/Advanced/persisted_files.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: persisted-files -title: Persisted File Changes -sidebar_label: Persisted File Changes -slug: /persisted_files -description: Learn how Envio manages file changes to optimize indexing and re-sync sequences efficiently. ---- - -# Persisted File Changes - -In Envio, users define four distinct files that dictate the behavior of the indexer: - -- Configuration file (`config.yaml`) -- Smart Contract ABI (`contractName.json`) -- Schema (`schema.graphql`) -- Event Handlers (`EventHandlers.\*`) - -Envio employs these files to automatically generate and execute the indexing logic. - -To enhance user experience and optimize the re-syncing of historical blocks, the indexer identifies the most efficient rerun sequence when any of the above files are modified. - -## Rerun sequences - -**1. Re-generate All Indexing Code and Re-sync from RPC Nodes:** - -Triggered only when the indexing logic needs regeneration due to changes in the configuration file or smart contract ABI. - -**2. Re-generate All Indexing Code and Re-sync from Stored Raw Events:** - -Activated when the schema is updated but neither the configuration nor smart contract ABI has changed. This allows for faster re-syncing using previously collected event data. - -**3. Re-sync from Stored Events:** - -Executed when only the event handlers are updated. Utilizes existing event data for re-syncing. - -**4. Continue Syncing from RPC Nodes:** - -Runs when there are no modifications in any of the user-defined files mentioned above. diff --git a/docusaurus.config.js b/docusaurus.config.js index 70386585..778697cd 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -115,10 +115,6 @@ const redirectsList = [ from: "/docs/rpc-sync", to: "/docs/HyperIndex/rpc-sync", }, - { - from: "/docs/persisted_files", - to: "/docs/HyperIndex/persisted_files", - }, { from: "/docs/generated-files", to: "/docs/HyperIndex/generated-files", @@ -430,7 +426,6 @@ This file contains links to documentation sections following the llmstxt.org sta - [Historical Sync](https://docs.envio.dev/docs/HyperIndex/historical-sync.md): Learn how to optimize historical sync with HyperIndex for fast and efficient data retrieval. - [Performance Optimization](https://docs.envio.dev/docs/HyperIndex/performance.md): Learn how to optimize HyperIndex performance for syncing, indexing, and querying data. - [Understanding Chain Head Latency](https://docs.envio.dev/docs/HyperIndex/latency-at-head.md): Learn how Envio keeps blockchain indexers updated with low latency and reliable multi-chain sync. -- [Persisted File Changes](https://docs.envio.dev/docs/HyperIndex/persisted_files.md): Learn how Envio manages file changes to optimize indexing and re-sync sequences efficiently. - [Preload Optimization](https://docs.envio.dev/docs/HyperIndex/preload-optimization.md): Learn how preload optimization improves event handlers with batched reads and parallel external calls. - [Query Conversion Guide](https://docs.envio.dev/docs/HyperIndex/query-conversion.md): Learn how to convert queries from TheGraph's custom GraphQL syntax to Envio's standard GraphQL syntax. - [Chain Reorganization Support](https://docs.envio.dev/docs/HyperIndex/reorgs-support.md): Learn how to handle chain reorgs and keep your indexed data consistent. diff --git a/sidebarsHyperIndex.js b/sidebarsHyperIndex.js index 0a155de0..bd16b40d 100644 --- a/sidebarsHyperIndex.js +++ b/sidebarsHyperIndex.js @@ -118,7 +118,6 @@ module.exports = { "Advanced/config-schema-reference", "Guides/cli-commands", "Advanced/reorgs-support", - // "Advanced/persisted-files", "Advanced/generated-files", "Advanced/metadata-query", "Advanced/terminology",