Add NewSyncedDatabaseConnector
#64
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Also tested this with a AWS server and the |
There was a problem hiding this comment.
Pull Request Overview
Adds a new constructor for synced connectors and refactors existing sync setup to use a unified helper with offline support.
- Introduces
NewSyncedDatabaseConnectorfor always-on syncing, with anofflinemode flag - Refactors
openEmbeddedReplicaConnectorintoopenSyncConnectorand updates C bindings to use a config struct - Extends
libsql_configin the C header with anofflinefield and updates the workflow for end-to-end testing
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| libsql.go | Added NewSyncedDatabaseConnector, refactored sync helper, and updated CGo binding to use libsql_open_sync_with_config |
| lib/include/libsql.h | Extended libsql_config with offline and added tracing API |
| .github/workflows/test.yml | Added CI steps to install libsql server and run tests on macOS and Linux |
Comments suppressed due to low confidence (2)
lib/include/libsql.h:69
- The C function
libsql_open_sync_with_configis invoked from Go but not declared in this header. Add its prototype tolibsql.hso cgo can locate and link it correctly.
int libsql_sync2(libsql_database_t db, replicated *out_replicated, const char **out_err_msg);
libsql.go:141
- There are no tests for the new offline sync path introduced by
NewSyncedDatabaseConnector. Consider adding unit or integration tests covering both online and offline modes.
func NewSyncedDatabaseConnector(dbPath string, primaryUrl string, opts ...Option) (*Connector, error) {
| return openEmbeddedReplicaConnector(dbPath, primaryUrl, authToken, readYourWrites, encryptionKey, syncInterval) | ||
| return openSyncConnector(dbPath, primaryUrl, authToken, readYourWrites, encryptionKey, syncInterval, false) | ||
| } | ||
|
|
There was a problem hiding this comment.
[nitpick] Add a Go doc comment for NewSyncedDatabaseConnector explaining its parameters, behavior, and how the offline flag differs from NewEmbeddedReplicaConnector.
Suggested change
| // NewSyncedDatabaseConnector creates a Connector for a synchronized database. | |
| // | |
| // Parameters: | |
| // - dbPath: The file path to the local database. | |
| // - primaryUrl: The URL of the primary database to synchronize with. | |
| // - opts: A variadic list of options to configure the connector (e.g., encryption key, sync interval). | |
| // | |
| // Behavior: | |
| // This function initializes a Connector that synchronizes the local database with a primary database. | |
| // It applies the provided options to configure the connector. If any errors occur during option application, | |
| // they are aggregated and returned. | |
| // | |
| // Difference from NewEmbeddedReplicaConnector: | |
| // The `offline` flag passed to `openSyncConnector` is set to `true` in this function, indicating that | |
| // the connector operates in synchronized mode. In contrast, `NewEmbeddedReplicaConnector` sets the `offline` | |
| // flag to `false`, indicating embedded replica mode. |
Copilot uses AI. Check for mistakes.
new server does not support encryption yet |
avinassh
approved these changes
May 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #60.