V3.4.0

• Add findFirstId() and findUniqueId() to Query which just return the ID of a matching object instead of the full object.
• Experimental support for setting a maximum data size via the maxDataSizeInKByte property when building a Store. This is different from the existing maxSizeInKByte property in that it is possible to remove data after reaching the limit and continue to use the database. See its documentation for more details.
• Fix a crash when querying a value-based index (e.g. @Index(type = IndexType.VALUE)) on Android 32-bit ARM devices. #1105
• Various small improvements to the native libraries.

Using Sync? There is no Sync version for this release, please continue using version 3.2.1.

V3.3.1

Note: V3.3.0 contains a bug preventing correct transformation of some classes, please use V3.3.1 instead.

• Gradle plugin: use new transform API with Android Plugin 7.2.0 and newer. Builds should be slightly faster as only entity and cursor classes and only incremental changes are transformed. #1078
• Gradle plugin: improve detection of applied Android plugins, improve registration of byte-code transform for non-Android Java projects, add check for minimum supported version of Gradle.
• Various small improvements to the native libraries.

Using Sync? There is no Sync version for this release, please continue using version 3.2.1.

V3.2.1

• Resolve an issue that prevented resources from getting cleaned up after closing BoxStore, causing the reference table to overflow when running many instrumentation tests on Android. #1080
• Plugin: support Kotlin 1.7. #1085

V3.2.0

• Query: throw IllegalStateException when query is closed instead of crashing the virtual machine. #1081
• BoxStore and Query now throw IllegalStateException when trying to subscribe but the store or query is closed already.
• Various internal improvements including minor optimizations for binary size and performance.

V3.1.3

• Windows: using a database directory path that contains unicode (UTF-8) characters does not longer create an additional, unused, directory with garbled characters.
• Query: when using a negative offset or limit display a helpful error message.
• Processor: do not crash, but error if ToOne/ToMany type arguments are not supplied (e.g. ToOne instead of ToOne<Entity>).
• The Data Browser has been renamed to ObjectBox Admin. Deprecated AndroidObjectBrowser, use Admin instead. AndroidObjectBrowser will be removed in a future release.

V3.1.2

This release only contains bug fixes for the Android library when used with ObjectBox for Dart/Flutter.

V3.1.1

This release only contains bug fixes.

• Fix incorrect unique constraint violation if an entity contains at least two unique properties with a certain combination of non-unique indexes.
• Data Browser/Admin: improved support when running multiple on the same host, but a different port (e.g. localhost:8090 and localhost:8091).

V3.1.0

Read the blog post with more details and code examples for the new flex properties and query conditions.

• Support Flex properties. Expanding on the string and flexible map support in 3.0.0, it is now possible to add a property using Object in Java or Any? in Kotlin. These "flex properties" now allow to store values of various types like integers, floating point values, strings and byte arrays. Or lists and maps (using string keys) of those. Some limitations apply, see the FlexObjectConverter class documentation for details.

  @Entity
  data class Customer(
      @Id var id: Long = 0,
      var tag: Any? = null
  )
  
  val customerStrTag = Customer(tag = "string-tag")
  val customerIntTag = Customer(tag = 1234)
  box.put(customerStrTag, customerIntTag)

• The containsElement query condition now matches keys of string map properties. It also matches string or integer elements of a Flex list.
• New containsKeyValue query condition to match key/value combinations of string map and Flex map properties containing strings and integers. Also added matching Query.setParameters overload.

  val customer = Customer(
      properties = mutableMapOf("premium" to "tier-1")
  )
  box.put(customer)
  
  // Query for any customers that have a premium key in their properties map
  val queryPremiumAll = box.query(
      Customer_.properties.containsElement("premium")
  ).build()
  
  // Match only customers with specific key and value map entry
  val queryPremiumTier1 = box.query(
      Customer_.properties.containsKeyValue("premium", "tier-1")
  ).build()

• Add ProGuard/R8 rule to not warn about SuppressFBWarnings annotation. #1011
• Add more detailed error message when loading the native library fails on Android. #1024
• Data browser: byte arrays are now correctly displayed in Base64 encoding. #1033

Kotlin

• Add BoxStore.awaitCallInTx suspend function which wraps BoxStore.callInTx.

Gradle plugin

• Do not crash trying to add dependencies to Java desktop projects that only apply the Gradle application plugin.

Read more in the docs

V3.0.1

• Fixes the ObjectBox plugin crashing when applied to an Android project that does not use the Kotlin plugin.

See the 3.0.0 release notes for a list of important changes.

All release notes & docs

V3.0.0

Note: this version contains a bug that prevents usage with Android Java only projects. Use 3.0.1 instead.

• A new Query API is available that works similar to the ObjectBox for Dart/Flutter Query API and makes it easier to create nested conditions. #201

  // equal AND (less OR oneOf)
  val query = box.query(
        User_.firstName equal "Joe"
                and (User_.age less 12
                or (User_.stamp oneOf longArrayOf(1012))))
        .order(User_.age)
        .build()

• For the existing Query API, String property conditions now require to explicitly specify case. See the documentation of StringOrder for which one to choose (typically StringOrder.CASE_INSENSITIVE).

  // Replace String conditions like
  query().equal(User_.firstName, "Joe")
  // With the one accepting a StringOrder
  query().equal(User_.firstName, "Joe", StringOrder.CASE_INSENSITIVE)

• The Gradle plugin will now warn when an @Entity class is missing a no-arg (easy to add) or all properties (best for performance) constructor. #900
  Example for an all properties constructor:

  @Entity
  public class Order {
  
      @Id
      private long id;
      private ToOne<Customer> customer;
      private ToMany<Order> relatedOrders;
  
      // All properties constructor for ObjectBox:
      // - make sure type matches exactly,
      // - for ToOne add its virtual ID property instead,
      // - for ToMany add no parameter.
      public Order(long id, long customerId) {
          this.id = id;
          this.customer.setTargetId(customerId);
      }
  
      // TODO getters and setters for properties
  }

• Subscriptions now publish results in serial instead of in parallel (using a single thread vs. multiple threads per publisher). Publishing in parallel could previously lead to outdated results getting delivered after the latest results. As a side-effect transformers now run in serial instead of in parallel as well (on the same single thread per publisher). #793
• Support annotating a single property with @Unique(onConflict = ConflictStrategy.REPLACE) to replace an existing Object if a conflict occurs when doing a put. #509

  @Entity
  data class Example(
          @Id
          var id: Long = 0,
          @Unique(onConflict = ConflictStrategy.REPLACE)
          var uniqueKey: String? = null
  )

• Support @Unsigned to indicate that values of an integer property (e.g. Integer and Long in Java) should be treated as unsigned when doing queries or creating indexes.
• Store time in nanoseconds using the new @Type annotation:

  @Type(DatabaseType.DateNano)
  var timeInNanos: Long;

• Package FlatBuffers version into library to avoid conflicts with apps or other libraries using FlatBuffers. #894
• Kotlin: add Flow extension functions for BoxStore and Query. #990
• Data browser: display query results if a property has a NaN value. #984
• Android 12: support using Data Browser if targeting Android 12 (SDK 31). #1007

New supported property types

• String arrays (Java String[] and Kotlin Array<String>) and lists (Java List<String> and Kotlin MutableList<String>). Using the new containsElement("item") condition, it is also possible to query for entities where "item" is equal to one of the elements.

  @Entity
  data class Example(
          @Id
          var id: Long = 0,
          var stringArray: Array<String>? = null,
          var stringMap: MutableMap<String, String>? = null
  )
  
  // matches [“first”, “second”, “third”]
  box.query(Example_.stringArray.containsElement(“second”)).build()

• String maps (Java Map<String, String> or Kotlin MutableMap<String, String>). Stored internally as a byte array using FlexBuffers.
• Flexible maps:
  • map keys must all have the same type,
  • map keys or values must not be null,
  • map values must be one of the supported database type, or a list of them (e.g. String, Boolean, Integer, Double, byte array...).

Sync

• The generated JSON model file no longer contains Java-specific flags that would lead to errors if used with Sync server.
• Additional checks when calling client or server methods.

All release notes & docs