Add schema.sql file for ClickHouse tables creation (#51)

pinax-network · Jul 19, 2024 · b783672 · b783672
1 parent c435713
commit b783672
Show file tree

Hide file tree

Showing 2 changed files with 566 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -38,8 +38,8 @@
 
 ## Requirements
 
-- [ClickHouse](clickhouse.com/)
-- (Optional) A [Substream sink](https://substreams.streamingfast.io/reference-and-specs/glossary#sink) for loading data into ClickHouse. We recommend [Substreams Sink ClickHouse](https://github.com/pinax-network/substreams-sink-clickhouse/) or [Substreams Sink SQL](https://github.com/streamingfast/substreams-sink-sql). You should use the generated [`protobuf` files](tsp-output/@typespec/protobuf) to build your substream.
+- [ClickHouse](clickhouse.com/), databases should follow a `{chain}_tokens_{version}` naming scheme. Tables can be created using the [`schema.sql`](./schema.sql) definitions.
+- A [Substream sink](https://substreams.streamingfast.io/reference-and-specs/glossary#sink) for loading data into ClickHouse. We recommend [Substreams Sink ClickHouse](https://github.com/pinax-network/substreams-sink-clickhouse/) or [Substreams Sink SQL](https://github.com/streamingfast/substreams-sink-sql). You should use the generated [`protobuf` files](tsp-output/@typespec/protobuf) to build your substream. This Token API makes use of the [`substreams-antelope-tokens`](https://github.com/pinax-network/substreams-antelope-tokens/) substream.
 
 ## Quick start