All Versions
166
Latest Version
Avg Release Cycle
24 days
Latest Release
154 days ago

Changelog History
Page 1

  • v10.10.1 Changes

    January 26, 2022

    โœจ Enhancements

    • ๐Ÿ”ง [RealmApp] Add support for setting the filename on Flexible and Partition Sync configurations.

    ๐Ÿ›  Fixed

    • ๐Ÿ‘ป [RealmApp] Creating multiple anonymous subscriptions for a Realm would throw an exception.

    Compatibility

    • โฌ†๏ธ File format: Generates Realms with format v22. Unsynced Realms will be upgraded from Realm Java 2.0 and later. Synced Realms can only be read and upgraded if created with Realm Java v10.0.0-BETA.1.
    • ๐Ÿš€ APIs are backwards compatible with all previous release of realm-java in the 10.6.y series.
    • Realm Studio 11.0.0-alpha.0 or above is required to open Realms created by this version.

    Internal

    • โšก๏ธ Updated to Android Gradle Plugin 7.1.0
    • โšก๏ธ Updated to Gradle 7.3.3.
  • v10.10.0 Changes

    January 18, 2022

    โœจ Enhancements

    • ๐Ÿ”€ [RealmApp] Add support for a new mode for synchronized realms: Flexible Sync that only synchronizes selective parts of the backend data. The following classes have been added to support this: Subscription, SubscriptionSet and MutableSubscriptionSet. This mode and all APIs are marked as Beta.

    ๐Ÿ›  Fixed

    • ๐Ÿ”€ [RealmApp] The sync client will now drain the receive queue when send fails with ECONNRESET - ensuring that any error message from the server gets received and processed. (Realm Core issue #5078)
    • ๐Ÿ“‡ [RealmApp] UserIdentity metadata table grows indefinitely. (Realm Core issue #5152)
    • Schema validation was missing for embedded objects in sets, resulting in an unhelpful error being thrown if the user attempted to define one.
    • Output from the annotation processor was not deterministic, which could result in cache misses. (Issue #7615)
    • Crashes when using RealmAny inside RealmList on ARM 32 devices. (Issue #7626)

    Compatibility

    • โฌ†๏ธ File format: Generates Realms with format v22. Unsynced Realms will be upgraded from Realm Java 2.0 and later. Synced Realms can only be read and upgraded if created with Realm Java v10.0.0-BETA.1.
    • ๐Ÿš€ APIs are backwards compatible with all previous release of realm-java in the 10.6.y series.
    • Realm Studio 11.0.0-alpha.0 or above is required to open Realms created by this version.

    Internal

    • โšก๏ธ Update to Realm Core 11.9.0, commit: 733f12702d16ab0d0c7fea0831a2aee5ca5c26db.

    Credits

    • Thanks to @jprinet for making the annotation processor output deterministic.
  • v10.9.0 Changes

    December 06, 2021

    โœจ Enhancements

    • ๐Ÿ‘ [RealmApp] Add support for UUID's as partition values. (Issue #7598)
    • ๐Ÿ”€ [RealmApp] Reduced native memory usage when working with synchronized Realms.
    • ๐Ÿ— [RealmApp] Make it possible to bundle synchronized Realms in apps using Realm.writeCopyTo() and SyncConfiguration.Builder.assetFile().
    • ๐Ÿ”ง The Realm Transformer and Realm Gradle Plugin now supports the Gradle Configuration Cache. (Issue #7299)
    • ๐Ÿ”€ [RealmApp] Introduced SyncSession.DiscardUnsyncedChangesStrategy, an alternative automatic client reset strategy that doesn't require the Realm to be closed, but discards any unsynced data from the client. This is now the default policy if not overridden.

    ๐Ÿ—„ Deprecated

    • ๐Ÿ”€ [RealmApp] SyncSession.ClientResetHandler(). Use SyncSession.ManuallyRecoverUnsyncedChangesStrategy() instead.
    • ๐Ÿ— [RealmApp] AppConfiguration.Builder.defaultClientResetHandler(). Use AppConfiguration.Builder.setDefaultSyncClientResetStrategy() instead.
    • 0๏ธโƒฃ [RealmApp] AppConfiguration.getDefaultClientResetHandler(). Use AppConfiguration.getDefaultSyncClientResetStrategy() instead.
    • ๐Ÿ— [RealmApp] SyncConfiguration.Builder.clientResetHandler(). Use SyncConfiguration.Builder.setSyncClientResetStrategy() instead.
    • ๐Ÿ”€ [RealmApp] SyncConfiguration.getClientResetHandler(). Use SyncConfiguration.getSyncClientResetStrategy() instead.

    ๐Ÿ›  Fixed

    • ๐Ÿ”€ [RealmApp] Setting AppConfiguration.syncRootDirectory() didn't have any effect beside creating the new folder. Realms were still placed in the default location.
    • ๐Ÿ”€ [RealmApp] Bug where progress notifiers continue to be called after the download of a synced realm is complete. (Issue Realm Core #4919)
    • [RealmApp] User being left in the logged in state when the user's refresh token expires. (Issue Realm Core #4882, since v10)
    • Using "sort", "distinct", or "limit" as field name in query expression would cause an "Invalid predicate" error. (Issue #7545, since v10.X.X)
    • Crash when quering with 'Not()' followed by empty group. (Issue Realm Core #4168 since v1.0.0)
    • Streaming download notifiers reported incorrect values for transferrable bytes. (Issue Realm Core #5008 since v11.5.2)
    • @sum and @avg queries on Dictionaries of floats or doubles used too much precision for intermediates, resulting in incorrect rounding.

    Compatibility

    • โฌ†๏ธ File format: Generates Realms with format v22. Unsynced Realms will be upgraded from Realm Java 2.0 and later. Synced Realms can only be read and upgraded if created with Realm Java v10.0.0-BETA.1.
    • ๐Ÿš€ APIs are backwards compatible with all previous release of realm-java in the 10.6.y series.
    • Realm Studio 11.0.0-alpha.0 or above is required to open Realms created by this version.

    Internal

    • โšก๏ธ Updated to Realm Core 11.7.0, commit: 81eafa44879eb5f5829b345005abf99adb306133.
    • ๐Ÿ— Building the SDK now requires JDK 11.
    • โšก๏ธ Updated to Gradle 7.2.
    • โšก๏ธ Updated to Android Gradle Plugin 7.1.0-beta03.
    • โšก๏ธ Updated to Kotlin 1.5.31.
    • โšก๏ธ Updated to Kotlin Coroutines 1.5.2.
    • โšก๏ธ Updated to CMake 3.21.4.
    • โšก๏ธ Updated to NDK 23.1.7779620.
    • Disable analytics for any value of the REALM_DISABLE_ANALYTICS environment variable, not just true.
    • ๐Ÿ“ˆ Disable analytics whenever the CI environment variable is set.
  • v10.8.1 Changes

    October 28, 2021

    โœจ Enhancements

    • None.

    ๐Ÿ›  Fixed

    • [RealmApp] Failing to refresh the access token due to a 401/403 error will now correctly emit an error with ErrorCode.BAD_AUTHENTICATION rather than ErrorCode.PERMISSION_DENIED. (Realm Core #4881, since 10.6.1)
    • ๐Ÿ”€ [RealmApp] If an object with a null primary key was deleted by another sync client, the exception KeyNotFound: No such object could be triggered. (Realm Core #4885, since 10.0.0)
    • ๐Ÿ‘ป Exceptions inside change listeners running on background looper threads would crash the Looper with a native JNI DETECTED ERROR IN APPLICATION: JNI NewLocalRef called with pending exception instead of the original Java exception. This could also happen when canceling a corutine using a background looper as a Dispatcher.
    • ๐Ÿ”€ [RealmApp] Reduced native memory use when synchronizing changes with the server in the background.

    Compatibility

    • โฌ†๏ธ File format: Generates Realms with format v22. Unsynced Realms will be upgraded from Realm Java 2.0 and later. Synced Realms can only be read and upgraded if created with Realm Java v10.0.0-BETA.1.
    • ๐Ÿš€ APIs are backwards compatible with all previous release of realm-java in the 10.6.y series.
    • Realm Studio 11.0.0-alpha.0 or above is required to open Realms created by this version.

    Internal

    • โšก๏ธ Updated to Realm Core 11.4.1, commit: 23f60515a00f076a9e3f2dc672fe1ae07601ee90.
  • v10.8.0 Changes

    August 27, 2021

    โœจ Enhancements

    • [RealmApp] ErrorCode.INVALID_EMAIL_PASSWORD has been added, and is now thrown instead of ErrorCode.SERVICE_UNKNOWN when loggin in with the wrong credentials.
    • RealmQuery.rawPredicate() now accepts a "BETWEEN" operator. Can be used like "age BETWEEN {20, 60}" which means "'Age' must be in the open interval ]20;60[".
    • ๐Ÿšš [RealmApp] Added User.remove() and User.removeAsync() that makes it possible to delete a user's Realm(s) from the device.

    ๐Ÿ›  Fixed

    • [RealmApp] Crash when integrating a schema from the server with a RealmAny property to a Realm File that already had that property defined locally. (Realm Core #4873, since 10.0.0)
    • [RealmApp] Refreshing the access token after 30 minutes would fail silently, causing infinite retries every 10 seconds. This would also block opening Realms when opening an app with an already logged in user. (Issue #7501, since 10.0.0)
    • [RealmApp] Clarified Javadoc for User.logOut() and User.logOutAsync() as these methods do not delete a user's Realm(s).
    • ๐Ÿ— Build error when having cross module model references (Issue #7474, since v10.4.0)

    Compatibility

    • โฌ†๏ธ File format: Generates Realms with format v22. Unsynced Realms will be upgraded from Realm Java 2.0 and later. Synced Realms can only be read and upgraded if created with Realm Java v10.0.0-BETA.1.
    • ๐Ÿš€ APIs are backwards compatible with all previous release of realm-java in the 10.6.y series.
    • Realm Studio 11.0.0-alpha.0 or above is required to open Realms created by this version.

    Internal

    • โšก๏ธ Updated to Realm Core 11.3.0, commit: 321c79a67119db8177af13eefd5378586648ba73.
  • v10.7.1 Changes

    August 03, 2021

    โœจ Enhancements

    • None.

    ๐Ÿ›  Fixed

    • ๐Ÿ”€ [RealmApp] Crash when an object which is linked to by a RealmAny is invalidated (Sync only). (Realm Core #4828, since v10.6.0)
    • Object change listeners did not handle the object being deleted properly, which could result in assertion failures mentioning "m_table" in ObjectNotifier (Realm Core #4824, since v10.6.0).
    • Crash when delivering notifications over a nested hierarchy of lists of RealmAny that contain object references. (Realm Core #4803, since v10.6.0)

    Compatibility

    • โฌ†๏ธ File format: Generates Realms with format v22. Unsynced Realms will be upgraded from Realm Java 2.0 and later. Synced Realms can only be read and upgraded if created with Realm Java v10.0.0-BETA.1.
    • ๐Ÿš€ APIs are backwards compatible with all previous release of realm-java in the 10.6.y series.
    • Realm Studio 11.0.0-alpha.0 or above is required to open Realms created by this version.

    Internal

    • โšก๏ธ Updated to Realm Core 11.2.0, commit: 583fc73040709383470797813096bee17802398e.
  • v10.7.0 Changes

    July 27, 2021

    ๐Ÿ’ฅ Breaking Changes

    • โœ‚ Removed automatic injection of repositories from Gradle plugin. From now on mavenCentral() repository needs to be added manually. (Issue #7365)

    โœจ Enhancements

    • None.

    ๐Ÿ›  Fixed

    • [RealmApp] Realm.getInstanceAsync does not wait for the initial remote data. (Issue #7517)
    • Build errors when doing incremental builds with Android Studio's Apply Changes...-actions. (Issue #7473)

    Compatibility

    • โฌ†๏ธ File format: Generates Realms with format v22. Unsynced Realms will be upgraded from Realm Java 2.0 and later. Synced Realms can only be read and upgraded if created with Realm Java v10.0.0-BETA.1.
    • ๐Ÿš€ APIs are backwards compatible with all previous release of realm-java in the 10.6.y series.
    • Realm Studio 11.0.0-alpha.0 or above is required to open Realms created by this version.

    Internal

    • โšก๏ธ Updated to Realm Core 11.1.1, commit: 71db56caba8f8ef0398eedfffb82a908cb94ccec.
  • v10.6.1 Changes

    July 01, 2021

    โœจ Enhancements

    • None.

    ๐Ÿ›  Fixed

    • ๐Ÿ— [RealmApp] Configuring HTTP timeout through AppConfiguration.Builder.requestTimeout() did not work correctly. (Issue #7455)
    • ๐Ÿ”Š [RealmApp] A recursive loop that would eventually crash trying to refresh a user app token when it had been revoked by an admin. Now this situation logs the user out and reports an error. (Issue #7501)
    • En endless recursive loop that could cause a stack overflow when computing changes on a set of objects which contained cycles. (Realm Core Issue #4767)
    • Opening cached Realms no longer trigger android.os.strictmode.DiskReadViolation. (Issue #7500)
    • NullPointerException was thrown instead of IllegalStateException when calling Realm.executeTransaction() on a closed Realm. (Issue #7511, since 10.0.0)
    • RealmDictionary did not handle hash collisions correctly. (Realm Core issue #4776)
    • Crash after clearing a List or Set of RealmAny containing references to objects (Realm Core issue #4774)

    Compatibility

    • โฌ†๏ธ File format: Generates Realms with format v22. Unsynced Realms will be upgraded from Realm Java 2.0 and later. Synced Realms can only be read and upgraded if created with Realm Java v10.0.0-BETA.1.
    • ๐Ÿš€ APIs are backwards compatible with all previous release of realm-java in the 10.6.y series.
    • Realm Studio 11.0.0-alpha.0 or above is required to open Realms created by this version.

    Internal

    • โšก๏ธ Updated to Realm Core 11.0.4, commit: 44304ce6104c4a9fc7e2359990c75be3b867b8fe.
  • v10.6.0 Changes

    June 15, 2021

    ๐Ÿš€ This release combines all changes from 10.6.0-BETA.1 and 10.6.0-BETA.2.

    ๐Ÿ’ฅ Breaking Changes

    • ๐Ÿ”€ [RealmApp] Sync protocol version increased to 3. This version adds support for the new data types introduced in file format version 21.
    • โฌ†๏ธ Primary keys now have automatic indexes again. Indexes was removed in v10.0.0 because they were not needed, but it caused issues when upgrading from a pre v10 version of Realm, and in some cases resulted in large delays when upgrading the fileformat. (Issue #7426, since 10.0.0).
    • Queries no longer do nullability checks on non-nullable fields, so using null as an argument will not throw an IllegalArgumentException.
    • ๐Ÿ‘ป String query filters contains, beginsWith, endsWith, and like, now throw a null pointer exception on null values.
    • ๐Ÿ— The query builder no longer throw IllegalStateException but IllegalArgumentException.
    • ๐Ÿ‘ป The distinct query filter on unsupported fields no longer throws an exception when applied through when querying across relationships.
    • ๐Ÿ‘ป The distinct query filter no longer throws an exception when applied on non-existent fields.
    • โšก๏ธ RealmFieldType has been updated to account for the new types being added.

    โœจ Enhancements

    • โž• Added support for java.util.UUID as supported field in model classes.
    • โž• Added support for java.util.UUID as a primary key.
    • โž• Added support for RealmAny as supported field in model classes. A RealmAny is used to represent a polymorphic Realm value or Realm Object, is indexable but cannot be used as a primary key. See Javadoc for RealmAny.
    • โž• Added support for RealmDictionary as supported field in model classes. A RealmDictionary is a Map of strings to values - all types under the RealmAny umbrella can be used as values. See Javadoc for RealmDictionary and Javadoc for RealmMap. RealmDictionary is not yet supported by any of the Realm.insert and Realm.createFromJson methods - This support will be added in a future release.
    • โž• Added support for RealmSet as supported field in model classes. A RealmSet is a collection that implements the Java Set interface and contains no duplicate values - all types under the RealmAny umbrella can be used as values. See Javadoc for RealmSet. RealmSet is not yet supported by any of the Realm.insert and Realm.createFromJson methods - This support will be added in a future release.
    • ๐Ÿ‘ Allow UTF8 encoded characters in property names in string-based queries (#4467)
    • The error message when the initial steps of opening a Realm file fails is now more descriptive.
    • ๐Ÿ‘‰ Make conversion of Decimal128 to/from string work for numbers with more than 19 significant digits. (#4548)
    • โœ‚ Remove type coercion on bool and ObjectId when doing queries.
    • ๐Ÿ‘ Allow passing arguments into string-based query predicates.
    • ๐Ÿ‘ Queries across relationships now support the between operator.
    • Queries on numerical fields (byte, short, int, long, float, double, decimal128) now accept any numerical value as an argument.
    • isEmpty query filter can now be applied on RealmList and RealmObject fields.

    ๐Ÿ›  Fixed

    • Fix assertion failures such as "!m_notifier_skip_version.version" or "m_notifier_sg->get_version() + 1 == new_version.version" when performing writes inside change notification callbacks. Previously refreshing the Realm by beginning a write transaction would skip delivering notifications, leaving things in an inconsistent state. Notifications are now delivered recursively when needed instead. (Cocoa #7165).
    • ๐Ÿ›  Fixed name aliasing not working in sort/distinct clauses when doing string-based queries. (#4550, never before working).
    • Potential/unconfirmed fix for crashes associated with failure to memory map (low on memory, low on virtual address space). For example (#4514).
    • ๐Ÿ”€ Syncing large Decimal128 values will cause "Assertion failed: cx.w[1] == 0" (#4519, since v10.0.0)
    • Classes names "class_class_..." were not handled correctly when doing queries (#4480)
    • ๐Ÿ›  Fix collection notification reporting for modifications. This could be observed by receiving the wrong indices of modifications on sorted or distinct results, or notification blocks sometimes not being called when only modifications have occurred. (#4573 since v6).

    Compatibility

    • โฌ†๏ธ File format: Generates Realms with format v22. Unsynced Realms will be upgraded from Realm Java 2.0 and later. Synced Realms can only be read and upgraded if created with Realm Java v10.0.0-BETA.1.
    • ๐Ÿš€ APIs are backwards compatible with all previous release of realm-java in the 10.6.y series.
    • Realm Studio 11.0.0-alpha.0 or above is required to open Realms created by this version.

    Internal

    • โšก๏ธ Updated to Realm Core 11.0.3, commit de25ad9db783f931e7652d5c1431d5610b2ad67b.
  • v10.6.0-BETA.2 Changes

    June 14, 2021

    ๐Ÿ’ฅ Breaking Changes

    • `MapChangeSet.getDeletionsCount() has been replaced with MapChangeSet.getDeletions() that return the keys for entries that has been deleted instead of just the number of deleted entries.
    • โฌ†๏ธ Primary keys now have automatic indexes again. Indexes was removed in v10.0.0 because they were not needed, but it caused issues when upgrading from a pre v10 version of Realm, and in some cases resulted in large delays when upgrading the fileformat. (Issue #7426, since 10.0.0).

    โœจ Enhancements

    • ๐Ÿ‘ Allow insert and insertOrUpdate operations on RealmObject or RealmObject collections containing RealmDictionary or RealmSet fields.
    • โž• Added support for RealmDictionary in DynamicRealmObject with setDictionary(String fieldName, RealmDictionary<?> dictionary), getDictionary(String fieldName, Class<?> primitiveType), and getDictionary(String fieldName).
    • โž• Added support for RealmSet in DynamicRealmObject with setRealmSet(String fieldName, RealmSet<?> realmSet), getRealmSet(String fieldName, Class<?> primitiveType), and getRealmSet(String fieldName).

    ๐Ÿ›  Fixed

    • โœ‚ Removed wrong @Nullable annotation on RealmQuery.maxRealmAny().
    • ๐Ÿ›  Fixed RealmAny.getValueClass() returning the RealmObject proxy class instead of the model class on a RealmAny referencing a managed RealmObject.

    Compatibility

    • โฌ†๏ธ File format: Generates Realms with format v22. Unsynced Realms will be upgraded from Realm Java 2.0 and later. Synced Realms can only be read and upgraded if created with Realm Java v10.0.0-BETA.1.
    • ๐Ÿš€ APIs are backwards compatible with all previous release of realm-java in the 10.6.y series.
    • Realm Studio 11.0.0-alpha.0 or above is required to open Realms created by this version.

    Internal

    • โšก๏ธ Updated to Realm Core 11.0.2, commit a30382469eb72c0cf1824b44e7062071c2f3f3a9.
    • โšก๏ธ Updated to Gradle 6.8.3.