electric-sql/electric

Feature request: document why a shape handle might get deleted

Open

#2,680 创建于 2025年5月6日

在 GitHub 查看
 (1 评论) (1 反应) (0 负责人)Elixir (10,155 star) (329 fork)batch import
documentationgood first issuehelp wanted

描述

Is your feature request related to a problem? Please describe. People wonder why shapes get deleted. Especially if they have very large shapes as recreating and reloading them into clients can get expensive.

If they understand why it's happening, they might be able to reduce how often shapes are recreated by e.g. preserving their shapes logs when restarting their Electric instance.

Describe the solution you'd like Document the reasons for shape deletions:

  1. the server is restarted and loses all its shape logs
  2. pg has an error of some sort that isn't recoverable so electric deletes all the shapes
  3. probably most common, there's a schema change to the table the shape uses so the log is missing the new data

贡献者指南

技术栈
elixirpostgresql
领域
documentationdatabase
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic understanding of Electric syncFamiliarity with PostgreSQL schema changes
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
Review the Electric source code to confirm the three reasons for shape deletions listed in the issue. Look at the shape management module (likely in lib/electric/shape.ex) to understand how shape handles are deleted. Also examine the documentation structure to decide where to add the new section, such as in a troubleshooting or FAQ page. Consider checking existing documentation for any related concepts.
Feature request: document why a shape handle might get deleted · electric-sql/electric#2680 | Good First Issue