tursodatabase / tursodatabase/libsql

Improve database connection builder API?

Open
#1,635 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Embedded Replicas enhancement help wanted question
Dominant language
C
Stars
17.2k
Forks
531
Avg merge
1h 12m
Merged PRs (30d)
1

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the database connection builder definitions and tests for new_remote_replica() and new_local_replica(). Review how the existing replica variants are synchronized, then verify that the proposed names and with_remote_sync() and with_file_sync() methods are reflected consistently in the public API and its tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
sqlite
Domain
api, databases
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.