Skip to content

Commit 56c9755

Browse files
committed
Move over migration guide.
1 parent 31687c1 commit 56c9755

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,19 @@ Source code
112112
-----------
113113
Source code for ObjectBox's Swift binding can be found [in the Source folder](Source/README.md).
114114

115+
Migrating from the Beta
116+
-----------------------
117+
118+
If you've used the ObjectBox betas, there are a few changes we made for the 1.0 release to
119+
improve the experience before we freeze the API for release. The adjustments you'll have to make are:
120+
121+
1. `isEmpty()`, `count()`, `all()`, `sum()`, `min()`, `max()` etc. are now functions to make it clearer they may perform a database lookup and aren't just properties to read.
122+
2. `putImmutable()` is now gone. Just call `put()` instead, it now returns the IDs like `putImmutable` used to.
123+
3. The old `Id<>` type has been renamed to `EntityId<>`. There is now a new `Id` type that does not use generics.
124+
4. Changes to standalone relations need to be saved explicitly using a call to `applyToDb()`.
125+
5. Most calls have been revised to now throw errors, so you'll have to add the requisite `try` statements.
126+
6. `ToMany` has been revised to no longer need the containing type as a second generic parameter, so change any `ToMany<A, B>` in your code to `ToMany<A>`.
127+
115128
Other languages/bindings
116129
------------------------
117130
ObjectBox is a multi platform database supporting [multiple languages](https://objectbox.io/dev-get-started/):

0 commit comments

Comments
 (0)