Skip to content

chore: deprecate in favor of the built-in substreams sink commands - #133

Draft
GabrielCartier wants to merge 1 commit into
developfrom
chore/deprecate-in-favor-of-substreams-cli
Draft

chore: deprecate in favor of the built-in substreams sink commands#133
GabrielCartier wants to merge 1 commit into
developfrom
chore/deprecate-in-favor-of-substreams-cli

Conversation

@GabrielCartier

Copy link
Copy Markdown

What

Marks this repo deprecated. The SQL sink was folded into the main substreams CLI in streamingfast/substreams#830 and shipped in v1.20.2 as substreams sink postgres / substreams sink clickhouse.

  • README: deprecation banner at the top with the old→new command mapping and a link to the upstream migration guide. Existing docs kept below for people still running the binary.
  • CHANGELOG: UnreleasedDeprecated entry.

Why lead with database compatibility

The first question an operator asks is whether they have to rebuild. They don't — cursor tables and schemas are unchanged, so the CLI resumes from the stored cursor against the same DSN. The banner says that before the command table.

Open questions for reviewers

  • Is "maintenance mode, will stop receiving releases" the wording we want, or do we want a hard EOL date?
  • Do we also want to archive the repo, add a deprecation notice to the published Docker image / brew formula, or pin an issue? Left out of this PR deliberately.
  • Draft until the #830 release is announced publicly.

The SQL sink was folded into the substreams CLI
(streamingfast/substreams#830) and ships in v1.20.2 as
`substreams sink postgres` / `substreams sink clickhouse`.

Add a deprecation banner with the command mapping and a pointer to the
upstream migration guide, plus a CHANGELOG entry. Databases are
compatible in place, so the note leads with that.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant