portalSqliteCache - SQD Documentation

Create SQLite cache for Portal responses. Use with evmPortalStream to cache Portal API responses locally.

portalSqliteCache(config: { path: string; compress?: boolean }): PortalCache

Parameters:

path: Path to the SQLite database file. The parent directory is created if it does not exist.
compress: Compress cached responses with zstd. Defaults to true.

Example:

import { portalSqliteCache } from "@subsquid/pipes/portal-cache/node";
import { evmEventDecoder, evmPortalStream } from "@subsquid/pipes/evm";

const source = evmPortalStream({
  id: "cached-pipe",
  portal: "https://portal.sqd.dev/datasets/ethereum-mainnet",
  outputs: evmEventDecoder({ range: { from: 0 }, events: {} }),
  cache: portalSqliteCache({ path: "./cache.sqlite" }),
});

Import from @subsquid/pipes/portal-cache/node instead of @subsquid/pipes/portal-cache.

When to Use

Development iteration
Testing pipelines
Repeated processing of same block ranges.

Related topics

portalSqliteCache Pipes SDK 1.0 A prod-ready pipe Stateful transforms Bitcoin portal stream

⌘I