diff --git a/docs/run_publish/run.md b/docs/run_publish/run.md index 359dee14fb8..92136ba72a9 100644 --- a/docs/run_publish/run.md +++ b/docs/run_publish/run.md @@ -23,7 +23,7 @@ It may take some time to download the required packages ([`@subql/node`](https:/ Requirements: -- [Postgres](https://www.postgresql.org/) database (version 12 or higher). While the [SubQuery node](run.md#start-a-local-subquery-node) is indexing the blockchain, the extracted data is stored in an external database instance. +- [Postgres](https://www.postgresql.org/) database (version 16 or higher). While the [SubQuery node](run.md#start-a-local-subquery-node) is indexing the blockchain, the extracted data is stored in an external database instance. A SubQuery node is an implementation that extracts Substrate/Polkadot-based blockchain data per the SubQuery project and saves it into a Postgres database. @@ -45,32 +45,46 @@ CREATE EXTENSION IF NOT EXISTS btree_gist; npm install -g @subql/node ``` -@tab Terra +@tab EVM ```shell # NPM -npm install -g @subql/node-terra +npm install -g @subql/node-ethereum ``` -@tab Avalanche +@tab Cosmos ```shell # NPM -npm install -g @subql/node-avalanche +npm install -g @subql/node-cosmos ``` -@tab Cosmos +@tab Algorand ```shell # NPM -npm install -g @subql/node-cosmos +npm install -g @subql/node-algorand ``` -@tab Algorand +@tab Near ```shell # NPM -npm install -g @subql/node-algorand +npm install -g @subql/node-near +``` + +@tab stellar + +```shell +# NPM +npm install -g @subql/node-stellar +``` + +@tab Concordium + +```shell +# NPM +npm install -g @subql/node-concordium ``` ::: @@ -88,16 +102,10 @@ Once installed, you can start a node with the following command: subql-node ``` -@tab Terra - -```shell -subql-node-terra -``` - -@tab Avalanche +@tab EVM ```shell -subql-node-avalanche +subql-node-ethereum ``` @tab Cosmos @@ -112,6 +120,24 @@ subql-node-cosmos subql-node-algorand ``` +@tab Near + +```shell +subql-node-near +``` + +@tab Stellar + +```shell +subql-node-stellar +``` + +@tab Concordium + +```shell +subql-node-concordium +``` + ::: ### Key Commands @@ -128,16 +154,10 @@ To find out more, you can always run `--help`. subql-node -f your-project-path ``` -@tab Terra +@tab EVM ```shell -subql-node-terra -f your-project-path -``` - -@tab Avalanche - -```shell -subql-node-avalanche -f your-project-path +subql-node-ethereum -f your-project-path ``` @tab Cosmos @@ -152,6 +172,24 @@ subql-node-cosmos -f your-project-path subql-node-algorand -f your-project-path ``` +@tab Near + +```shell +subql-node-near -f your-project-path +``` + +@tab Stellar + +```shell +subql-node-stellar -f your-project-path +``` + +@tab Concordium + +```shell +subql-node-concordium -f your-project-path +``` + ::: #### Connect to database @@ -223,12 +261,17 @@ This will point the query node to a manifest file which can be in TS, YAML or JS subql-node -f your-project-path --batch-size 200 Result: -[IndexerManager] fetch block [203, 402] -[IndexerManager] fetch block [403, 602] + INFO Enqueueing blocks 203...402, total 200 blocks + INFO Enqueueing blocks 403...602, total 200 blocks ``` When the indexer first indexes the chain, fetching single blocks will significantly decrease the performance. Increasing the batch size to adjust the number of blocks fetched will decrease the overall processing time. The current default batch size is 100. + +::: tip Note +SubQuery uses Node.js, by default this will use 4GB of memory. If you are running into memory issues or wish to get the most performance out of indexing you can increase the memory that will be used by setting the following environment variable `export NODE_OPTIONS=--max_old_space_size=`. It's best to make sure this only applies to the node and not the query service. +::: + #### Check your node health There are 2 endpoints that you can use to check and monitor the health of a running SubQuery node.