realm-java v10.6.0 Release Notes

Release Date: 2021-06-15 // 4 months ago
  • ๐Ÿš€ 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.