Skip to content

Commit

Permalink
Removing/replacing the "link out of date" notices
Browse files Browse the repository at this point in the history
	modified:   docs/sdk/resources/basics/batch-processing.md
	modified:   docs/sdk/tutorials/file-csv.md
	modified:   docs/sdk/tutorials/file-parquet.md
  • Loading branch information
abernatskiy committed Dec 17, 2023
1 parent 1264e2e commit fd190da
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/sdk/resources/basics/batch-processing.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ For a full implementation of the above pattern, see [EVM squid example](https://

## Anti-patterns

Avoid loading or persisting single entities unless strictly necessary. For example, here is a possible antipattern for the [Gravatar example](https://github.com/subsquid/gravatar-squid) (link out of date):
Avoid loading or persisting single entities unless strictly necessary. For example, here is a possible antipattern for the [Gravatar example](https://github.com/subsquid/gravatar-squid):

```ts
processor.run(new TypeormDatabase(), async (ctx) => {
Expand Down
12 changes: 8 additions & 4 deletions docs/sdk/tutorials/file-csv.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,14 @@ File-based data formats like CSV are convenient for data analysis, especially in

We chose MATIC transactions on Ethereum mainnet for this example. This selection provides enough data to highlight the performance of the Subsquid framework and is interesting from a data analysis standpoint.

An article about this demo project [has been published on Medium](https://link.medium.com/1NPC1S2czxb). The project source code can be found [in this repository on GitHub](https://github.com/RaekwonIII/local-csv-indexing) (link out of date).
An article about this demo project [has been published on Medium](https://link.medium.com/1NPC1S2czxb). The project source code can be found in the [`local-csv-indexing` repository](https://github.com/subsquid-labs/local-csv-indexing).

[//]: # (!!!! Update all github URLs)

:::warning
As of 2023-12-17, the `local-csv-indexing` repo is mostly still sound, but already somewhat outdated. You can take a look at the less sophisticated, yet regularly updated example [here](https://github.com/subsquid-labs/file-store-csv-example).
:::

## Pre-requisites

- [Subsquid CLI](/squid-cli/installation)
Expand All @@ -35,9 +39,9 @@ sqd init local-csv-indexing -t evm
Here, `local-csv-indexing` is the name of the project, and can be changed to anything else. The `-t evm` option specifies that the [`evm` template](https://github.com/subsquid-labs/squid-evm-template) should be used as a starting point.

:::info
**Note:** The template actually has more than what we need for this project. Unnecessary packages have been removed in the tutorial repository. You can grab [`package.json`](https://github.com/RaekwonIII/local-csv-indexing/blob/main/package.json) (link out of date) from there to do the same.
**Note:** The template actually has more than what we need for this project. Unnecessary packages have been removed in the tutorial repository. You can grab [`package.json`](https://github.com/subsquid-labs/local-csv-indexing/blob/main/package.json) from there to do the same.

Files-wise, `docker-compose.yml`, `schema.graphql` and `squid.yaml` were removed. `commands.json`, the list of local `sqd` scripts, has been significantly shortened ([here is the updated version](https://github.com/RaekwonIII/local-csv-indexing/blob/main/commands.json) (link out of date)).
Files-wise, `docker-compose.yml`, `schema.graphql` and `squid.yaml` were removed. `commands.json`, the list of local `sqd` scripts, has been significantly shortened ([here is the updated version](https://github.com/subsquid-labs/local-csv-indexing/blob/main/commands.json)).
:::

### ERC-20 token ABI
Expand Down Expand Up @@ -198,7 +202,7 @@ And in a few minutes, a few sub-folders (whose names are the block ranges where
### Data analysis with Python
If you want to learn how to analyze this data using Python and Pandas, refer to [the Medium article dedicated to this demo project](https://link.medium.com/1NPC1S2czxb), or consult the [project's repository on GitHub](https://github.com/RaekwonIII/local-csv-indexing).
If you want to learn how to analyze this data using Python and Pandas, refer to [the Medium article dedicated to this demo project](https://link.medium.com/1NPC1S2czxb), or consult the [project's repository on GitHub](https://github.com/subsquid-labs/local-csv-indexing/local-csv-indexing).
## Conclusions
Expand Down
12 changes: 8 additions & 4 deletions docs/sdk/tutorials/file-parquet.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ In contrast, the Parquet format is designed for efficient read/write operations

The subject of this tutorial is the Uniswap DApp, namely the data from its pool contracts and positions held by investors. Uniswap was chosen because it generates a very large amount of information, and ultimately this helps to better show how to leverage a more performance-oriented format.

An article about this demo project [has been published on Medium](https://link.medium.com/7gU0BrLbDxb). The project source code can be found [in this repository on GitHub](https://github.com/subsquid-labs/squid-parquet-storage) (link out of date).
An article about this demo project [has been published on Medium](https://link.medium.com/7gU0BrLbDxb). The project source code can be found in the [`squid-parquet-storage` repo](https://github.com/subsquid-labs/squid-parquet-storage).

:::warning
As of 2023-12-17, the `squid-parquet-storage` repo is mostly still sound, but already somewhat outdated. You can take a look at the less sophisticated, yet regularly updated example [here](https://github.com/subsquid-labs/file-store-parquet-example/).
:::

[//]: # (!!!! Update all github URLs)
[//]: # (!!!! Update all outdated benchmark figures "figure/figures out of date")
Expand All @@ -39,9 +43,9 @@ sqd init local-parquet-indexing -t evm
Here, `local-parquet-indexing` is the name of the project, and can be changed to anything else. The `-t evm` option specifies that the [`evm` template](https://github.com/subsquid-labs/squid-evm-template) should be used as a starting point.

:::info
**Note:** The template actually has more than what we need for this project. Unnecessary packages have been removed in the tutorial repository. You can grab [`package.json`](https://github.com/subsquid-labs/squid-parquet-storage/blob/main/package.json) (link out of date) from there to do the same.
**Note:** The template actually has more than what we need for this project. Unnecessary packages have been removed in the tutorial repository. You can grab [`package.json`](https://github.com/subsquid-labs/squid-parquet-storage/blob/main/package.json) from there to do the same.

Files-wise, `docker-compose.yml`, `schema.graphql` and `squid.yaml` were removed. `commands.json`, the list of local `sqd` scripts, has been significantly shortened ([here is the updated version](https://github.com/subsquid-labs/squid-parquet-storage/blob/main/commands.json) (link out of date)).
Files-wise, `docker-compose.yml`, `schema.graphql` and `squid.yaml` were removed. `commands.json`, the list of local `sqd` scripts, has been significantly shortened ([here is the updated version](https://github.com/subsquid-labs/squid-parquet-storage/blob/main/commands.json)).
:::

Finally, make sure to install the dependencies:
Expand Down Expand Up @@ -272,7 +276,7 @@ For a brief explanation of what [`processFactory`](https://github.com/subsquid-l

* writes the decoded information to the corresponding table (parquet file)

To better understand how data is transformed, and how the other functions are defined as well, it's advised to [browse the repository](https://github.com/subsquid-labs/squid-parquet-storage/tree/main/src/mappings) (link out of date) and inspect the code. Be sure to check the [`utils`](https://github.com/subsquid-labs/squid-parquet-storage/tree/main/src/utils) (link out of date) folder as well, as there are some auxiliary files and functions used in the mapping logic.
To better understand how data is transformed, and how the other functions are defined as well, it's advised to [browse the repository](https://github.com/subsquid-labs/squid-parquet-storage/tree/main/src/mappings) and inspect the code. Be sure to check the [`utils`](https://github.com/subsquid-labs/squid-parquet-storage/tree/main/src/utils) folder as well, as there are some auxiliary files and functions used in the mapping logic.

### Launch the project

Expand Down

0 comments on commit fd190da

Please sign in to comment.