Practical overview
When it fits
Use it when you can operate a Substrate-based chain with RocksDB and archive pruning and want its indexed records in PostgreSQL for further analysis.
Who it is for
- Operators who need a self-hosted PostgreSQL record of data from a Substrate-based chain.
- Developers and analysts building database-backed querying or analysis on indexed chain records.
Documented uses
- Index blocks, state and extrinsics from a running Substrate chain into PostgreSQL.
- Build a historical data store for downstream querying and chain analysis.
Requirements & limits
- The chain must use RocksDB and run with
--pruning=archive. - The database must be ready for substantial incoming data; the README estimates about 60 GB of free disk space depending on the chain.
- The repository identifies the project as currently unmaintained and asks users to fork it.
- The CLI is designed to work without writing Rust code, but still requires PostgreSQL setup and configuration-file changes.
- The project is licensed under GPL-3.0.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Start the Polkadot archive indexer
Use the documented quick-start sequence to launch the Polkadot node with archive pruning and start the Substrate Archive CLI.
Before you start
- A Substrate-based blockchain using RocksDB and running with archive pruning.
- PostgreSQL with a database ready to receive substantial data.
- About 60 GB of free disk space, depending on the chain.
- A cloned Substrate Archive repository and a configured CLI file.
Steps
Clone the repository and use its database setup script as a convenience helper; consult the wiki for complete database setup.
Change to the Polkadot archive CLI directory.
Start the Polkadot node with
polkadot --chain=polkadot --pruning=archive.Start the indexer with the command below.
cargo run --release -- -c test_conf.toml --chain=polkadot
Expected outcome
The documented sequence starts a Polkadot node configured for archive pruning and launches the Substrate Archive CLI to index chain data into PostgreSQL.
Guide limitations
- The database setup scripts are not intended to be complete.
- The repository says the project is currently unmaintained and invites users to fork it.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 15 October 2026
- Original website title
- paritytech/substrate-archive · Official homepage title · retained in its source language

