tursodatabase/libsql

Improve database connection builder API?

Open

#1,635 opened on Aug 5, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (16,744 stars) (490 forks)batch import
Embedded Replicasenhancementhelp wantedquestion

Description

The new_remote_replica() and new_local_replica() names are weird because in both cases the replica is local. The difference is just with how they are synced.

My proposal is to keep new_local() and new_remote() but add additional with_remote_sync() and with_file_sync() methods to the builder for local database variant.

Contributor guide

Tech stack
rust
Domain
developer experiencedatabase
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programmingbasics of libsql client API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Explore the Rust client SDK for libsql, specifically the database connection builder implementation. Look at the existing `new remote replica()` and `new local replica()` functions in the source code (likely in a builder module). Understand the builder pattern used and how to add methods like `with remote sync()` and `with file sync()`. Reference the issue comments for any maintainer feedback.