tursodatabase/libsql

Document replication indexes in the remote protocol

Open

#797 opened on Dec 18, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C (16,744 stars) (490 forks)batch import
documentationenhancementhelp wanted

Description

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

Contributor guide

Tech stack
rustsql
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Rust syntaxunderstanding of database replication
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.