Skip to content

Commit

Permalink
Updated documentation around substreams-sink-sql
Browse files Browse the repository at this point in the history
  • Loading branch information
maoueh committed Sep 28, 2023
1 parent 9b87d50 commit a09ef09
Show file tree
Hide file tree
Showing 6 changed files with 240 additions and 316 deletions.
3 changes: 1 addition & 2 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,9 @@
* [Substreams-powered subgraph](developers-guide/sink-targets/substreams-powered-subgraph.md)
* [Files](developers-guide/sink-targets/substreams-sink-files.md)
* [Key/value store](developers-guide/sink-targets/substreams-sink-kv.md)
* [PostgreSQL](developers-guide/sink-targets/substreams-sink-postgres.md)
* [SQL (Postgres, Clickhouse, others)](developers-guide/sink-targets/substreams-sink-sql.md)
* [Prometheus](developers-guide/sink-targets/substreams-sink-prometheus.md)
* [MongoDB](developers-guide/sink-targets/substreams-sink-mongodb.md)
* [ClickHouse](developers-guide/sink-targets/substreams-sink-clickhouse.md)
* [Custom Sink Using JavaScript](developers-guide/sink-targets/custom-sink-js.md)
* [Cookbook](developers-guide/cookbook.md)
* [Dynamic data sources](developers-guide/cookbook/dynamic-data-sources.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/developers-guide/sink-targets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ The [`substreams-eth-block-meta`](https://github.com/streamingfast/substreams-et

StreamingFast provides several tools to assist database persistence for Substreams.

* **PostgreSQL:** A command line tool to [sync a Substreams with a PosgreSQL database](https://github.com/streamingfast/substreams-sink-postgres)
* **MongoDB:** A command line tool to [sync a Substream with a MongoDB database](https://github.com/streamingfast/substreams-sink-mongodb)
* **SQL:** A command line tool to [sync a Substreams with an SQL database](https://github.com/streamingfast/substreams-sink-sql) (currently supported drivers are PostgresSQL and Clickhouse)
* **MongoDB:** A command line tool to [sync a Substreams with a MongoDB database](https://github.com/streamingfast/substreams-sink-mongodb)
* **File-based storage:** A command line tool to [sync a Substreams to file-based storage](https://github.com/streamingfast/substreams-sink-files)
* **Key-value-based storage:** A command line tool to [sync a Substreams to a key-value store](https://github.com/streamingfast/substreams-sink-kv) -- see [tutorial](substreams-sink-kv.md)

Expand All @@ -58,13 +58,13 @@ StreamingFast provides several tools to assist database persistence for Substrea
StreamingFast provides tools allowing you to route blockchain data to a few different types of data storage sinks, or means of importation. StreamingFast sink tools aren’t the only options. Existing applications, databases, and other tools are fed by blockchain data captured by Substreams.

{% hint style="success" %}
**Tip**: To get inspiration for writing your own sink study the examples provided by StreamingFast. One example is a database, such as Oracle, lacking Substreams sink tools. Study the [PostgreSQL Sink](https://github.com/streamingfast/substreams-sink-postgres) tool and its codebase to understand how to construct your own data-sinking solution.
**Tip**: To get inspiration for writing your own sink study the examples provided by StreamingFast. One example is a database, such as Oracle, lacking Substreams sink tools. Study the [SQL Sink](https://github.com/streamingfast/substreams-sink-sqk) tool and its codebase to understand how to construct your own data-sinking solution.
{% endhint %}

Protobufs are designed to use for transferring data out of Substreams into the data sink. Protobufs aren’t tied to any particular technology stack or language, enabling you to capture, further process, use and store data provided by Substreams in different capacities.

{% hint style="info" %}
**Note**: Through careful design of the Substreams manifest, modules, and protobufs you can craft your output data in a variety of ways. One option, as seen in the [PostgreSQL example](https://github.com/streamingfast/substreams-sink-postgres) is through a single `output` protobuf. The flexibility of Substreams design however allows for other strategies, including multiple protobufs and modules.
**Note**: Through careful design of the Substreams manifest, modules, and protobufs you can craft your output data in a variety of ways. One option, as seen in the [SQL example](https://github.com/streamingfast/substreams-sink-sql) is through a single `output` protobuf. The flexibility of Substreams design however allows for other strategies, including multiple protobufs and modules.
{% endhint %}

You need to examine and account for the format and any requirements of the end environment you want your data routed into. The specifics of how data is ingested by the sink determine the design of the `output` from Substreams.
92 changes: 0 additions & 92 deletions docs/developers-guide/sink-targets/substreams-sink-clickhouse.md

This file was deleted.

Loading

0 comments on commit a09ef09

Please sign in to comment.