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 (490 forks)batch import
Embedded Replicasenhancementhelp wantedquestion

Repository metrics

Stars
 (16,744 stars)
PR merge metrics
 (Avg merge 23h 19m) (1 merged PR in 30d)

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

Research direction
Review the current API in the Rust client, implement new methods with remote sync() and with file sync(), and rename new remote replica() to new remote() and new local replica() to new local(). Ensure backward compatibility or update all usages.
Tech stack
rustsql
Domain
database
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95