ObjectBox Swift database 5.0.0

Author: greenrobot-team

CHANGELOG.md

@@ -4,7 +4,12 @@ Notable changes to the ObjectBox Swift library.
 
 For more insights into what changed in the ObjectBox C++ core, [check the ObjectBox C changelog](https://github.com/objectbox/objectbox-c/blob/main/CHANGELOG.md).
 
-## 5.0.0 - in development
+## 5.0.0 - 2025-09-29
+
+- Update ObjectBox database to version `5.0.0-2025-09-27`.
+  - ToOne relations: when deleting an object with an ID larger than the maximum 32-bit unsigned integer 
+    (`4294967295`) that is used as the target object of a ToOne, correctly re-set the target ID of the ToOne to
+    `0`. [objectbox-dart#740](https://github.com/objectbox/objectbox-dart/issues/740) 
 
 ### Sync
 

Example/NotesExample.xcodeproj/project.pbxproj

@@ -581,7 +581,7 @@
 			repositoryURL = "https://github.com/objectbox/objectbox-swift-spm";
 			requirement = {
 				kind = upToNextMajorVersion;
-				minimumVersion = 4.4.1;
+				minimumVersion = 5.0.0;
 			};
 		};
 /* End XCRemoteSwiftPackageReference section */

Source/fetch_dependencies.command

@@ -13,11 +13,11 @@ set -e
 
 # objectbox-swift release version on GitHub:
 # https://github.com/objectbox/objectbox-swift/releases/download/v${version}
-version=4.4.1
+version=5.0.0
 
 # C library version attached to the GitHub release:
 # ObjectBoxCore-static-${c_version}.zip
-c_version=4.3.1
+c_version=5.0.0
 
 # Params supported by apple-build-static-libs.sh
 if [ -n "$OBX_SKIP_STATIC_C_TESTS" ]; then

Source/ios-framework/CommonSource/Box.swift

@@ -177,7 +177,7 @@ extension Box {
     /// - Returns: List of IDs of the entities were written to.
     /// - Throws: ObjectBoxError errors for database write errors.
     @discardableResult
-    public func putAndReturnIDs <C: Collection>(_ entities: C, mode: PutMode = .put) throws
+    public func putAndReturnIDs<C: Collection>(_ entities: C, mode: PutMode = .put) throws
         -> [EntityType.EntityBindingType.IdType]
         where C.Element == EntityType {
             if entities.isEmpty {

Source/ios-framework/CommonSource/Internal/objectbox-c-sync.h

@@ -34,7 +34,7 @@
 #include "objectbox-c.h"
 
 #if defined(static_assert) || defined(__cplusplus)
-static_assert(OBX_VERSION_MAJOR == 4 && OBX_VERSION_MINOR == 3 && OBX_VERSION_PATCH == 1,  // NOLINT
+static_assert(OBX_VERSION_MAJOR == 5 && OBX_VERSION_MINOR == 0 && OBX_VERSION_PATCH == 0,  // NOLINT
               "Versions of objectbox.h and objectbox-sync.h files do not match, please update");
 #endif
 
@@ -201,6 +201,20 @@ OBX_C_API OBX_sync* obx_sync_urls(OBX_store* store, const char* server_urls[], s
 /// Stops and closes (deletes) the sync client, freeing its resources.
 OBX_C_API obx_err obx_sync_close(OBX_sync* sync);
 
+/// Adds or replaces a sync filter variable value for the given name to the sync client.
+/// Eventually existing values for the same name are replaced.
+/// Client filter variables can be used in server-side sync filters to filter out objects that do not match the filter.
+/// Filter variables must be added before login, e.g. before obx_sync_start() or setting credentials.
+/// @param name non-NULL name of the filter variable
+/// @param value non-NULL value of the filter variable
+OBX_C_API obx_err obx_sync_filter_variables_put(OBX_sync* sync, const char* name, const char* value);
+
+/// Removes a previously added sync filter variable value.
+OBX_C_API obx_err obx_sync_filter_variables_remove(OBX_sync* sync, const char* name);
+
+/// Removes all previously added sync filter variable values.
+OBX_C_API obx_err obx_sync_filter_variables_remove_all(OBX_sync* sync);
+
 /// Sets credentials to authenticate the client with the server.
 /// Any credentials that were set before are replaced;
 /// if you want to pass multiple credentials, use obx_sync_credentials_add() instead.

Source/ios-framework/CommonSource/Internal/objectbox-c.h

@@ -51,9 +51,9 @@ extern "C" {
 
 /// When using ObjectBox as a dynamic library, you should verify that a compatible version was linked using
 /// obx_version() or obx_version_is_at_least().
-#define OBX_VERSION_MAJOR 4
-#define OBX_VERSION_MINOR 3
-#define OBX_VERSION_PATCH 1  // values >= 100 are reserved for dev releases leading to the next minor/major increase
+#define OBX_VERSION_MAJOR 5
+#define OBX_VERSION_MINOR 0
+#define OBX_VERSION_PATCH 0  // values >= 100 are reserved for dev releases leading to the next minor/major increase
 
 //----------------------------------------------
 // Common types
@@ -179,6 +179,8 @@ typedef enum {
     /// This is a free trial version; only applies to server builds (no trial builds for database and Sync clients).
     OBXFeature_Trial = 18,
 
+    /// Server-side filters to return individual data for each sync user (user-specific data).
+    OBXFeature_SyncFilters = 19,
 
 } OBXFeature;
 
@@ -2121,7 +2123,7 @@ OBX_C_API obx_qb_cond obx_qb_less_or_equal_string(OBX_query_builder* builder, ob
 OBX_C_API obx_qb_cond obx_qb_in_strings(OBX_query_builder* builder, obx_schema_id property_id,
                                         const char* const values[], size_t count, bool case_sensitive);
 
-/// For OBXPropertyType_StringVector - matches if at least one vector item equals the given value.
+/// @deprecated Please use obx_qb_contains_element_string() instead.
 OBX_C_API obx_qb_cond obx_qb_any_equals_string(OBX_query_builder* builder, obx_schema_id property_id, const char* value,
                                                bool case_sensitive);
 

Source/ios-framework/CommonSource/Store.swift

@@ -43,7 +43,7 @@ public class Store: CustomDebugStringConvertible {
     internal(set) public var directoryPath: String
 
     /// The version of this ObjectBox Swift SDK.
-    public static var version = "4.4.1"
+    public static var version = "5.0.0"
 
     /// Pass this together with a String identifier as the directory path to use
     /// a file-less in-memory database.

Source/ios-framework/CommonSource/Sync/Sync.swift

@@ -25,13 +25,20 @@ public class Sync {
     ///
     /// Pass either a `url` or a `urlString` (auto-converted to `URL`).
     ///
+    /// To configure [Sync filter](https://sync.objectbox.io/sync-server/sync-filters) variables, pass
+    /// variable names mapped to their value to `filterVariables` .
+    ///
+    /// Sync client filter variables can be used in server-side Sync filters to filter out objects that do not match
+    /// the filter.
+    ///
     /// - Throws: `ObjectBoxError.sync` if sync is unavailable in this version of the library
     ///           or no valid URL was provided.
     public static func makeClient(
-            store: Store,
-            url: URL? = nil,
-            urlString: String? = nil,
-            credentials: SyncCredentials? = nil
+        store: Store,
+        url: URL? = nil,
+        urlString: String? = nil,
+        credentials: SyncCredentials? = nil,
+        filterVariables: [String: String]? = nil
     ) throws -> SyncClient {
         let client = try makeClient(store: store, url: url, urlString: urlString)
 
@@ -44,28 +51,57 @@ public class Sync {
 
     /// Like ``makeClient(store:url:urlString:credentials:)-6rikk``, but accepts multiple credentials.
     public static func makeClient(
-            store: Store,
-            url: URL,
-            urlString: String,
-            credentials: [SyncCredentials]
+        store: Store,
+        url: URL? = nil,
+        urlString: String? = nil,
+        credentials: [SyncCredentials],
+        filterVariables: [String: String]? = nil
     ) throws -> SyncClient {
         let client = try makeClient(store: store, url: url, urlString: urlString)
+
         try client.setCredentials(credentials)
+
         return client
     }
 
     private static func makeClient(
-            store: Store,
-            url: URL? = nil,
-            urlString: String? = nil
-    ) throws -> SyncClient {
+        store: Store,
+        url: URL? = nil,
+        urlString: String? = nil,
+        filterVariables: [String: String]? = nil
+    ) throws -> SyncClientImpl {
         guard isAvailable() else {
             throw ObjectBoxError.sync(
-                    message: "This library does not include ObjectBox Sync. " +
-                            "Please visit https://objectbox.io/sync/ for options.")
+                message: "This library does not include ObjectBox Sync. " +
+                "Please visit https://objectbox.io/sync/ for options.")
+        }
+        guard store.syncClient == nil else {
+            throw ObjectBoxError.sync(
+                message: "Cannot create a new sync client: the store is already associated with a sync client")
         }
-        throw ObjectBoxError.sync(
-                message:
-                "Cannot create a new sync client: no Swift implementation available (but linked library supports it)")
+        var urlToConnect = url
+        if urlToConnect == nil {
+            if urlString == nil {
+                throw ObjectBoxError.sync(message: "No URL provided")
+            } else {
+                urlToConnect = URL(string: urlString!)
+                if urlToConnect == nil {
+                    throw ObjectBoxError.sync(message: "Illegal URL given:" + urlString!)
+                }
+            }
+        }
+
+        let client = try SyncClientImpl(store: store, server: urlToConnect!)
+
+        // Associate store with the new client: keep the client alive and provide convenient access to it
+        store.syncClient = client  // This is not very atomic...
+
+        if let filterVariables = filterVariables {
+            for (name, value) in filterVariables {
+                try client.putFilterVariable(name: name, value: value)
+            }
+        }
+
+        return client
     }
 }

Source/ios-framework/CommonSource/Sync/SyncClient.swift

@@ -47,14 +47,38 @@ public protocol SyncClient: AnyObject {
     /// Does nothing if this sync client has already been closed.
     func close()
 
+    /// Adds or replaces a [Sync filter](https://sync.objectbox.io/sync-server/sync-filters) variable value for the
+    /// given name.
+    ///
+    /// Eventually, existing values for the same name are replaced.
+    ///
+    /// Sync client filter variables can be used in server-side Sync filters to filter out objects that do not match
+    /// the filters. Filter variables must be added before login, so before calling `start()`.
+    ///
+    /// - SeeAlso: `removeFilterVariable(_:)`
+    /// - SeeAlso: `removeAllFilterVariables()`
+    func putFilterVariable(name: String, value: String) throws
+
+    /// Removes a previously added Sync filter variable value.
+    ///
+    /// - SeeAlso: `putFilterVariable(name:value:)`
+    /// - SeeAlso: `removeAllFilterVariables()`
+    func removeFilterVariable(_ name: String) throws
+
+    /// Removes all previously added Sync filter variable values.
+    ///
+    /// - SeeAlso: `putFilterVariable(name:value:)`
+    /// - SeeAlso: `removeFilterVariable(_:)`
+    func removeAllFilterVariables() throws
+
     /// Sets credentials to authenticate the client with the server.
     /// Build credentials using e.g. `SyncCredentials.makeSharedSecret(secret)`.
     func setCredentials(_ credentials: SyncCredentials) throws
 
     /// Sets multiple credentials to authenticate the client with the server.
     /// Build credentials using e.g. `SyncCredentials.makeSharedSecret(secret)`.
     func setCredentials(_ credentials: [SyncCredentials]) throws
-  
+
     /// Once the sync client is configured, you can "start" it to initiate synchronization.
     /// This method triggers communication in the background and will return immediately.
     /// If the synchronization destination is reachable, this background thread will connect to the server,

Source/ios-framework/CommonSource/Sync/SyncClientImpl.swift

@@ -1,4 +1,4 @@
-//  Copyright © 2020-2021 ObjectBox. All rights reserved.
+//  Copyright © 2020-2025 ObjectBox. All rights reserved.
 
 import Foundation
 
@@ -76,15 +76,15 @@ class SyncClientImpl: SyncClient {
 
 
     public var updateRequestMode: RequestUpdatesMode {
+        get {
+            return updateRequestModeStorage
+        }
         set(newValue) {
             let cMode = OBXRequestUpdatesMode(newValue.rawValue)
             if cSync != nil && obx_sync_request_updates_mode(cSync, cMode) == OBX_SUCCESS {
                 updateRequestModeStorage = newValue
             }
         }
-        get {
-            return updateRequestModeStorage
-        }
     }
 
     init(store: Store, server: URL) throws {
@@ -148,15 +148,70 @@ class SyncClientImpl: SyncClient {
         }
     }
 
+    public func putFilterVariable(name: String, value: String) throws {
+        try ensureValid()
+        try checkLastError(obx_sync_filter_variables_put(cSync, name, value))
+    }
+
+    public func removeFilterVariable(_ name: String) throws {
+        try ensureValid()
+        try checkLastError(obx_sync_filter_variables_remove(cSync, name))
+    }
+
+    public func removeAllFilterVariables() throws {
+        try ensureValid()
+        try checkLastError(obx_sync_filter_variables_remove_all(cSync))
+    }
+
     public func setCredentials(_ credentials: SyncCredentials) throws {
         try ensureValid()
         // Note: we don't store credentials in Swift memory for security reasons
-        let credentialsLength = credentials.data.count
-        try credentials.data.withUnsafeBytes { (rawBytes: UnsafeRawBufferPointer) -> Void in
+        if let data = credentials.data {
+            let credentialsLength = data.count
+            try data.withUnsafeBytes { (rawBytes: UnsafeRawBufferPointer) in
+                let cCredsType = OBXSyncCredentialsType(credentials.type.rawValue)
+                obx_sync_credentials(cSync, cCredsType, rawBytes.baseAddress, credentialsLength)
+                try checkLastError()
+                credentialsSet = true
+            }
+        } else if let username = credentials.username {
             let cCredsType = OBXSyncCredentialsType(credentials.type.rawValue)
-            obx_sync_credentials(cSync, cCredsType, rawBytes.baseAddress, credentialsLength)
+            obx_sync_credentials_user_password(cSync, cCredsType, username, credentials.password!)
             try checkLastError()
             credentialsSet = true
+        } else {
+            throw ObjectBoxError.illegalArgument(message: "Credentials neither contain bytes data nor user/password")
+        }
+    }
+
+    public func setCredentials(_ credentials: [SyncCredentials]) throws {
+        try ensureValid()
+
+        var oneCredentialSet = false
+
+        for (index, credential) in credentials.enumerated() {
+            let isLast = index + 1 == credentials.count
+            if let data = credential.data {
+                let credentialsLength = data.count
+                try data.withUnsafeBytes { (rawBytes: UnsafeRawBufferPointer) in
+                    let cCredsType = OBXSyncCredentialsType(credential.type.rawValue)
+                    // TODO Need new C API
+                    obx_sync_credentials_add(cSync, cCredsType, rawBytes.baseAddress, credentialsLength, isLast)
+                    try checkLastError()
+                    oneCredentialSet = true
+                }
+            } else if let username = credential.username {
+                let cCredsType = OBXSyncCredentialsType(credential.type.rawValue)
+                obx_sync_credentials_add_user_password(cSync, cCredsType, username, credential.password!, isLast)
+                try checkLastError()
+                oneCredentialSet = true
+            } else {
+                throw ObjectBoxError.illegalArgument(
+                    message: "Credentials neither contain bytes data nor user/password")
+            }
+        }
+        if oneCredentialSet {
+            credentialsSet = true
         }
     }
 
@@ -264,32 +319,32 @@ private func callWithSyncClient(_ userData: UnsafeMutableRawPointer?, action: @e
 }
 
 private func loginCallback(_ userData: UnsafeMutableRawPointer?) {
-    callWithSyncClient(userData, action: { (client: SyncClient) -> Void in
+    callWithSyncClient(userData, action: { (client: SyncClient) in
         client.loginListener?.loggedIn()
     })
 }
 
 private func loginFailureCallback(_ userData: UnsafeMutableRawPointer?, _ cCode: OBXSyncCode) {
     let code = SyncCode(rawValue: cCode.rawValue)!
-    callWithSyncClient(userData, action: { (client: SyncClient) -> Void in
+    callWithSyncClient(userData, action: { (client: SyncClient) in
         client.loginListener?.loginFailed(result: code)
     })
 }
 
 private func connectedCallback(_ userData: UnsafeMutableRawPointer?) {
-    callWithSyncClient(userData, action: { (client: SyncClient) -> Void in
+    callWithSyncClient(userData, action: { (client: SyncClient) in
         client.connectionListener?.connected()
     })
 }
 
 private func disconnectedCallback(_ userData: UnsafeMutableRawPointer?) {
-    callWithSyncClient(userData, action: { (client: SyncClient) -> Void in
+    callWithSyncClient(userData, action: { (client: SyncClient) in
         client.connectionListener?.disconnected()
     })
 }
 
 private func updatesCompletedCallback(_ userData: UnsafeMutableRawPointer?) {
-    callWithSyncClient(userData, action: { (client: SyncClient) -> Void in
+    callWithSyncClient(userData, action: { (client: SyncClient) in
         client.completedListener?.updatesCompleted()
     })
 }