Permalink
Switch branches/tags
Find file Copy path
3538 lines (2655 sloc) 153 KB

x.y.z Release notes (yyyy-MM-dd)

Enhancements

  • None.

Fixed

  • <How to hit and notice issue? what was the impact?> (#????, since v?.?.?)
  • None.

Compatibility

  • File format: Generates Realms with format v9 (Reads and upgrades all previous formats)
  • Realm Object Server: 3.11.0 or later.
  • APIs are backwards compatible with all previous releases in the 3.x.y series.

3.11.1 Release notes (2018-10-19)

Fixed

  • Fix SyncUser.requestEmailConfirmation not triggering the email confirmation flow on ROS. (PR #5953, since 3.5.0)
  • Add some missing validation in the getters and setters of properties on managed Realm objects, which would sometimes result in an application crashing with a segfault rather than the appropriate exception being thrown when trying to write to an object which has been deleted. (PR #5952, since 2.8.0)

Compatibility

  • File format: Generates Realms with format v9 (Reads and upgrades all previous formats)
  • Realm Object Server: 3.11.0 or later.

3.11.0 Release notes (2018-10-04)

Enhancements

  • Reduce memory usage when integrating synchronized changes sent by ROS.
  • Devices will now report download progress for read-only Realms, allowing the server to compact Realms more aggressively and reducing the amount of server-side storage space required.

Fixed

  • Fix a crash when adding an object with a non-@objc String? property which has not been explicitly ignored to a Realm on watchOS 5 (and possibly other platforms when building with Xcode 10). (Issue: 5929).
  • Fix some merge algorithm bugs which could result in BadChangesetError being thrown when integrating changes sent by the server.

Compatibility

  • File format: Generates Realms with format v9 (Reads and upgrades all previous formats)
  • NOTE!!! You will need to upgrade your Realm Object Server to at least version 3.11.0 or use Realm Cloud. If you try to connect to a ROS v3.10.x or previous, you will see an error like Wrong protocol version in Sync HTTP request, client protocol version = 25, server protocol version = 24.

Internal

  • Update to Sync 3.12.2.

3.10.0 Release notes (2018-09-19)

Prebuilt binaries are now built for Xcode 9.2, 9.3, 9.4 and 10.0.

Older versions of Xcode are still supported when building from source, but you should be migrating to at least Xcode 9.2 as soon as possible.

Enhancements

  • Add support for Watch Series 4 by adding an arm64_32 slice to the library.

3.9.0 Release notes (2018-09-10)

Enhancements

  • Expose RLMSyncUser.refreshToken publicly so that it can be used for custom HTTP requests to Realm Object Server.
  • Add RLMSyncSession.connectionState, which reports whether the session is currently connected to the Realm Object Server or if it is offline.
  • Add -suspend and -resume methods to RLMSyncSession to enable manually pausing data synchronization.
  • Add support for limiting the number of objects matched by a query-based sync subscription. This requires a server running ROS 3.10.1 or newer.

Bugfixes

  • Fix crash when getting the description of a MigrationObject which has List properties.
  • Fix crash when calling dynamicList() on a MigrationObject.

3.8.0 Release notes (2018-09-05)

Enhancements

  • Remove some old and no longer applicable migration logic which created an unencrypted file in the sync metadata directory containing a list of ROS URLs connected to.
  • Add support for pinning SSL certificates used for https and realms connections by setting RLMSyncManager.sharedManager.pinnedCertificatePaths in obj-c and SyncManager.shared.pinnedCertificatePaths in Swift.

Bugfixes

  • Fix warnings when building Realm as a static framework with CocoaPods.

3.7.6 Release notes (2018-08-08)

Enhancements

  • Speed up the actual compaction when using compact-on-launch.
  • Reduce memory usage when locally merging changes from sync.
  • When first connecting to a server, wait to begin uploading changes until after all changes have been downloaded to reduce the server-side load for query-based sync.

3.7.5 Release notes (2018-07-23)

Enhancements

  • Improve performance of applying remote changesets from sync.
  • Improve performance of creating objects with string primary keys.
  • Improve performance of large write transactions.
  • Adjust file space allocation strategy to reduce fragmentation, producing smaller Realm files and typically better performance.
  • Close network connections immediately when a sync session is destroyed.
  • Report more information in InvalidDatabase exceptions.

Bugfixes

  • Fix permission denied errors for RLMPlatform.h when building with CocoaPods and Xcode 10 beta 3.
  • Fix a use-after-free when canceling a write transaction which could result in incorrect "before" values in KVO observations (typically nil when a non-nil value is expected).
  • Fix several bugs in the merge algorithm that could lead to memory corruption and crashes with errors like "bad changeset" and "unreachable code".

3.7.4 Release notes (2018-06-19)

Bugfixes

  • Fix a bug which could potentially flood Realm Object Server with PING messages after a client device comes back online.

3.7.3 Release notes (2018-06-18)

Enhancements

  • Avoid performing potentially large amounts of pointless background work for LinkingObjects instances which are accessed and then not immediate deallocated.

Bugfixes

  • Fix crashes which could result from extremely fragmented Realm files.
  • Fix a bug that could result in a crash with the message "bad changeset error" when merging changesets from the server.

3.7.2 Release notes (2018-06-13)

Enhancements

  • Add some additional consistency checks that will hopefully produce better errors when the "prev_ref + prev_size <= ref" assertion failure occurs.

Bugfixes

  • Fix a problem in the changeset indexing algorithm that would sometimes cause "bad permission object" and "bad changeset" errors.
  • Fix a large number of linking warnings about symbol visibility by aligning compiler flags used.
  • Fix large increase in size of files produced by Realm.writeCopy() introduced in 3.6.0.

3.7.1 Release notes (2018-06-07)

  • Add support for compiling Realm Swift with Xcode 10 beta 1.

3.7.0 Release notes (2018-06-06)

The feature known as Partial Sync has been renamed to Query-based Synchronization. This has impacted a number of API's. See below for the details.

Deprecations

  • +[RLMSyncConfiguration initWithUser] has been deprecated in favor of -[RLMSyncUser configurationWithURL:url].
  • +[RLMSyncConfiguration automaticConfiguration] has been deprecated in favor of -[RLMSyncUser configuration].
  • +[RLMSyncConfiguration automaticConfigurationForUser] has been deprecated in favor of -[RLMSyncUser configuration].
  • -[RLMSyncConfiguration isPartial] has been deprecated in favor of -[RLMSyncConfiguration fullSynchronization]`.

Enhancements

  • Add -[RLMRealm syncSession] and Realm.syncSession to obtain the session used for a synchronized Realm.
  • Add -[RLMSyncUser configuration]. Query-based sync is the default sync mode for this configuration.
  • Add -[RLMSyncUser configurationWithURL:url]. Query-based sync is the default sync mode for this configuration.

3.6.0 Release notes (2018-05-29)

Enhancements

  • Improve performance of sync metadata operations and resolving thread-safe references.
  • shouldCompactOnLaunch is now supported for compacting the local data of synchronized Realms.

Bugfixes

  • Fix a potential deadlock when a sync session progress callback held the last strong reference to the sync session.
  • Fix some cases where comparisons to nil in queries were not properly serialized when subscribing to a query.
  • Don't delete objects added during a migration after a call to -[RLMMigration deleteDataForClassName:].
  • Fix incorrect results and/or crashes when multiple -[RLMMigration enumerateObjects:block:] blocks deleted objects of the same type.
  • Fix some edge-cases where -[RLMMigration enumerateObjects:block:] enumerated the incorrect objects following deletions.
  • Restore the pre-3.5.0 behavior for Swift optional properties missing an ivar rather than crashing.

3.5.0 Release notes (2018-04-25)

Enhancements

  • Add wrapper functions for email confirmation and password reset to SyncUser.

Bugfixes

  • Fix incorrect results when using optional chaining to access a RealmOptional property in Release builds, or otherwise interacting with a RealmOptional object after the owning Object has been deallocated.

3.4.0 Release notes (2018-04-19)

The prebuilt binary for Carthage is now built for Swift 4.1.

Enhancements

  • Expose RLMSyncManager.authorizationHeaderName/SyncManager.authorizationHeaderName as a way to override the transport header for Realm Object Server authorization.
  • Expose RLMSyncManager.customRequestHeaders/SyncManager.customRequestHeaders which allows custom HTTP headers to be appended on requests to the Realm Object Server.
  • Expose RLMSSyncConfiguration.urlPrefix/SyncConfiguration.urlPrefix as a mechanism to replace the default path prefix in Realm Sync WebSocket requests.

3.3.2 Release notes (2018-04-03)

Add a prebuilt binary for Xcode 9.3.

3.3.1 Release notes (2018-03-28)

Realm Object Server v3.0.0 or newer is required when using synchronized Realms.

Enhancements

  • Expose RLMObject.object(forPrimaryKey:) as a factory method for Swift so that it is callable with recent versions of Swift.

Bugfixes

  • Exclude the RLMObject-derived Permissions classes from the types repored by Realm.Configuration.defaultConfiguration.objectTypes to avoid a failed cast.
  • Cancel pending Realm.asyncOpen() calls when authentication fails with a non-transient error such as missing the Realm path in the URL.
  • Fix "fcntl() inside prealloc()" errors on APFS.

3.3.0 Release notes (2018-03-19)

Realm Object Server v3.0.0 or newer is required when using synchronized Realms.

Enhancements

  • Add Realm.permissions, Realm.permissions(forType:), and Realm.permissions(forClassNamed:) as convenience methods for accessing the permissions of the Realm or a type.

Bugfixes

  • Fix +[RLMClassPermission objectInRealm:forClass:] to work for classes that are part of the permissions API, such as RLMPermissionRole.
  • Fix runtime errors when applications define an Object subclass with the same name as one of the Permissions object types.

3.2.0 Release notes (2018-03-15)

Realm Object Server v3.0.0 or newer is required when using synchronized Realms.

Enhancements

  • Added an improved API for adding subscriptions in partially-synchronized Realms. Results.subscribe() can be used to subscribe to any result set, and the returned SyncSubscription object can be used to observe the state of the subscription and ultimately to remove the subscription. See the documentation for more information (https://docs.realm.io/platform/v/3.x/using-synced-realms/syncing-data).
  • Added a fine-grained permissions system for use with partially-synchronized Realms. This allows permissions to be defined at the level of individual objects or classes. See the documentation for more information (https://docs.realm.io/platform/v/3.x/using-synced-realms/access-control).
  • Added SyncConfiguration.automatic() and SyncConfiguration.automatic(user:). These methods return a Realm.Configuration appropriate for syncing with the default synced Realm for the current (or specified) user. These should be considered the preferred methods for accessing synced Realms going forwards.
  • Added +[RLMSyncSession sessionForRealm:] to retrieve the sync session corresponding to a RLMRealm.

Bugfixes

  • Fix incorrect initalization of RLMSyncManager that made it impossible to set errorHandler.
  • Fix compiler warnings when building with Xcode 9.3.
  • Fix some warnings when running with UBsan.

3.2.0-rc.1 Release notes (2018-03-14)

Realm Object Server v3.0.0-rc.1 or newer is required when using synchronized Realms.

Enhancements

  • Added SyncConfiguration.automatic() and SyncConfiguration.automatic(user:). These methods return a Realm.Configuration appropriate for syncing with the default synced Realm for the current (or specified). These should be considered the preferred methods for accessing synced Realms going forwards.
  • A role is now automatically created for each user with that user as its only member. This simplifies the common use case of restricting access to specific objects to a single user. This role can be accessed at PermissionUser.role.
  • Improved error reporting when the server rejects a schema change due to a lack of permissions.

Bugfixes

  • Fix incorrect initalization of RLMSyncManager that made it impossible to set errorHandler.
  • Fix compiler warnings when building with Xcode 9.3.

3.2.0-beta.3 Release notes (2018-03-01)

Realm Object Server v3.0.0-alpha.9 or newer is required when using synchronized Realms.

Bugfixes

  • Fix a crash that would occur when using partial sync with Realm Object Server v3.0.0-alpha.9.

3.2.0-beta.2 Release notes (2018-02-28)

Realm Object Server v3.0.0-alpha.8 or newer is required when using synchronized Realms.

Enhancements

  • Added findOrCreate(forRoleNamed:) and findOrCreate(forRole:) to List<Permission> to simplify the process of adding permissions for a role.
  • Added +permissionForRoleNamed:inArray:, +permissionForRoleNamed:onRealm:, +permissionForRoleNamed:onClass:realm:, +permissionForRoleNamed:onClassNamed:realm:, and +permissionForRoleNamed:onObject: to RLMSyncPermission to simplify the process of adding permissions for a role.
  • Added +[RLMSyncSession sessionForRealm:] to retrieve the sync session corresponding to a RLMRealm.

Bugfixes

  • PermissionRole.users and PermissionUser.roles are now public as intended.
  • Fixed the handling of setPermissions in -[RLMRealm privilegesForRealm] and related methods.

3.2.0-beta.1 Release notes (2018-02-19)

Enhancements

  • Added an improved API for adding subscriptions in partially-synchronized Realms. Results.subscribe() can be used to subscribe to any result set, and the returned SyncSubscription object can be used to observe the state of the subscription and ultimately to remove the subscription.
  • Added a fine-grained permissions system for use with partially-synchronized Realms. This allows permissions to be defined at the level of individual objects or classes. See Permission and related types for more information.

Bugfixes

  • Fix some warnings when running with UBsan.

3.1.1 Release notes (2018-02-03)

Prebuilt Swift frameworks for Carthage are now built with Xcode 9.2.

Bugfixes

  • Fix a memory leak when opening Realms with an explicit objectTypes array from Swift.

3.1.0 Release notes (2018-01-16)

  • Prebuilt frameworks are now included for Swift 3.2.3 and 4.0.3.
  • Prebuilt frameworks are no longer included for Swift 3.0.x.
  • Building from source with Xcode versions prior to Xcode 8.3 is no longer supported.

Enhancements

  • Add Results.distinct(by:) / -[RLMResults distinctResultsUsingKeyPaths:], which return a Results containing only objects with unique values at the given key paths.
  • Improve performance of change checking for notifications in certain cases.
  • Realm Object Server errors not explicitly recognized by the client are now reported to the application regardless.
  • Add support for JSON Web Token as a sync credential source.
  • Add support for Nickname and Anonymous Auth as a sync credential source.
  • Improve allocator performance when writing to a highly fragmented file. This should significantly improve performance when inserting large numbers of objects which have indexed properties.
  • Improve write performance for complex object graphs involving many classes linking to each other.

Bugfixes

  • Add a missing check for a run loop in the permission API methods which require one.
  • Fix some cases where non-fatal sync errors were being treated as fatal errors.

3.0.2 Release notes (2017-11-08)

Prebuilt frameworks are now included for Swift 3.2.2 and 4.0.2.

Bugfixes

  • Fix a crash when a linking objects property is retrieved from a model object instance via Swift subscripting.
  • Fix incorrect behavior if a call to posix_fallocate is interrupted.

3.0.1 Release notes (2017-10-26)

Bugfixes

  • Explicitly exclude KVO-generated object subclasses from the schema.
  • Fix regression where the type of a Realm model class is not properly determined, causing crashes when a type value derived at runtime by type(of:) is passed into certain APIs.
  • Fix a crash when an Object subclass has implicitly ignored let properties.
  • Fix several cases where adding a notification block from within a notification callback could produce incorrect results.

3.0.0 Release notes (2017-10-16)

Breaking Changes

  • iOS 7 is no longer supported.
  • Synchronized Realms require a server running Realm Object Server v2.0 or higher.
  • Computed properties on Realm object types are detected and no longer added to the automatically generated schema.
  • The Objective-C and Swift create(_:, value: update:) APIs now correctly nil out nullable properties when updating an existing object when the value argument specifies nil or NSNull for the property value.
  • -[RLMRealm addOrUpdateObjects:] and -[RLMRealm deleteObjects:] now require their argument to conform to NSFastEnumeration, to match similar APIs that also take collections.
  • The way interactive sync errors (client reset and permission denied) are delivered to the user has been changed. Instead of a block which can be invoked to immediately delete the offending Realm file, an opaque token object of type RLMSyncErrorActionToken will be returned in the error object's userInfo dictionary. This error object can be passed into the new +[RLMSyncSession immediatelyHandleError:] API to delete the files.
  • The return types of the SyncError.clientResetInfo() and SyncError.deleteRealmUserInfo() APIs have been changed. They now return RLMSyncErrorActionTokens or SyncError.ActionTokens instead of closures.
  • The class methods Object.className(), Object.objectUtilClass(), and the property Object.isInvalidated can no longer be overriden.
  • The callback which runs when a sync user login succeeds or fails now runs on the main queue by default, or can be explicitly specified by a new callbackQueue parameter on the {RLM}SyncUser.logIn(...) API.
  • Fix empty strings, binary data, and null on the right side of BEGINSWITH, ENDSWITH and CONTAINS operators in predicates to match Foundation's semantics of never matching any strings or data.
  • Swift Object comparison and hashing behavior now works the same way as that of RLMObject (objects are now only considered equatable if their model class defines a primary key).
  • Fix the way the hash property works on Object when the object model has no primary key.
  • Fix an issue where if a Swift model class defined non-generic managed properties after generic Realm properties (like List<T>), the schema would be constructed incorrectly. Fixes an issue where creating such models from an array could fail.
  • Loosen RLMArray and RLMResults's generic constraint from RLMObject to NSObject. This may result in having to add some casts to disambiguate types.
  • Remove RLMSyncPermissionResults. RLMSyncPermissions are now vended out using a RLMResults. This results collection supports all normal collection operations except for setting values using key-value coding (since RLMSyncPermissions are immutable) and the property aggregation operations.
  • RLMSyncUserInfo has been significantly enhanced. It now contains metadata about a user stored on the Realm Object Server, as well as a list of all user account data associated with that user.
  • Starting with Swift 4, List now conforms to MutableCollection instead of RangeReplaceableCollection. For Swift 4, the empty collection initializer has been removed, and default implementations of range replaceable collection methods that make sense for List have been added.
  • List.removeLast() now throws an exception if the list is empty, to more closely match the behavior of the standard library's Collection.removeLast() implementation.
  • RealmCollection's associated type Element has been renamed ElementType.
  • The following APIs have been renamed:
Old API New API
NotificationToken.stop() NotificationToken.invalidate()
-[RLMNotificationToken stop] -[RLMNotificationToken invalidate]
RealmCollection.addNotificationBlock(_:) RealmCollection.observe(_:)
RLMSyncProgress RLMSyncProgressMode
List.remove(objectAtIndex:) List.remove(at:)
List.swap(_:_:) List.swapAt(_:_:)
SyncPermissionValue SyncPermission
RLMSyncPermissionValue RLMSyncPermission
-[RLMSyncPermission initWithRealmPath:userID:accessLevel] -[RLMSyncPermission initWithRealmPath:identity:accessLevel:]
RLMSyncPermission.userId RLMSyncPermission.identity
-[RLMRealm addOrUpdateObjectsInArray:] -[RLMRealm addOrUpdateObjects:]
  • The following APIs have been removed:
Removed API Replacement
Object.className None, was erroneously present.
RLMPropertyTypeArray RLMProperty.array
PropertyType.array Property.array
-[RLMArray sortedResultsUsingProperty:ascending:] -[RLMArray sortedResultsUsingKeyPath:ascending:]
-[RLMCollection sortedResultsUsingProperty:ascending:] -[RLMCollection sortedResultsUsingKeyPath:ascending:]
-[RLMResults sortedResultsUsingProperty:ascending:] -[RLMResults sortedResultsUsingKeyPath:ascending:]
+[RLMSortDescriptor sortDescriptorWithProperty:ascending:] +[RLMSortDescriptor sortDescriptorWithKeyPath:ascending:]
RLMSortDescriptor.property RLMSortDescriptor.keyPath
AnyRealmCollection.sorted(byProperty:ascending:) AnyRealmCollection.sorted(byKeyPath:ascending:)
List.sorted(byProperty:ascending:) List.sorted(byKeyPath:ascending:)
LinkingObjects.sorted(byProperty:ascending:) LinkingObjects.sorted(byKeyPath:ascending:)
Results.sorted(byProperty:ascending:) Results.sorted(byKeyPath:ascending:)
SortDescriptor.init(property:ascending:) SortDescriptor.init(keyPath:ascending:)
SortDescriptor.property SortDescriptor.keyPath
+[RLMRealm migrateRealm:configuration:] +[RLMRealm performMigrationForConfiguration:error:]
RLMSyncManager.disableSSLValidation RLMSyncConfiguration.enableSSLValidation
SyncManager.disableSSLValidation SyncConfiguration.enableSSLValidation
RLMSyncErrorBadResponse RLMSyncAuthErrorBadResponse
RLMSyncPermissionResults RLMResults
SyncPermissionResults Results
RLMSyncPermissionChange -[RLMSyncUser applyPermission:callback] / -[RLMSyncUser deletePermission:callback:]
-[RLMSyncUser permissionRealmWithError:] -[RLMSyncUser retrievePermissionsWithCallback:]
RLMSyncPermissionOffer -[RLMSyncUser createOfferForRealmAtURL:accessLevel:expiration:callback:]
RLMSyncPermissionOfferResponse -[RLMSyncUser acceptOfferForToken:callback:]
-[NSError rlmSync_clientResetBlock] -[NSError rlmSync_errorActionToken] / -[NSError rlmSync_clientResetBackedUpRealmPath]
-[NSError rlmSync_deleteRealmBlock] -[NSError rlmSync_errorActionToken]

Enhancements

  • List can now contain values of types Bool, Int, Int8, Int16, Int32, Int64, Float, Double, String, Data, and Date (and optional versions of all of these) in addition to Object subclasses. Querying Lists containing values other than Object subclasses is not yet implemented.
  • RLMArray can now be constrained with the protocols RLMBool, RLMInt, RLMFloat, RLMDouble, RLMString, RLMData, and RLMDate in addition to protocols defined with RLM_ARRAY_TYPE. By default RLMArrays of non-RLMObject types can contain null. Indicating that the property is required (by overriding +requiredProperties:) will instead make the values within the array required. Querying RLMArrays containing values other than RLMObject subclasses is not yet implemented.
  • Add a new error code to denote 'permission denied' errors when working with synchronized Realms, as well as an accompanying block that can be called to inform the binding that the offending Realm's files should be deleted immediately. This allows recovering from 'permission denied' errors in a more robust manner. See the documentation for RLMSyncErrorPermissionDeniedError for more information.
  • Add Swift Object.isSameObject(as:_) API to perform the same function as the existing Objective-C API -[RLMObject isEqualToObject:].
  • Opening a synced Realm whose local copy was created with an older version of Realm Mobile Platfrom when a migration is not possible to the current version will result in an RLMErrorIncompatibleSyncedFile / incompatibleSyncedFile error. When such an error occurs, the original file is moved to a backup location, and future attempts to open the synchronized Realm will result in a new file being created. If you wish to migrate any data from the backup Realm you can open it using the backup Realm configuration available on the error object.
  • Add a preview of partial synchronization. Partial synchronization allows a synchronized Realm to be opened in such a way that only objects requested by the user are synchronized to the device. You can use it by setting the isPartial property on a SyncConfiguration, opening the Realm, and then calling Realm.subscribe(to:where:callback:) with the type of object you're interested in, a string containing a query determining which objects you want to subscribe to, and a callback which will report the results. You may add as many subscriptions to a synced Realm as necessary.

Bugfixes

  • Realm no longer throws an "unsupported instruction" exception in some cases when opening a synced Realm asynchronously.
  • Realm Swift APIs that filter or look up the index of an object based on a format string now properly handle optional arguments in their variadic argument list.
  • -[RLMResults<RLMSyncPermission *> indexOfObject:] now properly accounts for access level.
  • Fix a race condition that could lead to a crash accessing to the freed configuration object if a default configuration was set from a different thread.
  • Fixed an issue that crash when enumerating after clearing data during migration.
  • Fix a bug where a synced Realm couldn't be reopened even after a successful client reset in some cases.
  • Fix a bug where the sync subsystem waited too long in certain cases to reconnect to the server.
  • Fix a bug where encrypted sync-related metadata was incorrectly deleted from upgrading users, resulting in all users being logged out.
  • Fix a bug where permission-related data continued to be synced to a client even after the user that data belonged to logged out.
  • Fix an issue where collection notifications might be delivered inconsistently if a notification callback was added within another callback for the same collection.

3.0.0-rc.2 Release notes (2017-10-14)

Enhancements

  • Reinstate RLMSyncPermissionSortPropertyUserID to allow users to sort permissions to their own Realms they've granted to others.

Bugfixes

  • -[RLMResults<RLMSyncPermission *> indexOfObject:] now properly accounts for access level.
  • Fix a race condition that could lead to a crash accessing to the freed configuration object if a default configuration was set from a different thread.
  • Fixed an issue that crash when enumerating after clearing data during migration.
  • Fix a bug where a synced Realm couldn't be reopened even after a successful client reset in some cases.
  • Fix a bug where the sync subsystem waited too long in certain cases to reconnect to the server.
  • Fix a bug where encrypted sync-related metadata was incorrectly deleted from upgrading users, resulting in all users being logged out.
  • Fix a bug where permission-related data continued to be synced to a client even after the user that data belonged to logged out.
  • Fix an issue where collection notifications might be delivered inconsistently if a notification callback was added within another callback for the same collection.

3.0.0-rc.1 Release notes (2017-10-03)

Breaking Changes

  • Remove RLMSyncPermissionSortPropertyUserID to reflect changes in how the Realm Object Server reports permissions for a user.
  • Remove RLMSyncPermissionOffer and RLMSyncPermissionOfferResponse classes and associated helper methods and functions. Use the -[RLMSyncUser createOfferForRealmAtURL:accessLevel:expiration:callback:] and -[RLMSyncUser acceptOfferForToken:callback:] methods instead.

Bugfixes

  • The keychain item name used by Realm to manage the encryption keys for sync-related metadata is now set to a per-app name based on the bundle identifier. Keys that were previously stored within the single, shared Realm keychain item will be transparently migrated to the per-application keychain item.
  • Fix downloading of the Realm core binaries when Xcode's command-line tools are set as the active developer directory for command-line interactions.
  • Fix a crash that could occur when resolving a ThreadSafeReference to a List whose parent object had since been deleted.

3.0.0-beta.4 Release notes (2017-09-22)

Breaking Changes

  • Rename List.remove(objectAtIndex:) to List.remove(at:) to match the name used by 'RangeReplaceableCollection'.
  • Rename List.swap() to List.swapAt() to match the name used by 'Array'.
  • Loosen RLMArray and RLMResults's generic constraint from RLMObject to NSObject. This may result in having to add some casts to disambiguate types.
  • Remove RLMPropertyTypeArray in favor of a separate bool array property on RLMProperty/Property.
  • Remove RLMSyncPermissionResults. RLMSyncPermissions are now vended out using a RLMResults. This results collection supports all normal collection operations except for setting values using KVO (since RLMSyncPermissions are immutable) and the property aggregation operations.
  • RealmCollection's associated type Element has been renamed ElementType.
  • Realm Swift collection types (List, Results, AnyRealmCollection, and LinkingObjects have had their generic type parameter changed from T to Element).
  • RealmOptional's generic type parameter has been changed from T to Value.
  • RLMSyncUserInfo has been significantly enhanced. It now contains metadata about a user stored on the Realm Object Server, as well as a list of all user account data associated with that user.
  • Starting with Swift 4, List now conforms to MutableCollection instead of RangeReplaceableCollection. For Swift 4, the empty collection initializer has been removed, and default implementations of range replaceable collection methods that make sense for List have been added.
  • List.removeLast() now throws an exception if the list is empty, to more closely match the behavior of the standard library's Collection.removeLast() implementation.

Enhancements

  • List can now contain values of types Bool, Int, Int8, Int16, Int32, Int64, Float, Double, String, Data, and Date (and optional versions of all of these) in addition to Object subclasses. Querying Lists containing values other than Object subclasses is not yet implemented.
  • RLMArray can now be constrained with the protocols RLMBool, RLMInt, RLMFloat, RLMDouble, RLMString, RLMData, and RLMDate in addition to protocols defined with RLM_ARRAY_TYPE. By default RLMArrays of non-RLMObject types can contain null. Indicating that the property is required (by overriding +requiredProperties:) will instead make the values within the array required. Querying RLMArrays containing values other than RLMObject subclasses is not yet implemented.
  • Opening a synced Realm whose local copy was created with an older version of Realm Mobile Platfrom when a migration is not possible to the current version will result in an RLMErrorIncompatibleSyncedFile / incompatibleSyncedFile error. When such an error occurs, the original file is moved to a backup location, and future attempts to open the synchronized Realm will result in a new file being created. If you wish to migrate any data from the backup Realm you can open it using the backup Realm configuration available on the error object.
  • Add preview support for partial synchronization. Partial synchronization is allows a synchronized Realm to be opened in such a way that only objects requested by the user are synchronized to the device. You can use it by setting the isPartial property on a SyncConfiguration, opening the Realm, and then calling Realm.subscribe(to:where:callback:) with the type of object you're interested in, a string containing a query determining which objects you want to subscribe to, and a callback which will report the results. You may add as many subscriptions to a synced Realm as necessary.

Bugfixes

  • Realm Swift APIs that filter or look up the index of an object based on a format string now properly handle optional arguments in their variadic argument list.

3.0.0-beta.3 Release notes (2017-08-23)

Breaking Changes

  • iOS 7 is no longer supported.
  • Computed properties on Realm object types are detected and no longer added to the automatically generated schema.
  • -[RLMRealm addOrUpdateObjectsInArray:] has been renamed to -[RLMRealm addOrUpdateObjects:] for consistency with similar methods that add or delete objects.
  • -[RLMRealm addOrUpdateObjects:] and -[RLMRealm deleteObjects:] now require their argument to conform to NSFastEnumeration, to match similar APIs that also take collections.
  • Remove deprecated {RLM}SyncPermission and {RLM}SyncPermissionChange classes.
  • {RLM}SyncPermissionValue has been renamed to just {RLM}SyncPermission. Its userId property has been renamed identity, and its -initWithRealmPath:userID:accessLevel: initializer has been renamed -initWithRealmPath:identity:accessLevel:.
  • Remove deprecated -[RLMSyncUser permissionRealmWithError:] and SyncUser.permissionRealm() APIs. Use the new permissions system.
  • Remove deprecated error RLMSyncErrorBadResponse. Use RLMSyncAuthErrorBadResponse instead.
  • The way interactive sync errors (client reset and permission denied) are delivered to the user has been changed. Instead of a block which can be invoked to immediately delete the offending Realm file, an opaque token object of type RLMSyncErrorActionToken will be returned in the error object's userInfo dictionary. This error object can be passed into the new +[RLMSyncSession immediatelyHandleError:] API to delete the files.
  • Remove -[NSError rlmSync_clientResetBlock] and -[NSError rlmSync_deleteRealmBlock] APIs.
  • The return types of the SyncError.clientResetInfo() and SyncError.deleteRealmUserInfo() APIs have been changed. They now return RLMSyncErrorActionTokens or SyncError.ActionTokens instead of closures.
  • The (erroneously added) instance property Object.className has been removed.
  • The class methods Object.className(), Object.objectUtilClass(), and the property Object.isInvalidated can no longer be overriden.
  • The callback which runs when a sync user login succeeds or fails now runs on the main queue by default, or can be explicitly specified by a new callbackQueue parameter on the {RLM}SyncUser.logIn(...) API.
  • Rename {RLM}NotificationToken.stop() to invalidate() and {RealmCollection,SyncPermissionResults}.addNotificationBlock(_:) to observe(_:) to mirror Foundation's new KVO APIs.
  • The RLMSyncProgress enum has been renamed RLMSyncProgressMode.
  • Remove deprecated {RLM}SyncManager.disableSSLValidation property. Disable SSL validation on a per-Realm basis by setting the enableSSLValidation property on {RLM}SyncConfiguration instead.
  • Fix empty strings, binary data, and null on the right side of BEGINSWITH, ENDSWITH and CONTAINS operators in predicates to match Foundation's semantics of never matching any strings or data.
  • Swift Object comparison and hashing behavior now works the same way as that of RLMObject (objects are now only considered equatable if their model class defines a primary key).
  • Fix the way the hash property works on Object when the object model has no primary key.
  • Fix an issue where if a Swift model class defined non-generic managed properties after generic Realm properties (like List<T>), the schema would be constructed incorrectly. Fixes an issue where creating such models from an array could fail.

Enhancements

  • Add Swift Object.isSameObject(as:_) API to perform the same function as the existing Objective-C API -[RLMObject isEqualToObject:].
  • Expose additional authentication-related errors that might be reported by a Realm Object Server.
  • An error handler can now be registered on {RLM}SyncUsers in order to report authentication-related errors that affect the user.

Bugfixes

  • Sync users are now automatically logged out upon receiving certain types of errors that indicate they are no longer logged into the server. For example, users who are authenticated using third-party credentials will find themselves logged out of the Realm Object Server if the third-party identity service indicates that their credential is no longer valid.
  • Address high CPU usage and hangs in certain cases when processing collection notifications in highly-connected object graphs.

3.0.0-beta.2 Release notes (2017-07-26)

Breaking Changes

  • Remove the following deprecated Objective-C APIs: -[RLMArray sortedResultsUsingProperty:ascending:], -[RLMCollection sortedResultsUsingProperty:ascending:], -[RLMResults sortedResultsUsingProperty:ascending:], +[RLMSortDescriptor sortDescriptorWithProperty:ascending:], RLMSortDescriptor.property. These APIs have been superseded by equivalent APIs that take or return key paths instead of property names.
  • Remove the following deprecated Objective-C API: +[RLMRealm migrateRealm:configuration:]. Please use +[RLMRealm performMigrationForConfiguration:error:] instead.
  • Remove the following deprecated Swift APIs: AnyRealmCollection.sorted(byProperty:, ascending:), LinkingObjects.sorted(byProperty:, ascending:), List.sorted(byProperty:, ascending:), Results.sorted(byProperty:, ascending:), SortDescriptor.init(property:, ascending:), SortDescriptor.property. These APIs have been superseded by equivalent APIs that take or return key paths instead of property names.
  • The Objective-C and Swift create(_:, value: update:) APIs now correctly nil out nullable properties when updating an existing object when the value argument specifies nil or NSNull for the property value.

Enhancements

  • It is now possible to create and log in multiple Realm Object Server users with the same identity if they originate from different servers. Note that if the URLs are different aliases for the same authentication server each user will still be treated as separate (e.g. they will have their own copy of each synchronized Realm opened using them). It is highly encouraged that users defined using the access token credential type be logged in with an authentication server URL specified; this parameter will become mandatory in a future version of the SDK.
  • Add -[RLMSyncUser retrieveInfoForUser:identityProvider:completion:] API allowing administrator users to retrieve information about a user based on their provider identity (for example, a username). Requires any edition of the Realm Object Server 1.8.2 or later.

Bugfixes

  • Realm no longer throws an "unsupported instruction" exception in some cases when opening a synced Realm asynchronously.

3.0.0-beta Release notes (2017-07-14)

Breaking Changes

  • Synchronized Realms require a server running Realm Object Server v2.0 or higher.

Enhancements

  • Add a new error code to denote 'permission denied' errors when working with synchronized Realms, as well as an accompanying block that can be called to inform the binding that the offending Realm's files should be deleted immediately. This allows recovering from 'permission denied' errors in a more robust manner. See the documentation for RLMSyncErrorPermissionDeniedError for more information.
  • Add -[RLMSyncPermissionValue initWithRealmPath:username:accessLevel:] API allowing permissions to be applied to a user based on their username (usually, an email address). Requires any edition of the Realm Object Server 1.6.0 or later.
  • Improve performance of creating Swift objects which contain at least one List property.

Bugfixes

  • List.description now reports the correct types for nested lists.
  • Fix unmanaged object initialization when a nested property type returned false from Object.shouldIncludeInDefaultSchema().
  • Don't clear RLMArrays on self-assignment.

2.10.2 Release notes (2017-09-27)

Bugfixes

  • The keychain item name used by Realm to manage the encryption keys for sync-related metadata is now set to a per-app name based on the bundle identifier. Keys that were previously stored within the single, shared Realm keychain item will be transparently migrated to the per-application keychain item.
  • Fix downloading of the Realm core binaries when Xcode's command-line tools are set as the active developer directory for command-line interactions.
  • Fix a crash that could occur when resolving a ThreadSafeReference to a List whose parent object had since been deleted.

2.10.1 Release notes (2017-09-14)

Swift binaries are now produced for Swift 3.0, 3.0.1, 3.0.2, 3.1, 3.2 and 4.0.

Enhancements

  • Auxiliary files are excluded from backup by default.

Bugfixes

  • Fix more cases where assigning an RLMArray property to itself would clear the RLMArray.

2.10.0 Release notes (2017-08-21)

API Breaking Changes

  • None.

Enhancements

  • Expose additional authentication-related errors that might be reported by a Realm Object Server.
  • An error handler can now be registered on {RLM}SyncUsers in order to report authentication-related errors that affect the user.

Bugfixes

  • Sorting Realm collection types no longer throws an exception on iOS 7.
  • Sync users are now automatically logged out upon receiving certain types of errors that indicate they are no longer logged into the server. For example, users who are authenticated using third-party credentials will find themselves logged out of the Realm Object Server if the third-party identity service indicates that their credential is no longer valid.
  • Address high CPU usage and hangs in certain cases when processing collection notifications in highly-connected object graphs.

2.9.1 Release notes (2017-08-01)

API Breaking Changes

  • None.

Enhancements

  • None.

Bugfixes

  • The shouldCompactOnLaunch block is no longer invoked if the Realm at that path is already open on other threads.
  • Fix an assertion failure in collection notifications when changes are made to the schema via sync while the notification block is active.

2.9.0 Release notes (2017-07-26)

API Breaking Changes

  • None.

Enhancements

  • Add a new error code to denote 'permission denied' errors when working with synchronized Realms, as well as an accompanying block that can be called to inform the binding that the offending Realm's files should be deleted immediately. This allows recovering from 'permission denied' errors in a more robust manner. See the documentation for RLMSyncErrorPermissionDeniedError for more information.
  • Add -[RLMSyncPermissionValue initWithRealmPath:username:accessLevel:] API allowing permissions to be applied to a user based on their username (usually, an email address). Requires any edition of the Realm Object Server 1.6.0 or later.
  • Improve performance of creating Swift objects which contain at least one List property.
  • It is now possible to create and log in multiple Realm Object Server users with the same identity if they originate from different servers. Note that if the URLs are different aliases for the same authentication server each user will still be treated as separate (e.g. they will have their own copy of each synchronized Realm opened using them). It is highly encouraged that users defined using the access token credential type be logged in with an authentication server URL specified; this parameter will become mandatory in a future version of the SDK.
  • Add -[RLMSyncUser retrieveInfoForUser:identityProvider:completion:] API allowing administrator users to retrieve information about a user based on their provider identity (for example, a username). Requires any edition of the Realm Object Server 1.8.2 or later.

Bugfixes

  • List.description now reports the correct types for nested lists.
  • Fix unmanaged object initialization when a nested property type returned false from Object.shouldIncludeInDefaultSchema().
  • Don't clear RLMArrays on self-assignment.

2.8.3 Release notes (2017-06-20)

Bugfixes

  • Properly update RealmOptional properties when adding an object with add(update: true).
  • Add some missing quotes in error messages.
  • Fix a performance regression when creating objects with primary keys.

2.8.2 Release notes (2017-06-16)

Bugfixes

  • Fix an issue where synchronized Realms would eventually disconnect from the remote server if the user object used to define their sync configuration was destroyed.
  • Restore support for changing primary keys in migrations (broken in 2.8.0).
  • Revert handling of adding objects with nil properties to a Realm to the pre-2.8.0 behavior.

2.8.1 Release notes (2017-06-12)

Add support for building with Xcode 9 Beta 1.

Bugfixes

  • Fix setting a float property to NaN.
  • Fix a crash when using compact on launch in combination with collection notifications.

2.8.0 Release notes (2017-06-02)

API Breaking Changes

  • None.

Enhancements

  • Enable encryption on watchOS.
  • Add -[RLMSyncUser changePassword:forUserID:completion:] API to change an arbitrary user's password if the current user has administrative privileges and using Realm's 'password' authentication provider. Requires any edition of the Realm Object Server 1.6.0 or later.

Bugfixes

  • Suppress -Wdocumentation warnings in Realm C++ headers when using CocoaPods with Xcode 8.3.2.
  • Throw an appropriate error rather than crashing when an RLMArray is assigned to an RLMArray property of a different type.
  • Fix crash in large (>4GB) encrypted Realm files.
  • Improve accuracy of sync progress notifications.
  • Fix an issue where synchronized Realms did not connect to the remote server in certain situations, such as when an application was offline when the Realms were opened but later regained network connectivity.

2.7.0 Release notes (2017-05-03)

API Breaking Changes

  • None.

Enhancements

  • Use reachability API to minimize the reconnection delay if the network connection was lost.
  • Add -[RLMSyncUser changePassword:completion:] API to change the current user's password if using Realm's 'password' authentication provider. Requires any edition of the Realm Object Server 1.4.0 or later.
  • {RLM}SyncConfiguration now has an enableSSLValidation property (and default parameter in the Swift initializer) to allow SSL validation to be specified on a per-server basis.
  • Transactions between a synced Realm and a Realm Object Server can now exceed 16 MB in size.
  • Add new APIs for changing and retrieving permissions for synchronized Realms. These APIs are intended to replace the existing Realm Object-based permissions system. Requires any edition of the Realm Object Server 1.1.0 or later.

Bugfixes

  • Support Realm model classes defined in Swift with overridden Objective-C names (e.g. @objc(Foo) class SwiftFoo: Object {}).
  • Fix -[RLMMigration enumerateObjects:block:] returning incorrect oldObject objects when enumerating a class name after previously deleting a newObject.
  • Fix an issue where Realm.asyncOpen(...) would fail to work when opening a synchronized Realm for which the user only had read permissions.
  • Using KVC to set a List property to nil now clears it to match the behavior of RLMArray properties.
  • Fix crash from !m_awaiting_pong assertion failure when using synced Realms.
  • Fix poor performance or hangs when performing case-insensitive queries on indexed string properties that contain many characters that don't differ between upper and lower case (e.g., numbers, punctuation).

2.6.2 Release notes (2017-04-21)

API Breaking Changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fix an issue where calling Realm.asyncOpen(...) with a synchronized Realm configuration would fail with an "Operation canceled" error.
  • Fix initial collection notification sometimes not being delivered for synced Realms.
  • Fix circular links sometimes resulting in objects not being marked as modified in change notifications.

2.6.1 Release notes (2017-04-18)

API Breaking Changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fix an issue where calling Realm.asyncOpen(...) with a synchronized Realm configuration would crash in error cases rather than report the error. This is a small source breaking change if you were relying on the error being reported to be a Realm.Error.

2.6.0 Release notes (2017-04-18)

API Breaking Changes

  • None.

Enhancements

  • Add a {RLM}SyncUser.isAdmin property indicating whether a user is a Realm Object Server administrator.
  • Add an API to asynchronously open a Realm and deliver it to a block on a given queue. This performs all work needed to get the Realm to a usable state (such as running potentially time-consuming migrations) on a background thread before dispatching to the given queue. In addition, synchronized Realms wait for all remote content available at the time the operation began to be downloaded and available locally.
  • Add shouldCompactOnLaunch block property when configuring a Realm to determine if it should be compacted before being returned.
  • Speed up case-insensitive queries on indexed string properties.
  • Add RLMResults's collection aggregate methods to RLMArray.
  • Add support for calling the aggregate methods on unmanaged Lists.

Bugfixes

  • Fix a deadlock when multiple processes open a Realm at the same time.
  • Fix value(forKey:)/value(forKeyPath:) returning incorrect values for List properties.

2.5.1 Release notes (2017-04-05)

API Breaking Changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fix CocoaPods installation with static libraries and multiple platforms.
  • Fix uncaught "Bad version number" exceptions on the notification worker thread followed by deadlocks when Realms refresh.

2.5.0 Release notes (2017-03-28)

Files written by Realm this version cannot be read by earlier versions of Realm. Old files can still be opened and files open in read-only mode will not be modified.

If using synchronized Realms, the Realm Object Server must be running version 1.3.0 or later.

Swift binaries are now produced for Swift 3.0, 3.0.1, 3.0.2 and 3.1.

API Breaking Changes

  • None.

Enhancements

  • Add support for multi-level object equality comparisons against NULL.
  • Add support for the [d] modifier on string comparison operators to perform diacritic-insensitive comparisons.
  • Explicitly mark [[RLMRealm alloc] init] as unavailable.
  • Include the name of the problematic class in the error message when an invalid property type is marked as the primary key.

Bugfixes

  • Fix incorrect column type assertions which could occur after schemas were merged by sync.
  • Eliminate an empty write transaction when opening a synced Realm.
  • Support encrypting synchronized Realms by respecting the encryptionKey value of the Realm's configuration.
  • Fix crash when setting an {NS}Data property close to 16MB.
  • Fix for reading {NS}Data properties incorrectly returning nil.
  • Reduce file size growth in cases where Realm versions were pinned while starting write transactions.
  • Fix an assertion failure when writing to large RLMArray/List properties.
  • Fix uncaught BadTransactLog exceptions when pulling invalid changesets from synchronized Realms.
  • Fix an assertion failure when an observed RLMArray/List is deleted after being modified.

2.4.4 Release notes (2017-03-13)

API Breaking Changes

  • None.

Enhancements

  • Add (RLM)SyncPermission class to allow reviewing access permissions for Realms. Requires any edition of the Realm Object Server 1.1.0 or later.
  • Further reduce the number of files opened per thread-specific Realm on macOS, iOS and watchOS.

Bugfixes

  • Fix a crash that could occur if new Realm instances were created while the application was exiting.
  • Fix a bug that could lead to bad version number errors when delivering change notifications.
  • Fix a potential use-after-free bug when checking validity of results.
  • Fix an issue where a sync session might not close properly if it receives an error while being torn down.
  • Fix some issues where a sync session might not reconnect to the server properly or get into an inconsistent state if revived after invalidation.
  • Fix an issue where notifications might not fire when the children of an observed object are changed.
  • Fix an issue where progress notifications on sync sessions might incorrectly report out-of-date values.
  • Fix an issue where multiple threads accessing encrypted data could result in corrupted data or crashes.
  • Fix an issue where certain LIKE queries could hang.
  • Fix an issue where -[RLMRealm writeCopyToURL:encryptionKey:error] could create a corrupt Realm file.
  • Fix an issue where incrementing a synced Realm's schema version without actually changing the schema could cause a crash.

2.4.3 Release notes (2017-02-20)

API Breaking Changes

  • None.

Enhancements

  • Avoid copying copy-on-write data structures, which can grow the file, when the write does not actually change existing values.
  • Improve performance of deleting all objects in an RLMResults.
  • Reduce the number of files opened per thread-specific Realm on macOS.
  • Improve startup performance with large numbers of RLMObject/Object subclasses.

Bugfixes

  • Fix synchronized Realms not downloading remote changes when an access token expires and there are no local changes to upload.
  • Fix an issue where values set on a Realm object using setValue(value:, forKey:) that were not themselves Realm objects were not properly converted into Realm objects or checked for validity.
  • Fix an issue where -[RLMSyncUser sessionForURL:] could erroneously return a non-nil value when passed in an invalid URL.
  • SyncSession.Progress.fractionTransferred now returns 1 if there are no transferrable bytes.
  • Fix sync progress notifications registered on background threads by always dispatching on a dedicated background queue.
  • Fix compilation issues with Xcode 8.3 beta 2.
  • Fix incorrect sync progress notification values for Realms originally created using a version of Realm prior to 2.3.0.
  • Fix LLDB integration to be able to display summaries of RLMResults once more.
  • Reject Swift properties with names which cause them to fall in to ARC method families rather than crashing when they are accessed.
  • Fix sorting by key path when the declared property order doesn't match the order of properties in the Realm file, which can happen when properties are added in different schema versions.

2.4.2 Release notes (2017-01-30)

Bugfixes

  • Fix an issue where RLMRealm instances could end up in the autorelease pool for other threads.

2.4.1 Release notes (2017-01-27)

Bugfixes

  • Fix an issue where authentication tokens were not properly refreshed automatically before expiring.

2.4.0 Release notes (2017-01-26)

This release drops support for compiling with Swift 2.x. Swift 3.0.0 is now the minimum Swift version supported.

API Breaking Changes

  • None.

Enhancements

  • Add change notifications for individual objects with an API similar to that of collection notifications.

Bugfixes

  • Fix Realm Objective-C compilation errors with Xcode 8.3 beta 1.
  • Fix several error handling issues when renewing expired authentication tokens for synchronized Realms.
  • Fix a race condition leading to bad_version exceptions being thrown in Realm's background worker thread.

2.3.0 Release notes (2017-01-19)

Sync Breaking Changes

  • Make PermissionChange's id property a primary key.

API Breaking Changes

  • None.

Enhancements

  • Add SyncPermissionOffer and SyncPermissionOfferResponse classes to allow creating and accepting permission change events to synchronized Realms between different users.
  • Support monitoring sync transfer progress by registering notification blocks on SyncSession. Specify the transfer direction (.upload/.download) and mode (.reportIndefinitely/.forCurrentlyOutstandingWork) to monitor.

Bugfixes

  • Fix a call to commitWrite(withoutNotifying:) committing a transaction that would not have triggered a notification incorrectly skipping the next notification.
  • Fix incorrect results and crashes when conflicting object insertions are merged by the synchronization mechanism when there is a collection notification registered for that object type.

2.2.0 Release notes (2017-01-12)

Sync Breaking Changes (In Beta)

  • Sync-related error reporting behavior has been changed. Errors not related to a particular user or session are only reported if they are classed as 'fatal' by the underlying sync engine.
  • Added RLMSyncErrorClientResetError to RLMSyncError enum.

API Breaking Changes

  • The following Objective-C APIs have been deprecated in favor of newer or preferred versions:
Deprecated API New API
-[RLMArray sortedResultsUsingProperty:] -[RLMArray sortedResultsUsingKeyPath:]
-[RLMCollection sortedResultsUsingProperty:] -[RLMCollection sortedResultsUsingKeyPath:]
-[RLMResults sortedResultsUsingProperty:] -[RLMResults sortedResultsUsingKeyPath:]
+[RLMSortDescriptor sortDescriptorWithProperty:ascending] +[RLMSortDescriptor sortDescriptorWithKeyPath:ascending:]
RLMSortDescriptor.property RLMSortDescriptor.keyPath
  • The following Swift APIs have been deprecated in favor of newer or preferred versions:
Deprecated API New API
LinkingObjects.sorted(byProperty:ascending:) LinkingObjects.sorted(byKeyPath:ascending:)
List.sorted(byProperty:ascending:) List.sorted(byKeyPath:ascending:)
RealmCollection.sorted(byProperty:ascending:) RealmCollection.sorted(byKeyPath:ascending:)
Results.sorted(byProperty:ascending:) Results.sorted(byKeyPath:ascending:)
SortDescriptor(property:ascending:) SortDescriptor(keyPath:ascending:)
SortDescriptor.property SortDescriptor.keyPath

Enhancements

  • Introduce APIs for safely passing objects between threads. Create a thread-safe reference to a thread-confined object by passing it to the +[RLMThreadSafeReference referenceWithThreadConfined:]/ThreadSafeReference(to:) constructor, which you can then safely pass to another thread to resolve in the new Realm with -[RLMRealm resolveThreadSafeReference:]/Realm.resolve(_:).
  • Realm collections can now be sorted by properties over to-one relationships.
  • Optimized CONTAINS queries to use Boyer-Moore algorithm (around 10x speedup on large datasets).

Bugfixes

  • Setting deleteRealmIfMigrationNeeded now also deletes the Realm if a file format migration is required, such as when moving from a file last accessed with Realm 0.x to 1.x, or 1.x to 2.x.
  • Fix queries containing nested SUBQUERY expressions.
  • Fix spurious incorrect thread exceptions when a thread id happens to be reused while an RLMRealm instance from the old thread still exists.
  • Fixed various bugs in aggregate methods (max, min, avg, sum).

2.1.2 Release notes (2016--12-19)

This release adds binary versions of Swift 3.0.2 frameworks built with Xcode 8.2.

Sync Breaking Changes (In Beta)

  • Rename occurences of "iCloud" with "CloudKit" in APIs and comments to match naming in the Realm Object Server.

API Breaking Changes

  • None.

Enhancements

  • Add support for 'LIKE' queries (wildcard matching).

Bugfixes

  • Fix authenticating with CloudKit.
  • Fix linker warning about "Direct access to global weak symbol".

2.1.1 Release notes (2016-12-02)

Enhancements

  • Add RealmSwift.ObjectiveCSupport.convert(object:) methods to help write code that interoperates between Realm Objective-C and Realm Swift APIs.
  • Throw exceptions when opening a Realm with an incorrect configuration, like:
    • readOnly set with a sync configuration.
    • readOnly set with a migration block.
    • migration block set with a sync configuration.
  • Greatly improve performance of write transactions which make a large number of changes to indexed properties, including the automatic migration when opening files written by Realm 1.x.

Bugfixes

  • Reset sync metadata Realm in case of decryption error.
  • Fix issue preventing using synchronized Realms in Xcode Playgrounds.
  • Fix assertion failure when migrating a model property from object type to RLMLinkingObjects type.
  • Fix a LogicError: Bad version number exception when using RLMResults with no notification blocks and explicitly called -[RLMRealm refresh] from that thread.
  • Logged-out users are no longer returned from +[RLMSyncUser currentUser] or +[RLMSyncUser allUsers].
  • Fix several issues which could occur when the 1001st object of a given type was created or added to an RLMArray/List, including crashes when rerunning existing queries and possibly data corruption.
  • Fix a potential crash when the application exits due to a race condition in the destruction of global static variables.
  • Fix race conditions when waiting for sync uploads or downloads to complete which could result in crashes or the callback being called too early.

2.1.0 Release notes (2016-11-18)

Sync Breaking Changes (In Beta)

  • None.

API breaking changes

  • None.

Enhancements

  • Add the ability to skip calling specific notification blocks when committing a write transaction.

Bugfixes

  • Deliver collection notifications when beginning a write transaction which advances the read version of a Realm (previously only Realm-level notifications were sent).
  • Fix some scenarios which would lead to inconsistent states when using collection notifications.
  • Fix several race conditions in the notification functionality.
  • Don't send Realm change notifications when canceling a write transaction.

2.0.4 Release notes (2016-11-14)

Sync Breaking Changes (In Beta)

  • Remove RLMAuthenticationActions and replace +[RLMSyncCredential credentialWithUsername:password:actions:] with +[RLMSyncCredential credentialsWithUsername:password:register:].
  • Rename +[RLMSyncUser authenticateWithCredential:] to +[RLMSyncUser logInWithCredentials:].
  • Rename "credential"-related types and methods to RLMSyncCredentials/SyncCredentials and consistently refer to credentials in the plural form.
  • Change +[RLMSyncUser all] to return a dictionary of identifiers to users and rename to:
    • +[RLMSyncUser allUsers] in Objective-C.
    • SyncUser.allUsers() in Swift 2.
    • SyncUser.all in Swift 3.
  • Rename SyncManager.sharedManager() to SyncManager.shared in Swift 3.
  • Change Realm.Configuration.syncConfiguration to take a SyncConfiguration struct rather than a named tuple.
  • +[RLMSyncUser logInWithCredentials:] now invokes its callback block on a background queue.

API breaking changes

  • None.

Enhancements

  • Add +[RLMSyncUser currentUser].
  • Add the ability to change read, write and management permissions for synchronized Realms using the management Realm obtained via the -[RLMSyncUser managementRealmWithError:] API and the RLMSyncPermissionChange class.

Bugfixes

  • None.

2.0.3 Release notes (2016-10-27)

This release adds binary versions of Swift 3.0.1 frameworks built with Xcode 8.1 GM seed.

API breaking changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fix a BadVersion exception caused by a race condition when delivering collection change notifications.
  • Fix an assertion failure when additional model classes are added and deleteRealmIfMigrationNeeded is enabled.
  • Fix a BadTransactLog exception when deleting an RLMResults in a synced Realm.
  • Fix an assertion failure when a write transaction is in progress at the point of process termination.
  • Fix a crash that could occur when working with a RLMLinkingObject property of an unmanaged object.

2.0.2 Release notes (2016-10-05)

This release is not protocol-compatible with previous version of the Realm Mobile Platform.

API breaking changes

  • Rename Realm Swift's User to SyncUser to make clear that it relates to the Realm Mobile Platform, and to avoid potential conflicts with other User types.

Bugfixes

  • Fix Realm headers to be compatible with pre-C++11 dialects of Objective-C++.
  • Fix incorrect merging of RLMArray/List changes when objects with the same primary key are created on multiple devices.
  • Fix bad transaction log errors after deleting objects on a different device.
  • Fix a BadVersion error when a background worker finishes running while older results from that worker are being delivered to a different thread.

2.0.1 Release notes (2016-09-29)

Bugfixes

  • Fix an assertion failure when opening a Realm file written by a 1.x version of Realm which has an indexed nullable int or bool property.

2.0.0 Release notes (2016-09-27)

This release introduces support for the Realm Mobile Platform! See https://realm.io/news/introducing-realm-mobile-platform/ for an overview of these great new features.

API breaking changes

  • By popular demand, RealmSwift.Error has been moved from the top-level namespace into a Realm extension and is now Realm.Error, so that it no longer conflicts with Swift.Error.
  • Files written by Realm 2.0 cannot be read by 1.x or earlier versions. Old files can still be opened.

Enhancements

  • The .log, .log_a and .log_b files no longer exist and the state tracked in them has been moved to the main Realm file. This reduces the number of open files needed by Realm, improves performance of both opening and writing to Realms, and eliminates a small window where committing write transactions would prevent other processes from opening the file.

Bugfixes

  • Fix an assertion failure when sorting by zero properties.
  • Fix a mid-commit crash in one process also crashing all other processes with the same Realm open.
  • Properly initialize new nullable float and double properties added to existing objects to null rather than 0.
  • Fix a stack overflow when objects with indexed string properties had very long common prefixes.
  • Fix a race condition which could lead to crashes when using async queries or collection notifications.
  • Fix a bug which could lead to incorrect state when an object which links to itself is deleted from the Realm.

1.1.0 Release notes (2016-09-16)

This release brings official support for Xcode 8, Swift 2.3 and Swift 3.0. Prebuilt frameworks are now built with Xcode 7.3.1 and Xcode 8.0.

API breaking changes

  • Deprecate migrateRealm: in favor of new performMigrationForConfiguration:error: method that follows Cocoa's NSError conventions.
  • Fix issue where RLMResults used id instead of its generic type as the return type of subscript.

Enhancements

  • Improve error message when using NSNumber incorrectly in Swift models.
  • Further reduce the download size of the prebuilt static libraries.
  • Improve sort performance, especially on non-nullable columns.
  • Allow partial initialization of object by initWithValue:, deferring required property checks until object is added to Realm.

Bugfixes

  • Fix incorrect truncation of the constant value for queries of the form column < value for float and double columns.
  • Fix crash when an aggregate is accessed as an Int8, Int16, Int32, or Int64.
  • Fix a race condition that could lead to a crash if an RLMArray or List was deallocated on a different thread than it was created on.
  • Fix a crash when the last reference to an observed object is released from within the observation.
  • Fix a crash when initWithValue: is used to create a nested object for a class with an uninitialized schema.
  • Enforce uniqueness for RealmOptional primary keys when using the value setter.

1.0.2 Release notes (2016-07-13)

API breaking changes

  • Attempting to add an object with no properties to a Realm now throws rather than silently doing nothing.

Enhancements

  • Swift: A write block may now throw, reverting any changes already made in the transaction.
  • Reduce address space used when committing write transactions.
  • Significantly reduce the download size of prebuilt binaries and slightly reduce the final size contribution of Realm to applications.
  • Improve performance of accessing RLMArray properties and creating objects with List properties.

Bugfixes

  • Fix a crash when reading the shared schema from an observed Swift object.
  • Fix crashes or incorrect results when passing an array of values to createOrUpdate after reordering the class's properties.
  • Ensure that the initial call of a Results notification block is always passed .Initial even if there is a write transaction between when the notification is added and when the first notification is delivered.
  • Fix a crash when deleting all objects in a Realm while fast-enumerating query results from that Realm.
  • Handle EINTR from flock() rather than crashing.
  • Fix incorrect behavior following a call to [RLMRealm compact].
  • Fix live updating and notifications for Results created from a predicate involving an inverse relationship to be triggered when an object at the other end of the relationship is modified.

1.0.1 Release notes (2016-06-12)

API breaking changes

  • None.

Enhancements

  • Significantly improve performance of opening Realm files, and slightly improve performance of committing write transactions.

Bugfixes

  • Swift: Fix an error thrown when trying to create or update Object instances via add(:_update:) with a primary key property of type RealmOptional.
  • Xcode playground in Swift release zip now runs successfully.
  • The key parameter of Realm.objectForPrimaryKey(_:key:)/ Realm.dynamicObjectForPrimaryKey(_:key:) is now marked as optional.
  • Fix a potential memory leak when closing Realms after a Realm file has been opened on multiple threads which are running in active run loops.
  • Fix notifications breaking on tvOS after a very large number of write transactions have been committed.
  • Fix a "Destruction of mutex in use" assertion failure after an error while opening a file.
  • Realm now throws an exception if an Object subclass is defined with a managed Swift lazy property. Objects with ignored lazy properties should now work correctly.
  • Update the LLDB script to work with recent changes to the implementation of RLMResults.
  • Fix an assertion failure when a Realm file is deleted while it is still open, and then a new Realm is opened at the same path. Note that this is still not a supported scenario, and may break in other ways.

1.0.0 Release notes (2016-05-25)

No changes since 0.103.2.

0.103.2 Release notes (2016-05-24)

API breaking changes

  • None.

Enhancements

  • Improve the error messages when an I/O error occurs in writeCopyToURL.

Bugfixes

  • Fix an assertion failure which could occur when opening a Realm after opening that Realm failed previously in some specific ways in the same run of the application.
  • Reading optional integers, floats, and doubles from within a migration block now correctly returns nil rather than 0 when the stored value is nil.

0.103.1 Release notes (2016-05-19)

API breaking changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fix a bug that sometimes resulted in a single object's NSData properties changing from nil to a zero-length non-nil NSData when a different object of the same type was deleted.

0.103.0 Release notes (2016-05-18)

API breaking changes

  • All functionality deprecated in previous releases has been removed entirely.
  • Support for Xcode 6.x & Swift prior to 2.2 has been completely removed.
  • RLMResults/Results now become empty when a RLMArray/List or object they depend on is deleted, rather than throwing an exception when accessed.
  • Migrations are no longer run when deleteRealmIfMigrationNeeded is set, recreating the file instead.

Enhancements

  • Added invalidated properties to RLMResults/Results, RLMLinkingObjects/LinkingObjects, RealmCollectionType and AnyRealmCollection. These properties report whether the Realm the object is associated with has been invalidated.
  • Some NSErrors created by Realm now have more descriptive user info payloads.

Bugfixes

  • None.

0.102.1 Release notes (2016-05-13)

API breaking changes

  • None.

Enhancements

  • Return RLMErrorSchemaMismatch error rather than the more generic RLMErrorFail when a migration is required.
  • Improve the performance of allocating instances of Object subclasses that have LinkingObjects properties.

Bugfixes

  • RLMLinkingObjects properties declared in Swift subclasses of RLMObject now work correctly.
  • Fix an assertion failure when deleting all objects of a type, inserting more objects, and then deleting some of the newly inserted objects within a single write transaction when there is an active notification block for a different object type which links to the objects being deleted.
  • Fix crashes and/or incorrect results when querying over multiple levels of LinkingObjects properties.
  • Fix opening read-only Realms on multiple threads at once.
  • Fix a BadTransactLog exception when storing dates before the unix epoch (1970-01-01).

0.102.0 Release notes (2016-05-09)

API breaking changes

  • None.

Enhancements

  • Add a method to rename properties during migrations:
    • Swift: Migration.renamePropertyForClass(_:oldName:newName:)
    • Objective-C: -[RLMMigration renamePropertyForClass:oldName:newName:]
  • Add deleteRealmIfMigrationNeeded to RLMRealmConfiguration/Realm.Configuration. When this is set to true, the Realm file will be automatically deleted and recreated when there is a schema mismatch rather than migrated to the new schema.

Bugfixes

  • Fix BETWEEN queries that traverse RLMArray/List properties to ensure that a single related object satisfies the BETWEEN criteria, rather than allowing different objects in the array to satisfy the lower and upper bounds.
  • Fix a race condition when a Realm is opened on one thread while it is in the middle of being closed on another thread which could result in crashes.
  • Fix a bug which could result in changes made on one thread being applied incorrectly on other threads when those threads are refreshed.
  • Fix crash when migrating to the new date format introduced in 0.101.0.
  • Fix crash when querying inverse relationships when objects are deleted.

0.101.0 Release notes (2016-05-04)

API breaking changes

  • Files written by this version of Realm cannot be read by older versions of Realm. Existing files will automatically be upgraded when they are opened.

Enhancements

  • Greatly improve performance of collection change calculation for complex object graphs, especially for ones with cycles.
  • NSDate properties now support nanoseconds precision.
  • Opening a single Realm file on multiple threads now shares a single memory mapping of the file for all threads, significantly reducing the memory required to work with large files.
  • Crashing while in the middle of a write transaction no longer blocks other processes from performing write transactions on the same file.
  • Improve the performance of refreshing a Realm (including via autorefresh) when there are live Results/RLMResults objects for that Realm.

Bugfixes

  • Fix an assertion failure of "!more_before || index >= std::prev(it)->second)" in IndexSet::do_add().
  • Fix a crash when an RLMArray or List object is destroyed from the wrong thread.

0.100.0 Release notes (2016-04-29)

API breaking changes

  • -[RLMObject linkingObjectsOfClass:forProperty] and Object.linkingObjects(_:forProperty:) are deprecated in favor of properties of type RLMLinkingObjects / LinkingObjects.

Enhancements

  • The automatically-maintained inverse direction of relationships can now be exposed as properties of type RLMLinkingObjects / LinkingObjects. These properties automatically update to reflect the objects that link to the target object, can be used in queries, and can be filtered like other Realm collection types.
  • Queries that compare objects for equality now support multi-level key paths.

Bugfixes

  • Fix an assertion failure when a second write transaction is committed after a write transaction deleted the object containing an RLMArray/List which had an active notification block.
  • Queries that compare RLMArray / List properties using != now give the correct results.

0.99.1 Release notes (2016-04-26)

API breaking changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fix a scenario that could lead to the assertion failure "m_advancer_sg->get_version_of_current_transaction() == new_notifiers.front()->version()".

0.99.0 Release notes (2016-04-22)

API breaking changes

  • Deprecate properties of type id/AnyObject. This type was rarely used, rarely useful and unsupported in every other Realm binding.
  • The block for -[RLMArray addNotificationBlock:] and -[RLMResults addNotificationBlock:] now takes another parameter.
  • The following Objective-C APIs have been deprecated in favor of newer or preferred versions:
Deprecated API New API
-[RLMRealm removeNotification:] -[RLMNotificationToken stop]
RLMRealmConfiguration.path RLMRealmConfiguration.fileURL
RLMRealm.path RLMRealmConfiguration.fileURL
RLMRealm.readOnly RLMRealmConfiguration.readOnly
+[RLMRealm realmWithPath:] +[RLMRealm realmWithURL:]
+[RLMRealm writeCopyToPath:error:] +[RLMRealm writeCopyToURL:encryptionKey:error:]
+[RLMRealm writeCopyToPath:encryptionKey:error:] +[RLMRealm writeCopyToURL:encryptionKey:error:]
+[RLMRealm schemaVersionAtPath:error:] +[RLMRealm schemaVersionAtURL:encryptionKey:error:]
+[RLMRealm schemaVersionAtPath:encryptionKey:error:] +[RLMRealm schemaVersionAtURL:encryptionKey:error:]
  • The following Swift APIs have been deprecated in favor of newer or preferred versions:
Deprecated API New API
Realm.removeNotification(_:) NotificationToken.stop()
Realm.Configuration.path Realm.Configuration.fileURL
Realm.path Realm.Configuration.fileURL
Realm.readOnly Realm.Configuration.readOnly
Realm.writeCopyToPath(_:encryptionKey:) Realm.writeCopyToURL(_:encryptionKey:)
schemaVersionAtPath(_:encryptionKey:error:) schemaVersionAtURL(_:encryptionKey:)

Enhancements

  • Add information about what rows were added, removed, or modified to the notifications sent to the Realm collections.
  • Improve error when illegally appending to an RLMArray / List property from a default value or the standalone initializer (init()) before the schema is ready.

Bugfixes

  • Fix a use-after-free when an associated object's dealloc method is used to remove observers from an RLMObject.
  • Fix a small memory leak each time a Realm file is opened.
  • Return a recoverable RLMErrorAddressSpaceExhausted error rather than crash when there is insufficient available address space on Realm initialization or write commit.

0.98.8 Release notes (2016-04-15)

API breaking changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fixed a bug that caused some encrypted files created using -[RLMRealm writeCopyToPath:encryptionKey:error:] to fail to open.

0.98.7 Release notes (2016-04-13)

API breaking changes

  • None.

Enhancements

  • None.

Bugfixes

  • Mark further initializers in Objective-C as NS_DESIGNATED_INITIALIZER to prevent that these aren't correctly defined in Swift Object subclasses, which don't qualify for auto-inheriting the required initializers.
  • -[RLMResults indexOfObjectWithPredicate:] now returns correct results for RLMResults instances that were created by filtering an RLMArray.
  • Adjust how RLMObjects are destroyed in order to support using an associated object on an RLMObject to remove KVO observers from that RLMObject.
  • -[RLMResults indexOfObjectWithPredicate:] now returns the index of the first matching object for a sorted RLMResults, matching its documented behavior.
  • Fix a crash when canceling a transaction that set a relationship.
  • Fix a crash when a query referenced a deleted object.

0.98.6 Release notes (2016-03-25)

Prebuilt frameworks are now built with Xcode 7.3.

API breaking changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fix running unit tests on iOS simulators and devices with Xcode 7.3.

0.98.5 Release notes (2016-03-14)

API breaking changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fix a crash when opening a Realm on 32-bit iOS devices.

0.98.4 Release notes (2016-03-10)

API breaking changes

  • None.

Enhancements

  • None.

Bugfixes

  • Properly report changes made by adding an object to a Realm with addOrUpdate:/createOrUpdate: to KVO observers for existing objects with that primary key.
  • Fix crashes and assorted issues when a migration which added object link properties is rolled back due to an error in the migration block.
  • Fix assertion failures when deleting objects within a migration block of a type which had an object link property added in that migration.
  • Fix an assertion failure in Query::apply_patch when updating certain kinds of queries after a write transaction is committed.

0.98.3 Release notes (2016-02-26)

Enhancements

  • Initializing the shared schema is 3x faster.

Bugfixes

  • Using Realm Objective-C from Swift while having Realm Swift linked no longer causes that the declared ignoredProperties are not taken into account.
  • Fix assertion failures when rolling back a migration which added Object link properties to a class.
  • Fix potential errors when cancelling a write transaction which modified multiple RLMArray/List properties.
  • Report the correct value for inWriteTransaction after attempting to commit a write transaction fails.
  • Support CocoaPods 1.0 beginning from prerelease 1.0.0.beta.4 while retaining backwards compatibility with 0.39.

0.98.2 Release notes (2016-02-18)

API breaking changes

  • None.

Enhancements

  • Aggregate operations (ANY, NONE, @count, SUBQUERY, etc.) are now supported for key paths that begin with an object relationship so long as there is a RLMArray/List property at some point in a key path.
  • Predicates of the form %@ IN arrayProperty are now supported.

Bugfixes

  • Use of KVC collection operators on Swift collection types no longer throws an exception.
  • Fix reporting of inWriteTransaction in notifications triggered by beginWriteTransaction.
  • The contents of List and Optional properties are now correctly preserved when copying a Swift object from one Realm to another, and performing other operations that result in a Swift object graph being recursively traversed from Objective-C.
  • Fix a deadlock when queries are performed within a Realm notification block.
  • The ANY / SOME / NONE qualifiers are now required in comparisons involving a key path that traverse a RLMArray/List property. Previously they were only required if the first key in the key path was an RLMArray/List property.
  • Fix several scenarios where the default schema would be initialized incorrectly if the first Realm opened used a restricted class subset (via objectClasses/objectTypes).

0.98.1 Release notes (2016-02-10)

Bugfixes

  • Fix crashes when deleting an object containing an RLMArray/List which had previously been queried.
  • Fix a crash when deleting an object containing an RLMArray/List with active notification blocks.
  • Fix duplicate file warnings when building via CocoaPods.
  • Fix crash or incorrect results when calling indexOfObject: on an RLMResults derived from an RLMArray.

0.98.0 Release notes (2016-02-04)

API breaking changes

  • +[RLMRealm realmWithPath:]/Realm.init(path:) now inherits from the default configuration.
  • Swift 1.2 is no longer supported.

Enhancements

  • Add addNotificationBlock to RLMResults, Results, RLMArray, and List, which calls the given block whenever the collection changes.
  • Do a lot of the work for keeping RLMResults/Results up-to-date after write transactions on a background thread to help avoid blocking the main thread.
  • NSPredicate's SUBQUERY operator is now supported. It has the following limitations:
    • @count is the only operator that may be applied to the SUBQUERY expression.
    • The SUBQUERY(…).@count expression must be compared with a constant.
    • Correlated subqueries are not yet supported.

Bugfixes

  • None.

0.97.1 Release notes (2016-01-29)

API breaking changes

  • None.

Enhancements

  • Swift: Added Error enum allowing to catch errors e.g. thrown on initializing RLMRealm/Realm instances.
  • Fail with RLMErrorFileNotFound instead of the more generic RLMErrorFileAccess, if no file was found when a realm was opened as read-only or if the directory part of the specified path was not found when a copy should be written.
  • Greatly improve performance when deleting objects with one or more indexed properties.
  • Indexing BOOL/Bool and NSDate properties are now supported.
  • Swift: Add support for indexing optional properties.

Bugfixes

  • Fix incorrect results or crashes when using -[RLMResults setValue:forKey:] on an RLMResults which was filtered on the key being set.
  • Fix crashes when an RLMRealm is deallocated from the wrong thread.
  • Fix incorrect results from aggregate methods on Results/RLMResults after objects which were previously in the results are deleted.
  • Fix a crash when adding a new property to an existing class with over a million objects in the Realm.
  • Fix errors when opening encrypted Realm files created with writeCopyToPath.
  • Fix crashes or incorrect results for queries that use relationship equality in cases where the RLMResults is kept alive and instances of the target class of the relationship are deleted.

0.97.0 Release notes (2015-12-17)

API breaking changes

  • All functionality deprecated in previous releases has been removed entirely.
  • Add generic type annotations to NSArrays and NSDictionaries in public APIs.
  • Adding a Realm notification block on a thread not currently running from within a run loop throws an exception rather than silently never calling the notification block.

Enhancements

  • Support for tvOS.
  • Support for building Realm Swift from source when using Carthage.
  • The block parameter of -[RLMRealm transactionWithBlock:]/Realm.write(_:) is now marked as __attribute__((noescape))/@noescape.
  • Many forms of queries with key paths on both sides of the comparison operator are now supported.
  • Add support for KVC collection operators in RLMResults and RLMArray.
  • Fail instead of deadlocking in +[RLMRealm sharedSchema], if a Swift property is initialized to a computed value, which attempts to open a Realm on its own.

Bugfixes

  • Fix poor performance when calling -[RLMRealm deleteObjects:] on an RLMResults which filtered the objects when there are other classes linking to the type of the deleted objects.
  • An exception is now thrown when defining Object properties of an unsupported type.

0.96.3 Release notes (2015-12-04)

Enhancements

  • Queries are no longer limited to 16 levels of grouping.
  • Rework the implementation of encrypted Realms to no longer interfere with debuggers.

Bugfixes

  • Fix crash when trying to retrieve object instances via dynamicObjects.
  • Throw an exception when querying on a link providing objects, which are from a different Realm.
  • Return empty results when querying on a link providing an unattached object.
  • Fix crashes or incorrect results when calling -[RLMRealm refresh] during fast enumeration.
  • Add Int8 support for RealmOptional, MinMaxType and AddableType.
  • Set the default value for newly added non-optional NSData properties to a zero-byte NSData rather than nil.
  • Fix a potential crash when deleting all objects of a class.
  • Fix performance problems when creating large numbers of objects with RLMArray/List properties.
  • Fix memory leak when using Object(value:) for subclasses with List or RealmOptional properties.
  • Fix a crash when computing the average of an optional integer property.
  • Fix incorrect search results for some queries on integer properties.
  • Add error-checking for nil realm parameters in many methods such as +[RLMObject allObjectsInRealm:].
  • Fix a race condition between commits and opening Realm files on new threads that could lead to a crash.
  • Fix several crashes when opening Realm files.
  • -[RLMObject createInRealm:withValue:], -[RLMObject createOrUpdateInRealm:withValue:], and their variants for the default Realm now always match the contents of an NSArray against properties in the same order as they are defined in the model.

0.96.2 Release notes (2015-10-26)

Prebuilt frameworks are now built with Xcode 7.1.

Bugfixes

  • Fix ignoring optional properties in Swift.
  • Fix CocoaPods installation on case-sensitive file systems.

0.96.1 Release notes (2015-10-20)

Bugfixes

  • Support assigning Results to List properties via KVC.
  • Honor the schema version set in the configuration in +[RLMRealm migrateRealm:].
  • Fix crash when using optional Int16/Int32/Int64 properties in Swift.

0.96.0 Release notes (2015-10-14)

  • No functional changes since beta2.

0.96.0-beta2 Release notes (2015-10-08)

Bugfixes

  • Add RLMOptionalBase.h to the podspec.

0.96.0-beta Release notes (2015-10-07)

API breaking changes

  • CocoaPods v0.38 or greater is now required to install Realm and RealmSwift as pods.

Enhancements

  • Functionality common to both List and Results is now declared in a RealmCollectionType protocol that both types conform to.
  • Results.realm now returns an Optional<Realm> in order to conform to RealmCollectionType, but will always return .Some() since a Results cannot exist independently from a Realm.
  • Aggregate operations are now available on List: min, max, sum, average.
  • Committing write transactions (via commitWrite / commitWriteTransaction and write / transactionWithBlock) now optionally allow for handling errors when the disk is out of space.
  • Added isEmpty property on RLMRealm/Realm to indicate if it contains any objects.
  • The @count, @min, @max, @sum and @avg collection operators are now supported in queries.

Bugfixes

  • Fix assertion failure when inserting NSData between 8MB and 16MB in size.
  • Fix assertion failure when rolling back a migration which removed an object link or RLMArray/List property.
  • Add the path of the file being opened to file open errors.
  • Fix a crash that could be triggered by rapidly opening and closing a Realm many times on multiple threads at once.
  • Fix several places where exception messages included the name of the wrong function which failed.

0.95.3 Release notes (2015-10-05)

Bugfixes

  • Compile iOS Simulator framework architectures with -fembed-bitcode-marker.
  • Fix crashes when the first Realm opened uses a class subset and later Realms opened do not.
  • Fix inconsistent errors when Object(value: ...) is used to initialize the default value of a property of an Object subclass.
  • Throw an exception when a class subset has objects with array or object properties of a type that are not part of the class subset.

0.95.2 Release notes (2015-09-24)

  • Enable bitcode for iOS and watchOS frameworks.
  • Build libraries with Xcode 7 final rather than the GM.

0.95.1 Release notes (2015-09-23)

Enhancements

  • Add missing KVO handling for moving and exchanging objects in RLMArray and List.

Bugfixes

  • Setting the primary key property on persisted RLMObjects / Objects via subscripting or key-value coding will cause an exception to be thrown.
  • Fix crash due to race condition in RLMRealmConfiguration where the default configuration was in the process of being copied in one thread, while released in another.
  • Fix crash when a migration which removed an object or array property is rolled back due to an error.

0.95.0 Release notes (2015-08-25)

API breaking changes

  • The following APIs have been deprecated in favor of the new RLMRealmConfiguration class in Realm Objective-C:
Deprecated API New API
+[RLMRealm realmWithPath:readOnly:error:] +[RLMRealm realmWithConfiguration:error:]
+[RLMRealm realmWithPath:encryptionKey:readOnly:error:] +[RLMRealm realmWithConfiguration:error:]
+[RLMRealm setEncryptionKey:forRealmsAtPath:] -[RLMRealmConfiguration setEncryptionKey:]
+[RLMRealm inMemoryRealmWithIdentifier:] +[RLMRealm realmWithConfiguration:error:]
+[RLMRealm defaultRealmPath] +[RLMRealmConfiguration defaultConfiguration]
+[RLMRealm setDefaultRealmPath:] +[RLMRealmConfiguration setDefaultConfiguration:]
+[RLMRealm setDefaultRealmSchemaVersion:withMigrationBlock] RLMRealmConfiguration.schemaVersion and RLMRealmConfiguration.migrationBlock
+[RLMRealm setSchemaVersion:forRealmAtPath:withMigrationBlock:] RLMRealmConfiguration.schemaVersion and RLMRealmConfiguration.migrationBlock
+[RLMRealm migrateRealmAtPath:] +[RLMRealm migrateRealm:]
+[RLMRealm migrateRealmAtPath:encryptionKey:] +[RLMRealm migrateRealm:]
  • The following APIs have been deprecated in favor of the new Realm.Configuration struct in Realm Swift for Swift 1.2:
Deprecated API New API
Realm.defaultPath Realm.Configuration.defaultConfiguration
Realm(path:readOnly:encryptionKey:error:) Realm(configuration:error:)
Realm(inMemoryIdentifier:) Realm(configuration:error:)
Realm.setEncryptionKey(:forPath:) Realm(configuration:error:)
setDefaultRealmSchemaVersion(schemaVersion:migrationBlock:) Realm.Configuration.schemaVersion and Realm.Configuration.migrationBlock
setSchemaVersion(schemaVersion:realmPath:migrationBlock:) Realm.Configuration.schemaVersion and Realm.Configuration.migrationBlock
migrateRealm(path:encryptionKey:) migrateRealm(configuration:)
  • The following APIs have been deprecated in favor of the new Realm.Configuration struct in Realm Swift for Swift 2.0:
Deprecated API New API
Realm.defaultPath Realm.Configuration.defaultConfiguration
Realm(path:readOnly:encryptionKey:) throws Realm(configuration:) throws
Realm(inMemoryIdentifier:) Realm(configuration:) throws
Realm.setEncryptionKey(:forPath:) Realm(configuration:) throws
setDefaultRealmSchemaVersion(schemaVersion:migrationBlock:) Realm.Configuration.schemaVersion and Realm.Configuration.migrationBlock
setSchemaVersion(schemaVersion:realmPath:migrationBlock:) Realm.Configuration.schemaVersion and Realm.Configuration.migrationBlock
migrateRealm(path:encryptionKey:) migrateRealm(configuration:)
  • List.extend in Realm Swift for Swift 2.0 has been replaced with List.appendContentsOf, mirroring changes to RangeReplaceableCollectionType.

  • Object properties on Object subclasses in Realm Swift must be marked as optional, otherwise a runtime exception will be thrown.

Enhancements

  • Persisted properties of RLMObject/Object subclasses are now Key-Value Observing compliant.
  • The different options used to create Realm instances have been consolidated into a single RLMRealmConfiguration/Realm.Configuration object.
  • Enumerating Realm collections (RLMArray, RLMResults, List<>, Results<>) now enumerates over a copy of the collection, making it no longer an error to modify a collection during enumeration (either directly, or indirectly by modifying objects to make them no longer match a query).
  • Improve performance of object insertion in Swift to bring it roughly in line with Objective-C.
  • Allow specifying a specific list of RLMObject / Object subclasses to include in a given Realm via RLMRealmConfiguration.objectClasses / Realm.Configuration.objectTypes.

Bugfixes

  • Subscripting on RLMObject is now marked as nullable.

0.94.1 Release notes (2015-08-10)

API breaking changes

  • Building for watchOS requires Xcode 7 beta 5.

Enhancements

  • Object.className is now marked as final.

Bugfixes

  • Fix crash when adding a property to a model without updating the schema version.
  • Fix unnecessary redownloading of the core library when building from source.
  • Fix crash when sorting by an integer or floating-point property on iOS 7.

0.94.0 Release notes (2015-07-29)

API breaking changes

  • None.

Enhancements

  • Reduce the amount of memory used by RLMRealm notification listener threads.
  • Avoid evaluating results eagerly when filtering and sorting.
  • Add nullability annotations to the Objective-C API to provide enhanced compiler warnings and bridging to Swift.
  • Make RLMResults and RLMArrays support Objective-C generics.
  • Add support for building watchOS and bitcode-compatible apps.
  • Make the exceptions thrown in getters and setters more informative.
  • Add -[RLMArray exchangeObjectAtIndex:withObjectAtIndex] and List.swap(_:_:) to allow exchanging the location of two objects in the given RLMArray / List.
  • Added anonymous analytics on simulator/debugger runs.
  • Add -[RLMArray moveObjectAtIndex:toIndex:] and List.move(from:to:) to allow moving objects in the given RLMArray / List.

Bugfixes

  • Processes crashing due to an uncaught exception inside a write transaction will no longer cause other processes using the same Realm to hang indefinitely.
  • Fix incorrect results when querying for < or <= on ints that require 64 bits to represent with a CPU that supports SSE 4.2.
  • An exception will no longer be thrown when attempting to reset the schema version or encryption key on an open Realm to the current value.
  • Date properties on 32 bit devices will retain 64 bit second precision.
  • Wrap calls to the block passed to enumerate in an autoreleasepool to reduce memory growth when migrating a large amount of objects.
  • In-memory realms no longer write to the Documents directory on iOS or Application Support on OS X.

0.93.2 Release notes (2015-06-12)

Bugfixes

  • Fixed an issue where the packaged OS X Realm.framework was built with GCC_GENERATE_TEST_COVERAGE_FILES and GCC_INSTRUMENT_PROGRAM_FLOW_ARCS enabled.
  • Fix a memory leak when constructing standalone Swift objects with NSDate properties.
  • Throw an exception rather than asserting when an invalidated object is added to an RLMArray.
  • Fix a case where data loss would occur if a device was hard-powered-off shortly after a write transaction was committed which had to expand the Realm file.

0.93.1 Release notes (2015-05-29)

Bugfixes

  • Objects are no longer copied into standalone objects during object creation. This fixes an issue where nested objects with a primary key are sometimes duplicated rather than updated.
  • Comparison predicates with a constant on the left of the operator and key path on the right now give correct results. An exception is now thrown for predicates that do not yet support this ordering.
  • Fix some crashes in index_string.cpp with int primary keys or indexed int properties.

0.93.0 Release notes (2015-05-27)

API breaking changes

  • Schema versions are now represented as uint64_t (Objective-C) and UInt64 (Swift) so that they have the same representation on all architectures.

Enhancements

  • Swift: Results now conforms to CVarArgType so it can now be passed as an argument to Results.filter(_:...) and List.filter(_:...).
  • Swift: Made SortDescriptor conform to the Equatable and StringLiteralConvertible protocols.
  • Int primary keys are once again automatically indexed.
  • Improve error reporting when attempting to mark a property of a type that cannot be indexed as indexed.

Bugfixes

  • Swift: RealmSwift.framework no longer embeds Realm.framework, which now allows apps using it to pass iTunes Connect validation.

0.92.4 Release notes (2015-05-22)

API breaking changes

  • None.

Enhancements

  • Swift: Made Object.init() a required initializer.
  • RLMObject, RLMResults, Object and Results can now be safely deallocated (but still not used) from any thread.
  • Improve performance of -[RLMArray indexOfObjectWhere:] and -[RLMArray indexOfObjectWithPredicate:], and implement them for standalone RLMArrays.
  • Improved performance of most simple queries.

Bugfixes

  • The interprocess notification mechanism no longer uses dispatch worker threads, preventing it from starving other GCD clients of the opportunity to execute blocks when dozens of Realms are open at once.

0.92.3 Release notes (2015-05-13)

API breaking changes

  • Swift: Results.average(_:) now returns an optional, which is nil if and only if the results set is empty.

Enhancements

  • Swift: Added List.invalidated, which returns if the given List is no longer safe to be accessed, and is analogous to -[RLMArray isInvalidated].
  • Assertion messages are automatically logged to Crashlytics if it's loaded into the current process to make it easier to diagnose crashes.

Bugfixes

  • Swift: Enumerating through a standalone List whose objects themselves have list properties won't crash.
  • Swift: Using a subclass of RealmSwift.Object in an aggregate operator of a predicate no longer throws a spurious type error.
  • Fix incorrect results for when using OR in a query on a RLMArray/List<>.
  • Fix incorrect values from [RLMResults count]/Results.count when using != on an int property with no other query conditions.
  • Lower the maximum doubling threshold for Realm file sizes from 128MB to 16MB to reduce the amount of wasted space.

0.92.2 Release notes (2015-05-08)

API breaking changes

  • None.

Enhancements

  • Exceptions raised when incorrect object types are used with predicates now contain more detailed information.
  • Added -[RLMMigration deleteDataForClassName:] and Migration.deleteData(_:) to enable cleaning up after removing object subclasses

Bugfixes

  • Prevent debugging of an application using an encrypted Realm to work around frequent LLDB hangs. Until the underlying issue is addressed you may set REALM_DISABLE_ENCRYPTION=YES in your application's environment variables to have requests to open an encrypted Realm treated as a request for an unencrypted Realm.
  • Linked objects are properly updated in createOrUpdateInRealm:withValue:.
  • List properties on Objects are now properly initialized during fast enumeration.

0.92.1 Release notes (2015-05-06)

API breaking changes

  • None.

Enhancements

  • -[RLMRealm inWriteTransaction] is now public.
  • Realm Swift is now available on CoocaPods.

Bugfixes

  • Force code re-signing after stripping architectures in strip-frameworks.sh.

0.92.0 Release notes (2015-05-05)

API breaking changes

  • Migration blocks are no longer called when a Realm file is first created.
  • The following APIs have been deprecated in favor of newer method names:
Deprecated API New API
-[RLMMigration createObject:withObject:] -[RLMMigration createObject:withValue:]
-[RLMObject initWithObject:] -[RLMObject initWithValue:]
+[RLMObject createInDefaultRealmWithObject:] +[RLMObject createInDefaultRealmWithValue:]
+[RLMObject createInRealm:withObject:] +[RLMObject createInRealm:withValue:]
+[RLMObject createOrUpdateInDefaultRealmWithObject:] +[RLMObject createOrUpdateInDefaultRealmWithValue:]
+[RLMObject createOrUpdateInRealm:withObject:] +[RLMObject createOrUpdateInRealm:withValue:]

Enhancements

  • Int8 properties defined in Swift are now treated as integers, rather than booleans.
  • NSPredicates created using +predicateWithValue: are now supported.

Bugfixes

  • Compound AND predicates with no subpredicates now correctly match all objects.

0.91.5 Release notes (2015-04-28)

Bugfixes

  • Fix issues with removing search indexes and re-enable it.

0.91.4 Release notes (2015-04-27)

Bugfixes

  • Temporarily disable removing indexes from existing columns due to bugs.

0.91.3 Release notes (2015-04-17)

Bugfixes

  • Fix Extra argument 'objectClassName' in call errors when building via CocoaPods.

0.91.2 Release notes (2015-04-16)

  • Migration blocks are no longer called when a Realm file is first created.

Enhancements

  • RLMCollection supports collection KVC operations.
  • Sorting RLMResults is 2-5x faster (typically closer to 2x).
  • Refreshing RLMRealm after a write transaction which inserts or modifies strings or NSData is committed on another thread is significantly faster.
  • Indexes are now added and removed from existing properties when a Realm file is opened, rather than only when properties are first added.

Bugfixes

  • +[RLMSchema dynamicSchemaForRealm:] now respects search indexes.
  • +[RLMProperty isEqualToProperty:] now checks for equal indexed properties.

0.91.1 Release notes (2015-03-12)

Enhancements

  • The browser will automatically refresh when the Realm has been modified from another process.
  • Allow using Realm in an embedded framework by setting APPLICATION_EXTENSION_API_ONLY to YES.

Bugfixes

  • Fix a crash in CFRunLoopSourceInvalidate.

0.91.0 Release notes (2015-03-10)

API breaking changes

  • attributesForProperty: has been removed from RLMObject. You now specify indexed properties by implementing the indexedProperties method.
  • An exception will be thrown when calling setEncryptionKey:forRealmsAtPath:, setSchemaVersion:forRealmAtPath:withMigrationBlock:, and migrateRealmAtPath: when a Realm at the given path is already open.
  • Object and array properties of type RLMObject will no longer be allowed.

Enhancements

  • Add support for sharing Realm files between processes.
  • The browser will no longer show objects that have no persisted properties.
  • RLMSchema, RLMObjectSchema, and RLMProperty now have more useful descriptions.
  • Opening an encrypted Realm while a debugger is attached to the process no longer throws an exception.
  • RLMArray now exposes an isInvalidated property to indicate if it can no longer be accessed.

Bugfixes

  • An exception will now be thrown when calling -beginWriteTransaction from within a notification triggered by calling -beginWriteTransaction elsewhere.
  • When calling delete: we now verify that the object being deleted is persisted in the target Realm.
  • Fix crash when calling createOrUpdate:inRealm with nested linked objects.
  • Use the key from +[RLMRealm setEncryptionKey:forRealmsAtPath:] in -writeCopyToPath:error: and +migrateRealmAtPath:.
  • Comparing an RLMObject to a non-RLMObject using -[RLMObject isEqual:] or -isEqualToObject: now returns NO instead of crashing.
  • Improved error message when an RLMObject subclass is defined nested within another Swift declaration.
  • Fix crash when the process is terminated by the OS on iOS while encrypted realms are open.
  • Fix crash after large commits to encrypted realms.

0.90.6 Release notes (2015-02-20)

Enhancements

  • Improve compatiblity of encrypted Realms with third-party crash reporters.

Bugfixes

  • Fix incorrect results when using aggregate functions on sorted RLMResults.
  • Fix data corruption when using writeCopyToPath:encryptionKey:.
  • Maybe fix some assertion failures.

0.90.5 Release notes (2015-02-04)

Bugfixes

  • Fix for crashes when encryption is enabled on 64-bit iOS devices.

0.90.4 Release notes (2015-01-29)

Bugfixes

  • Fix bug that resulted in columns being dropped and recreated during migrations.

0.90.3 Release notes (2015-01-27)

Enhancements

  • Calling createInDefaultRealmWithObject:, createInRealm:withObject:, createOrUpdateInDefaultRealmWithObject: or createOrUpdateInRealm:withObject: is a no-op if the argument is an RLMObject of the same type as the receiver and is already backed by the target realm.

Bugfixes

  • Fix incorrect column type assertions when the first Realm file opened is a read-only file that is missing tables.
  • Throw an exception when adding an invalidated or deleted object as a link.
  • Throw an exception when calling createOrUpdateInRealm:withObject: when the receiver has no primary key defined.

0.90.1 Release notes (2015-01-22)

Bugfixes

  • Fix for RLMObject being treated as a model object class and showing up in the browser.
  • Fix compilation from the podspec.
  • Fix for crash when calling objectsWhere: with grouping in the query on allObjects.

0.90.0 Release notes (2015-01-21)

API breaking changes

  • Rename -[RLMRealm encryptedRealmWithPath:key:readOnly:error:] to -[RLMRealm realmWithPath:encryptionKey:readOnly:error:].
  • -[RLMRealm setSchemaVersion:withMigrationBlock] is no longer global and must be called for each individual Realm path used. You can now call -[RLMRealm setDefaultRealmSchemaVersion:withMigrationBlock] for the default Realm and -[RLMRealm setSchemaVersion:forRealmAtPath:withMigrationBlock:] for all others;

Enhancements

  • Add -[RLMRealm writeCopyToPath:encryptionKey:error:].
  • Add support for comparing string columns to other string columns in queries.

Bugfixes

  • Roll back changes made when an exception is thrown during a migration.
  • Throw an exception if the number of items in a RLMResults or RLMArray changes while it's being fast-enumerated.
  • Also encrypt the temporary files used when encryption is enabled for a Realm.
  • Fixed crash in JSONImport example on OS X with non-en_US locale.
  • Fixed infinite loop when opening a Realm file in the Browser at the same time as it is open in a 32-bit simulator.
  • Fixed a crash when adding primary keys to older realm files with no primary keys on any objects.
  • Fixed a crash when removing a primary key in a migration.
  • Fixed a crash when multiple write transactions with no changes followed by a write transaction with changes were committed without the main thread RLMRealm getting a chance to refresh.
  • Fixed incomplete results when querying for non-null relationships.
  • Improve the error message when a Realm file is opened in multiple processes at once.

0.89.2 Release notes (2015-01-02)

API breaking changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fix an assertion failure when invalidating a Realm which is in a write transaction, has already been invalidated, or has never been used.
  • Fix an assertion failure when sorting an empty RLMArray property.
  • Fix a bug resulting in the browser never becoming visible on 10.9.
  • Write UTF-8 when generating class files from a realm file in the Browser.

0.89.1 Release notes (2014-12-22)

API breaking changes

  • None.

Enhancements

  • Improve the error message when a Realm can't be opened due to lacking write permissions.

Bugfixes

  • Fix an assertion failure when inserting rows after calling deleteAllObjects on a Realm.
  • Separate dynamic frameworks are now built for the simulator and devices to work around App Store submission errors due to the simulator version not being automatically stripped from dynamic libraries.

0.89.0 Release notes (2014-12-18)

API breaking changes

  • None.

Enhancements

  • Add support for encrypting Realm files on disk.
  • Support using KVC-compliant objects without getters or with custom getter names to initialize RLMObjects with createObjectInRealm and friends.

Bugfixes

  • Merge native Swift default property values with defaultPropertyValues().
  • Don't leave the database schema partially updated when opening a realm fails due to a migration being needed.
  • Fixed issue where objects with custom getter names couldn't be used to initialize other objects.
  • Fix a major performance regression on queries on string properties.
  • Fix a memory leak when circularly linked objects are added to a Realm.

0.88.0 Release notes (2014-12-02)

API breaking changes

  • Deallocating an RLMRealm instance in a write transaction lacking an explicit commit/cancel will now be automatically cancelled instead of committed.
  • -[RLMObject isDeletedFromRealm] has been renamed to -[RLMObject isInvalidated].

Enhancements

  • Add -[RLMRealm writeCopyToPath:] to write a compacted copy of the Realm another file.
  • Add support for case insensitive, BEGINSWITH, ENDSWITH and CONTAINS string queries on array properties.
  • Make fast enumeration of RLMArray and RLMResults ~30% faster and objectAtIndex: ~55% faster.
  • Added a lldb visualizer script for displaying the contents of persisted RLMObjects when debugging.
  • Added method -setDefaultRealmPath: to change the default Realm path.
  • Add -[RLMRealm invalidate] to release data locked by the current thread.

Bugfixes

  • Fix for crash when running many simultaneous write transactions on background threads.
  • Fix for crashes caused by opening Realms at multiple paths simultaneously which have had properties re-ordered during migration.
  • Don't run the query twice when firstObject or lastObject are called on an RLMResults which has not had its results accessed already.
  • Fix for bug where schema version is 0 for new Realm created at the latest version.
  • Fix for error message where no migration block is specified when required.

0.87.4 Release notes (2014-11-07)

API breaking changes

  • None.

Enhancements

  • None.

Bugfixes

  • Fix browser location in release zip.

0.87.3 Release notes (2014-11-06)

API breaking changes

  • None.

Enhancements

  • Added method -linkingObjectsOfClass:forProperty: to RLMObject to expose inverse relationships/backlinks.

Bugfixes

  • Fix for crash due to missing search index when migrating an object with a string primary key in a database created using an older versions (0.86.3 and earlier).
  • Throw an exception when passing an array containing a non-RLMObject to -[RLMRealm addObjects:].
  • Fix for crash when deleting an object from multiple threads.

0.87.0 Release notes (2014-10-21)

API breaking changes

  • RLMArray has been split into two classes, RLMArray and RLMResults. RLMArray is used for object properties as in previous releases. Moving forward all methods used to enumerate, query, and sort objects return an instance of a new class RLMResults. This change was made to support diverging apis and the future addition of change notifications for queries.
  • The api for migrations has changed. You now call setSchemaVersion:withMigrationBlock: to register a global migration block and associated version. This block is applied to Realms as needed when opened for Realms at a previous version. The block can be applied manually if desired by calling migrateRealmAtPath:.
  • arraySortedByProperty:ascending: was renamed to sortedResultsUsingProperty:ascending
  • addObjectsFromArray: on both RLMRealm and RLMArray has been renamed to addObjects: and now accepts any container class which implements NSFastEnumeration
  • Building with Swift support now requires Xcode 6.1

Enhancements

  • Add support for sorting RLMArrays by multiple columns with sortedResultsUsingDescriptors:
  • Added method deleteAllObjects on RLMRealm to clear a Realm.
  • Added method createObject:withObject: on RLMMigration which allows object creation during migrations.
  • Added method deleteObject: on RLMMigration which allows object deletion during migrations.
  • Updating to core library version 0.85.0.
  • Implement objectsWhere: and objectsWithPredicate: for array properties.
  • Add cancelWriteTransaction to revert all changes made in a write transaction and end the transaction.
  • Make creating RLMRealm instances on background threads when an instance exists on another thread take a fifth of the time.
  • Support for partial updates when calling createOrUpdateWithObject: and addOrUpdateObject:
  • Re-enable Swift support on OS X

Bugfixes

  • Fix exceptions when trying to set RLMObject properties after rearranging the properties in a RLMObject subclass.
  • Fix crash on IN query with several thousand items.
  • Fix crash when querying indexed NSString properties.
  • Fixed an issue which prevented in-memory Realms from being used accross multiple threads.
  • Preserve the sort order when querying a sorted RLMResults.
  • Fixed an issue with migrations where if a Realm file is deleted after a Realm is initialized, the newly created Realm can be initialized with an incorrect schema version.
  • Fix crash in RLMSuperSet when assigning to a RLMArray property on a standalone object.
  • Add an error message when the protocol for an RLMArray property is not a valid object type.
  • Add an error message when an RLMObject subclass is defined nested within another Swift class.

0.86.3 Release notes (2014-10-09)

Enhancements

  • Add support for != in queries on object relationships.

Bugfixes

  • Re-adding an object to its Realm no longer throws an exception and is now a no-op (as it was previously).
  • Fix another bug which would sometimes result in subclassing RLMObject subclasses not working.

0.86.2 Release notes (2014-10-06)

Bugfixes

  • Fixed issues with packaging "Realm Browser.app" for release.

0.86.1 Release notes (2014-10-03)

Bugfixes

  • Fix a bug which would sometimes result in subclassing RLMObject subclasses not working.

0.86.0 Release notes (2014-10-03)

API breaking changes

  • Xcode 6 is now supported from the main Xcode project Realm.xcodeproj. Xcode 5 is no longer supported.

Enhancements

  • Support subclassing RLMObject models. Although you can now persist subclasses, polymorphic behavior is not supported (i.e. setting a property to an instance of its subclass).
  • Add support for sorting RLMArray properties.
  • Speed up inserting objects with addObject: by ~20%.
  • readonly properties are automatically ignored rather than having to be added to ignoredProperties.
  • Updating to core library version 0.83.1.
  • Return "[deleted object]" rather than throwing an exception when -description is called on a deleted RLMObject.
  • Significantly improve performance of very large queries.
  • Allow passing any enumerable to IN clauses rather than just NSArray.
  • Add objectForPrimaryKey: and objectInRealm:forPrimaryKey: convenience methods to fetch an object by primary key.

Bugfixes

  • Fix error about not being able to persist property 'hash' with incompatible type when building for devices with Xcode 6.
  • Fix spurious notifications of new versions of Realm.
  • Fix for updating nested objects where some types do not have primary keys.
  • Fix for inserting objects from JSON with NSNull values when default values should be used.
  • Trying to add a persisted RLMObject to a different Realm now throws an exception rather than creating an uninitialized object.
  • Fix validation errors when using IN on array properties.
  • Fix errors when an IN clause has zero items.
  • Fix for chained queries ignoring all but the last query's conditions.

0.85.0 Release notes (2014-09-15)

API breaking changes

  • Notifications for a refresh being needed (when autorefresh is off) now send the notification type RLMRealmRefreshRequiredNotification rather than RLMRealmDidChangeNotification.

Enhancements

  • Updating to core library version 0.83.0.
  • Support for primary key properties (for int and string columns). Declaring a property to be the primary key ensures uniqueness for that property for all objects of a given type. At the moment indexes on primary keys are not yet supported but this will be added in a future release.
  • Added methods to update or insert (upsert) for objects with primary keys defined.
  • [RLMObject initWithObject:] and [RLMObject createInRealmWithObject:] now support any object type with kvc properties.
  • The Swift support has been reworked to work around Swift not being supported in Frameworks on iOS 7.
  • Improve performance when getting the count of items matching a query but not reading any of the objects in the results.
  • Add a return value to -[RLMRealm refresh] that indicates whether or not there was anything to refresh.
  • Add the class name to the error message when an RLMObject is missing a value for a property without a default.
  • Add support for opening Realms in read-only mode.
  • Add an automatic check for updates when using Realm in a simulator (the checker code is not compiled into device builds). This can be disabled by setting the REALM_DISABLE_UPDATE_CHECKER environment variable to any value.
  • Add support for Int16 and Int64 properties in Swift classes.

Bugfixes

  • Realm change notifications when beginning a write transaction are now sent after updating rather than before, to match refresh.
  • -isEqual: now uses the default NSObject implementation unless a primary key is specified for an RLMObject. When a primary key is specified, -isEqual: calls -isEqualToObject: and a corresponding implementation for -hash is also implemented.

0.84.0 Release notes (2014-08-28)

API breaking changes

  • The timer used to trigger notifications has been removed. Notifications are now only triggered by commits made in other threads, and can not currently be triggered by changes made by other processes. Interprocess notifications will be re-added in a future commit with an improved design.

Enhancements

  • Updating to core library version 0.82.2.
  • Add property deletedFromRealm to RLMObject to indicate objects which have been deleted.
  • Add support for the IN operator in predicates.
  • Add support for the BETWEEN operator in link queries.
  • Add support for multi-level link queries in predicates (e.g. foo.bar.baz = 5).
  • Switch to building the SDK from source when using CocoaPods and add a Realm.Headers subspec for use in targets that should not link a copy of Realm (such as test targets).
  • Allow unregistering from change notifications in the change notification handler block.
  • Significant performance improvements when holding onto large numbers of RLMObjects.
  • Realm-Xcode6.xcodeproj now only builds using Xcode6-Beta6.
  • Improved performance during RLMArray iteration, especially when mutating contained objects.

Bugfixes

  • Fix crashes and assorted bugs when sorting or querying a RLMArray returned from a query.
  • Notifications are no longer sent when initializing new RLMRealm instances on background threads.
  • Handle object cycles in -[RLMObject description] and -[RLMArray description].
  • Lowered the deployment target for the Xcode 6 projects and Swift examples to iOS 7.0, as they didn't actually require 8.0.
  • Support setting model properties starting with the letter 'z'
  • Fixed crashes that could result from switching between Debug and Relase builds of Realm.

0.83.0 Release notes (2014-08-13)

API breaking changes

  • Realm-Xcode6.xcodeproj now only builds using Xcode6-Beta5.
  • Properties to be persisted in Swift classes must be explicitly declared as dynamic.
  • Subclasses of RLMObject subclasses now throw an exception on startup, rather than when added to a Realm.

Enhancements

  • Add support for querying for nil object properties.
  • Improve error message when specifying invalid literals when creating or initializing RLMObjects.
  • Throw an exception when an RLMObject is used from the incorrect thread rather than crashing in confusing ways.
  • Speed up RLMRealm instantiation and array property iteration.
  • Allow array and objection relation properties to be missing or null when creating a RLMObject from a NSDictionary.

Bugfixes

  • Fixed a memory leak when querying for objects.
  • Fixed initializing array properties on standalone Swift RLMObject subclasses.
  • Fix for queries on 64bit integers.

0.82.0 Release notes (2014-08-05)

API breaking changes

  • Realm-Xcode6.xcodeproj now only builds using Xcode6-Beta4.

Enhancements

  • Updating to core library version 0.80.5.
  • Now support disabling the autorefresh property on RLMRealm instances.
  • Building Realm-Xcode6 for iOS now builds a universal framework for Simulator & Device.
  • Using NSNumber properties (unsupported) now throws a more informative exception.
  • Added [RLMRealm defaultRealmPath]
  • Proper implementation for [RLMArray indexOfObjectWhere:]
  • The default Realm path on OS X is now ~/Library/Application Support/[bundle identifier]/default.realm rather than ~/Documents
  • We now check that the correct framework (ios or osx) is used at compile time.

Bugfixes

  • Fixed rapid growth of the realm file size.
  • Fixed a bug which could cause a crash during RLMArray destruction after a query.
  • Fixed bug related to querying on float properties: floatProperty = 1.7 now works.
  • Fixed potential bug related to the handling of array properties (RLMArray).
  • Fixed bug where array properties accessed the wrong property.
  • Fixed bug that prevented objects with custom getters to be added to a Realm.
  • Fixed a bug where initializing a standalone object with an array literal would trigger an exception.
  • Clarified exception messages when using unsupported NSPredicate operators.
  • Clarified exception messages when using unsupported property types on RLMObject subclasses.
  • Fixed a memory leak when breaking out of a for-in loop on RLMArray.
  • Fixed a memory leak when removing objects from a RLMArray property.
  • Fixed a memory leak when querying for objects.

0.81.0 Release notes (2014-07-22)

API breaking changes

  • None.

Enhancements

  • Updating to core library version 0.80.3.
  • Added support for basic querying of RLMObject and RLMArray properties (one-to-one and one-to-many relationships). e.g. [Person objectsWhere:@"dog.name == 'Alfonso'"] or [Person objectsWhere:@"ANY dogs.name == 'Alfonso'"] Supports all normal operators for numeric and date types. Does not support NSData properties or BEGINSWITH, ENDSWITH, CONTAINS and other options for string properties.
  • Added support for querying for object equality in RLMObject and RLMArray properties (one-to-one and one-to-many relationships). e.g. [Person objectsWhere:@"dog == %@", myDog] [Person objectsWhere:@"ANY dogs == %@", myDog] [Person objectsWhere:@"ANY friends.dog == %@", dog] Only supports comparing objects for equality (i.e. ==)
  • Added a helper method to RLMRealm to perform a block inside a transaction.
  • OSX framework now supported in CocoaPods.

Bugfixes

  • Fixed Unicode support in property names and string contents (Chinese, Russian, etc.). Closing #612 and #604.
  • Fixed bugs related to migration when properties are removed.
  • Fixed keyed subscripting for standalone RLMObjects.
  • Fixed bug related to double clicking on a .realm file to launch the Realm Browser (thanks to Dean Moore).

0.80.0 Release notes (2014-07-15)

API breaking changes

  • Rename migration methods to -migrateDefaultRealmWithBlock: and -migrateRealmAtPath:withBlock:
  • Moved Realm specific query methods from RLMRealm to class methods on RLMObject (-allObjects: to +allObjectsInRealm: ect.)

Enhancements

  • Added +createInDefaultRealmWithObject: method to RLMObject.
  • Added support for array and object literals when calling -createWithObject: and -initWithObject: variants.
  • Added method -deleteObjects: to batch delete objects from a Realm
  • Support for defining RLMObject models entirely in Swift (experimental, see known issues).
  • RLMArrays in Swift support Sequence-style enumeration (for obj in array).
  • Implemented -indexOfObject: for RLMArray

Known Issues for Swift-defined models

  • Properties other than String, NSData and NSDate require a default value in the model. This can be an empty (but typed) array for array properties.
  • The previous caveat also implies that not all models defined in Objective-C can be used for object properties. Only Objective-C models with only implicit (i.e. primitives) or explicit default values can be used. However, any Objective-C model object can be used in a Swift array property.
  • Array property accessors don't work until its parent object has been added to a realm.
  • Realm-Bridging-Header.h is temporarily exposed as a public header. This is temporary and will be private again once rdar://17633863 is fixed.
  • Does not leverage Swift generics and still uses RLM-prefix everywhere. This is coming in #549.

0.22.0 Release notes

API breaking changes

  • Rename schemaForObject: to schemaForClassName: on RLMSchema
  • Removed -objects:where: and -objects:orderedBy:where: from RLMRealm
  • Removed -indexOfObjectWhere:, -objectsWhere: and -objectsOrderedBy:where: from RLMArray
  • Removed +objectsWhere: and +objectsOrderedBy:where: from RLMObject

Enhancements

  • New Xcode 6 project for experimental swift support.
  • New Realm Editor app for reading and editing Realm db files.
  • Added support for migrations.
  • Added support for RLMArray properties on objects.
  • Added support for creating in-memory default Realm.
  • Added -objectsWithClassName:predicateFormat: and -objectsWithClassName:predicate: to RLMRealm
  • Added -indexOfObjectWithPredicateFormat:, -indexOfObjectWithPredicate:, -objectsWithPredicateFormat:, -objectsWithPredi
  • Added +objectsWithPredicateFormat: and +objectsWithPredicate: to RLMObject
  • Now allows predicates comparing two object properties of the same type.

0.20.0 Release notes (2014-05-28)

Completely rewritten to be much more object oriented.

API breaking changes

  • Everything

Enhancements

  • None.

Bugfixes

  • None.

0.11.0 Release notes (not released)

The Objective-C API has been updated and your code will break!

API breaking changes

  • RLMTable objects can only be created with an RLMRealm object.
  • Renamed RLMContext to RLMTransactionManager
  • Renamed RLMContextDidChangeNotification to RLMRealmDidChangeNotification
  • Renamed contextWithDefaultPersistence to managerForDefaultRealm
  • Renamed contextPersistedAtPath: to managerForRealmWithPath:
  • Renamed realmWithDefaultPersistence to defaultRealm
  • Renamed realmWithDefaultPersistenceAndInitBlock to defaultRealmWithInitBlock
  • Renamed find: to firstWhere:
  • Renamed where: to allWhere:
  • Renamed where:orderBy: to allWhere:orderBy:

Enhancements

  • Added countWhere: on RLMTable
  • Added sumOfColumn:where: on RLMTable
  • Added averageOfColumn:where: on RLMTable
  • Added minOfProperty:where: on RLMTable
  • Added maxOfProperty:where: on RLMTable
  • Added toJSONString on RLMRealm, RLMTable and RLMView
  • Added support for NOT operator in predicates
  • Added support for default values
  • Added validation support in createInRealm:withObject:

Bugfixes

  • None.

0.10.0 Release notes (2014-04-23)

TightDB is now Realm! The Objective-C API has been updated and your code will break!

API breaking changes

  • All references to TightDB have been changed to Realm.
  • All prefixes changed from TDB to RLM.
  • TDBTransaction and TDBSmartContext have merged into RLMRealm.
  • Write transactions now take an optional rollback parameter (rather than needing to return a boolean).
  • addColumnWithName: and variant methods now return the index of the newly created column if successful, NSNotFound otherwise.

Enhancements

  • createTableWithName:columns: has been added to RLMRealm.
  • Added keyed subscripting for RLMTable's first column if column is of type RLMPropertyTypeString.
  • setRow:atIndex: has been added to RLMTable.
  • RLMRealm constructors now have variants that take an writable initialization block
  • New object interface - tables created/retrieved using tableWithName:objectClass: return custom objects

Bugfixes

  • None.

0.6.0 Release notes (2014-04-11)

API breaking changes

  • contextWithPersistenceToFile:error: renamed to contextPersistedAtPath:error: in TDBContext
  • readWithBlock: renamed to readUsingBlock: in TDBContext
  • writeWithBlock:error: renamed to writeUsingBlock:error: in TDBContext
  • readTable:withBlock: renamed to readTable:usingBlock: in TDBContext
  • writeTable:withBlock:error: renamed to writeTable:usingBlock:error: in TDBContext
  • findFirstRow renamed to indexOfFirstMatchingRow on TDBQuery.
  • findFirstRowFromIndex: renamed to indexOfFirstMatchingRowFromIndex: on TDBQuery.
  • Return NSNotFound instead of -1 when appropriate.
  • Renamed castClass to castToTytpedTableClass on TDBTable.
  • removeAllRows, removeRowAtIndex, removeLastRow, addRow and insertRow methods on table now return void instead of BOOL.

Enhancements

  • A TDBTable can now be queried using where: and where:orderBy: taking NSPredicate and NSSortDescriptor as arguments.
  • Added find: method on TDBTable to find first row matching predicate.
  • contextWithDefaultPersistence class method added to TDBContext. Will create a context persisted to a file in app/documents folder.
  • renameColumnWithIndex:to: has been added to TDBTable.
  • distinctValuesInColumnWithIndex has been added to TDBTable.
  • dateIsBetween::, doubleIsBetween::, floatIsBetween:: and intIsBetween:: have been added to TDBQuery.
  • Column names in Typed Tables can begin with non-capital letters too. The generated addX selector can look odd. For example, a table with one column with name age, appending a new row will look like [table addage:7].
  • Mixed typed values are better validated when rows are added, inserted, or modified as object literals.
  • addRow, insertRow, and row updates can be done using objects derived from NSObject.
  • where has been added to TDBViewand TDBViewProtocol.
  • Adding support for "smart" contexts (TDBSmartContext).

Bugfixes

  • Modifications of a TDBView and TDBQuery now throw an exception in a readtransaction.

0.5.0 Release notes (2014-04-02)

The Objective-C API has been updated and your code will break! Of notable changes a fast interface has been added. This interface includes specific methods to get and set values into Tightdb. To use these methods import <Tightdb/TightdbFast.h>.

API breaking changes

  • getTableWithName: renamed to tableWithName: in TDBTransaction.
  • addColumnWithName:andType: renamed to addColumnWithName:type: in TDBTable.
  • columnTypeOfColumn: renamed to columnTypeOfColumnWithIndex in TDBTable.
  • columnNameOfColumn: renamed to nameOfColumnWithIndex: in TDBTable.
  • addColumnWithName:andType: renamed to addColumnWithName:type: in TDBDescriptor.
  • Fast getters and setters moved from TDBRow.h to TDBRowFast.h.

Enhancements

  • Added minDateInColumnWithIndex and maxDateInColumnWithIndex to TDBQuery.
  • Transactions can now be started directly on named tables.
  • You can create dynamic tables with initial schema.
  • TDBTable and TDBView now have a shared protocol so they can easier be used interchangeably.

Bugfixes

  • Fixed bug in 64 bit iOS when inserting BOOL as NSNumber.

0.4.0 Release notes (2014-03-26)

API breaking changes

  • Typed interface Cursor has now been renamed to Row.
  • TDBGroup has been renamed to TDBTransaction.
  • Header files are renamed so names match class names.
  • Underscore (_) removed from generated typed table classes.
  • TDBBinary has been removed; use NSData instead.
  • Underscope (_) removed from generated typed table classes.
  • Constructor for TDBContext has been renamed to contextWithPersistenceToFile:
  • Table findFirstRow and min/max/sum/avg operations has been hidden.
  • Table.appendRow has been renamed to addRow.
  • getOrCreateTable on Transaction has been removed.
  • set*:inColumnWithIndex:atRowIndex: methods have been prefixed with TDB
  • *:inColumnWithIndex:atRowIndex: methods have been prefixed with TDB
  • addEmptyRow on table has been removed. Use [table addRow:nil] instead.
  • TDBMixed removed. Use id and NSObject instead.
  • insertEmptyRow has been removed from table. Use insertRow:nil atIndex:index instead.

Enhancements

  • Added firstRow, lastRow selectors on view.
  • firstRow and lastRow on table now return nil if table is empty.
  • getTableWithName selector added on group.
  • getting and creating table methods on group no longer take error argument.
  • [TDBQuery parent] and [TDBQuery subtable:] selectors now return self.
  • createTable method added on Transaction. Throws exception if table with same name already exists.
  • Experimental support for pinning transactions on Context.
  • TDBView now has support for object subscripting.

Bugfixes

  • None.

0.3.0 Release notes (2014-03-14)

The Objective-C API has been updated and your code will break!

API breaking changes

  • Most selectors have been renamed in the binding!
  • Prepend TDB-prefix on all classes and types.

Enhancements

  • Return types and parameters changed from size_t to NSUInteger.
  • Adding setObject to TightdbTable (t[2] = @[@1, @"Hello"] is possible).
  • Adding insertRow to TightdbTable.
  • Extending appendRow to accept NSDictionary.

Bugfixes

  • None.

0.2.0 Release notes (2014-03-07)

The Objective-C API has been updated and your code will break!

API breaking changes

  • addRow renamed to addEmptyRow

Enhancements

  • Adding a simple class for version numbering.
  • Adding get-version and set-version targets to build.sh.
  • tableview now supports sort on column with column type bool, date and int
  • tableview has method for checking the column type of a specified column
  • tableview has method for getting the number of columns
  • Adding methods getVersion, getCoreVersion and isAtLeast.
  • Adding appendRow to TightdbTable.
  • Adding object subscripting.
  • Adding method removeColumn on table.

Bugfixes

  • None.