Skip to content

Commit

Permalink
update the doc on internal indexer config
Browse files Browse the repository at this point in the history
  • Loading branch information
areshand committed Jan 10, 2025
1 parent 86b696d commit 4b1b3e9
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions storage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,32 @@ storage:
enable_indexer: false
```
## Internal Indexer
Internal indexer is used to provide data for the following node APIs after DB sharding.
Account based event APIs
* /accounts/{address}/events/{event_handle}/{field_name}
* /accounts/{address}/events/{creation_number}
Account based transaction API
* /accounts/{address}/transactions
Account based resource APIs
* /accounts/{address}/modules
* /accounts/{address}/resources
The internal indexer is configured as below.
The batch size is used to chunk the transactions to smaller batches before writting to internal indexer DB.
```
indexer_db_config:
enable_transaction: true // this is required for account based transaction API
enable_event: true // this is required for account based event APIs
enable_statekeys: true // this is required for account based resource APIs
batch_size: 10000
```
## Backup and Restore CLI tools
The DB backup is a concise format to preserve the raw data of the blockchain. It
Expand Down

0 comments on commit 4b1b3e9

Please sign in to comment.