Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the doc on internal indexer config #15677

Merged
merged 1 commit into from
Jan 10, 2025
+26 −0
Merged

Update the doc on internal indexer config #15677

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions storage/README.md
View file
Open in desktop
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
areshand marked this conversation as resolved.
Show resolved Hide resolved
* /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.
Comment on lines +168 to +169
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two minor typos in this section:

  • configed -> configured
  • writting -> writing

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small typo: writting -> writing

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

```
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
Loading