README.md

Substreams Parquet sink module

substreams-sink-parquet fills Parquet file format.

Further resources

• Parquet: more than just "Turbo CSV"
• Substreams documentation
• Substreams DatabaseChanges

CLI

Use pre-built binaries

• MacOS
• Linux
• Windows

Install globally via npm

$ npm install -g substreams-sink-parquet

Schema

schema.yaml

clock:
  fields:
    id:
      type: UTF8
    number:
      type: UINT_64
    timestamp:
      type: INT_64
module:
  fields:
    type_name:
      type: UTF8
    hash:
      type: UTF8
entity_change:
  fields:
    entity:
      type: UTF8
    id:
      type: UTF8
    ordinal:
      type: UINT_64
    operation:
      type: UTF8
# <...fields>

Run

$ substreams-sink-parquet run [options] [<manifest>] <module_name>

Features

• Read schema.yaml user defined file
• Output to .parquet file binary format
• EntityChanges support
• Pkg support