Docs: Expand ClickHouse storage and new CLI commands by DZakh · Pull Request #919 · enviodev/docs

DZakh · 2026-05-15T13:59:08Z

Summary

Updated documentation for HyperIndex v3 to clarify ClickHouse storage configuration with per-entity routing, document new CLI commands, and improve migration guidance.

Key Changes

ClickHouse Storage Documentation

Added explicit @storage directive examples in schema.graphql showing how to route entities to specific backends (Postgres, ClickHouse, or both)
Clarified that per-entity routing is required when using multiple backends
Updated envio dev description to mention playground-friendly defaults for local ClickHouse development
Added documentation for two new environment variables:
- ENVIO_CLICKHOUSE_REPLICATED — for replicated table engines
- ENVIO_CLICKHOUSE_DATABASE_ENGINE — for custom database engine overrides
Separated Envio Cloud support note (Dedicated Plan only)

New CLI Commands

Documented envio skills update command for pulling latest Claude/Cursor skills
Documented envio config view command (experimental) for inspecting resolved configuration as JSON
Added note about improved TypeScript error messages suggesting envio codegen

TUI Improvements

Added mention of new events-per-second indicator during backfill

Migration Guide Updates

Removed outdated ClickHouse storage configuration step (now handled via @storage directive)
Added Step 10 for updating agent skills post-migration
Updated migration checklist to remove ClickHouse config item and add agent skills step
Added v3.0.0-rc.1 release notes link

Config Schema Reference

Updated storage section with @storage directive example and explanation of per-entity routing requirement

https://claude.ai/code/session_01Ay4KiB1LYZTtSzLCqRrKwd

Summary by CodeRabbit

Documentation
- Updated storage configuration documentation with per-entity routing examples for Postgres and ClickHouse backends
- Added migration step for updating agent skills via pnpx envio skills update
- Enhanced TUI with events-per-second indicator during backfill
- Introduced new commands documentation for agent skills and config viewing
- Updated environment variable naming (ENVIO_TUI replacing legacy TUI_OFF)
- Added ClickHouse high-availability configuration variables

Update What's New in V3 and Migrate to V3 with rc.1 changes: - ClickHouse: require per-entity @storage directive in schema.graphql, document ENVIO_CLICKHOUSE_REPLICATED/ENVIO_CLICKHOUSE_DATABASE_ENGINE, note password-free playground defaults for envio dev - New envio CLI commands: skills update and config view (experimental) - TUI events-per-second indicator during backfill - Improved TS error suggesting envio codegen when types are missing - TestIndexer getWhere FK column filtering fix Add Step 10 to the migration flow to run envio skills update at the end.

- Drop ClickHouse section from Migrate to V3 (V2 had no ClickHouse support) - Note that envio skills update populates .claude/skills consumed by Claude, Cursor, and other agentic tooling - ClickHouse @storage example: omit redundant postgres: false and add comments clarifying per-entity routing - Drop Hasura mention from ClickHouse section; split Envio Cloud Dedicated Plan availability into its own paragraph - Frame replication env vars under high-availability ClickHouse setups - Drop TestIndexer FK column filtering bug fix from the changelog

vercel · 2026-05-15T13:59:15Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
envio-docs	Ready	Preview, Comment	May 15, 2026 2:01pm

coderabbitai · 2026-05-15T13:59:47Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ca4c2138-8685-4b8c-9ffa-5414dde45ace

📥 Commits

Reviewing files that changed from the base of the PR and between 2f3e193 and 532cea6.

📒 Files selected for processing (3)

docs/HyperIndex/Advanced/config-schema-reference.md
docs/HyperIndex/migrate-to-v3.md
docs/HyperIndex/whats-new-in-v3.md

📝 Walkthrough

Walkthrough

Documentation updates for HyperIndex v3 including multi-backend storage routing via per-entity @storage directives, removal of deprecated ClickHouse configuration steps, addition of agent skills migration guidance, TUI improvements with events-per-second metrics, and new command documentation for envio skills update and envio config view.

Changes

HyperIndex v3 Features and Migration Documentation

Layer / File(s)	Summary
Multi-backend storage routing documentation `docs/HyperIndex/Advanced/config-schema-reference.md`, `docs/HyperIndex/whats-new-in-v3.md`	Expanded storage section documentation with `@storage` directive examples, ClickHouse high-availability environment variables, and per-entity routing patterns for Postgres and ClickHouse backends.
Migration guide storage updates `docs/HyperIndex/migrate-to-v3.md`	Removed "Optional: ClickHouse storage" subsection from Step 4 and corresponding migration checklist item, reflecting transition to per-entity `@storage` routing.
Agent skills migration step `docs/HyperIndex/migrate-to-v3.md`	Added Step 10 describing agent skills update via `pnpx envio skills update` command with matching checklist item for `.claude/skills` refresh.
TUI improvements and new command documentation `docs/HyperIndex/whats-new-in-v3.md`	Extended TUI improvements with events-per-second backfill indicator, documented auto-disable in CI/AI environments, added documentation for `envio skills update` and `envio config view` (experimental) commands, and added v3.0.0-rc.1 to release notes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related issues

enviodev/hyperindex#1209: Docs updates about enabling multiple backends and per-entity @storage routing directly relate to ClickHouse compatibility and storage: { postgres: true, clickhouse: true } configuration.
enviodev/effects-api#1: Main issue docs updates describe features announced in the HyperIndex v3 release including per-entity routing and ClickHouse configuration.

Possibly related PRs

enviodev/docs#898: Updates HyperIndex v3 documentation around ClickHouse Storage configuration, @storage routing, and TUI environment variable renaming (TUI_OFF → ENVIO_TUI=false) in migration guides.
enviodev/docs#687: Introduced the config-schema documentation page that this PR updates with expanded storage section and schema.graphql routing examples.
enviodev/docs#902: Updates ClickHouse storage documentation around schema.graphql and @storage entity routing patterns.

Suggested reviewers

nikbhintade
keenbeen32

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Docs: Expand ClickHouse storage and new CLI commands' directly and accurately summarizes the main changes in the pull request, which include expanded ClickHouse storage documentation with per-entity routing examples and documentation of new CLI commands.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

claude added 2 commits May 15, 2026 13:47

moose-code approved these changes May 15, 2026

View reviewed changes

vercel Bot deployed to Preview May 15, 2026 14:01 View deployment

DZakh merged commit 6ccc00f into main May 15, 2026
3 checks passed

DZakh deleted the claude/migrate-to-v3-clickhouse-tChGj branch May 15, 2026 14:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: Expand ClickHouse storage and new CLI commands#919

Docs: Expand ClickHouse storage and new CLI commands#919
DZakh merged 2 commits into
mainfrom
claude/migrate-to-v3-clickhouse-tChGj

DZakh commented May 15, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented May 15, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 15, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related issues

Possibly related PRs

Suggested reviewers

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

DZakh commented May 15, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Key Changes

ClickHouse Storage Documentation

New CLI Commands

TUI Improvements

Migration Guide Updates

Config Schema Reference

Summary by CodeRabbit

Uh oh!

vercel Bot commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related issues

Possibly related PRs

Suggested reviewers

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

DZakh commented May 15, 2026 •

edited by coderabbitai Bot

Loading

vercel Bot commented May 15, 2026 •

edited

Loading

coderabbitai Bot commented May 15, 2026 •

edited

Loading