tursodatabase/libsql

Document replication indexes in the remote protocol

Open

#797 创建于 2023年12月18日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)C (16,744 star) (490 fork)batch import
documentationenhancementhelp wanted

描述

There's support for specifying replication index in the remote protocol, but it's currently not documented:

https://github.com/tursodatabase/libsql/blob/main/libsql-server/src/hrana/proto.rs#L16-L35

贡献者指南

技术栈
rustsql
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic Rust syntaxunderstanding of database replication
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
The issue points to a specific Rust source file (libsql server/src/hrana/proto.rs, lines 16-35) where the replication index parameter is defined but not documented. First, examine that code to understand the parameter's purpose and usage. Then, locate the relevant documentation file for the remote protocol (likely in the docs/ directory or a similar location). Add a clear description of the replication index, its behavior, and any constraints. Ensure the documentation matches the actual implementation, and consider cross referencing with related protocol documentation.