Skip to content

Add ObjectBox Sync #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
greenrobot wants to merge 37 commits into
base: main
Choose a base branch
from
Open

Add ObjectBox Sync #28

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
a9edd55
start implement sync client
Dec 22, 2025
bf41581
Fix type error, add obx_sync_state call in SyncClient
Dec 23, 2025
dabc331
Upgrade to OBX 5.0.0, download Sync version of C library only (tempor…
Dec 23, 2025
50d3cb0
Add login, connection and error listeners
Dec 24, 2025
7b86cfc
Add methods for filter variables
Dec 25, 2025
9a0d951
Add method for outgoing message count
Dec 25, 2025
7bf29d4
Add method for setting multiple credentials
Dec 25, 2025
7aacc1a
Remove credentials for SyncClient constructor in test_sync_client_states
Dec 25, 2025
5a3bf3e
Notify Sync client when underlying Store is closed
Dec 25, 2025
978a9a9
Add Sync class with static factory methods to construct SyncClient
Dec 25, 2025
b75bb85
Remove .values() from Store.py when invoking store close listeners
Dec 25, 2025
b59e786
Check Sync available when constructing SyncClient instance
Dec 25, 2025
04d5a36
Add filter variables when creating an instance of SyncClient
Dec 25, 2025
7be070b
Add requestUpdates() and cancelUpdates() methods
Dec 28, 2025
66f708b
add pre-check for sync client ptr not null
Dec 28, 2025
e70fa2e
Allow building different package for OBX Sync
Dec 30, 2025
8d6023c
Set version to 5.0.0 in package's __init__.py
Dec 30, 2025
1ba8f16
Allow adding entity flags for Sync
Dec 31, 2025
ea8db2e
Document C functions in c.py
Dec 31, 2025
baf6d9c
Document classes/methods in sync.py
Dec 31, 2025
37bee34
Add change listener to notify client on incoming changes
Jan 1, 2026
0d165b6
Add new method enable_sync() in _Entity
Jan 4, 2026
58a7fa0
Override SyncClient's destructor to call close(), to avoid resource l…
Jan 4, 2026
0bce2d8
Suffix listener function types with '_t' to indicate that they are 't…
Jan 4, 2026
810c5e9
Increment versions in test_basics.py to make sure test_version() pass…
Jan 15, 2026
98ba442
Test with live Sync server
Jan 17, 2026
fcc159c
Enable Sync testing in GitLab CI
Jan 17, 2026
ff008ee
Skip test_entity_attribute_methods_nameclash_check test
Jan 17, 2026
0fc7774
Use typing.Union to avoid build failures in Python version < 3.10
Jan 17, 2026
873f639
Use typing.Union to avoid build failures in Python version < 3.10
Jan 17, 2026
198be4f
Fix action for --runsync flag
Jan 17, 2026
e07a05e
Avoid using os.getuid() for Windows
Jan 17, 2026
c93a93a
Remove unnecessary sync_client.close() in test_sync_listener
Jan 25, 2026
330fc74
Write lastRelationId to model JSON
Jan 25, 2026
3fd1e91
Get more output from pytest
Jan 25, 2026
e1b5cc4
Download Sync server executable from artifacts
Jan 25, 2026
8bfc35c
Avoid testing against Python 3.7 on ubuntu-latest runner
Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Upgrade to OBX 5.0.0, download Sync version of C library only (tempor… 
…arily)
  • Loading branch information
Shubham
Shubham committed Dec 23, 2025
commit dabc331fde03d16da9ec016a01ce39a5bff3c4dc
6 changes: 3 additions & 3 deletions download-c-lib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
# Script used to download objectbox-c shared libraries for all supported platforms. Execute by running `make get-lib`
# on first checkout of this repo and any time after changing the objectbox-c lib version.

version = "v4.0.0" # see objectbox/c.py required_version
variant = 'objectbox' # or 'objectbox-sync'
version = "v5.0.0" # see objectbox/c.py required_version
variant = 'objectbox-sync' # or 'objectbox-sync'

base_url = "https://github.com/objectbox/objectbox-c/releases/download/"

Expand All @@ -21,7 +21,7 @@
"x86_64/libobjectbox.so": "linux-x64.tar.gz",
"aarch64/libobjectbox.so": "linux-aarch64.tar.gz",
"armv7l/libobjectbox.so": "linux-armv7hf.tar.gz",
"armv6l/libobjectbox.so": "linux-armv6hf.tar.gz",
#"armv6l/libobjectbox.so": "linux-armv6hf.tar.gz",

# mac
"macos-universal/libobjectbox.dylib": "macos-universal.zip",
Expand Down
18 changes: 18 additions & 0 deletions tests/test_sync.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
from objectbox.sync import *


def test_sync_protocol_version():
version = SyncClient.protocol_version()
assert version >= 1


def test_sync_client_states(test_store):
server_urls = ["ws://localhost:9999"]
credentials = [SyncCredentials.none()]
client = SyncClient(test_store, server_urls, credentials)
assert client.get_sync_state() == SyncState.CREATED
client.start()
assert client.get_sync_state() == SyncState.STARTED
client.stop()
assert client.get_sync_state() == SyncState.STOPPED
client.close()