5.0 Migration Guide
This lists out the major changes since < 5.0
Last updated
Was this helpful?
This lists out the major changes since < 5.0
Last updated
Was this helpful?
Major Changes
Package name is now com.dbflow5
, which enables bundling multiple versions in the same repo.
Note: Using multiple versions of DBFlow on the same DB is not recommended, as it can lead to inconsistent usage on the database in respect to transaction queuing, migrations, or synchronization.
Library is now 100% Kotlin, except generated code. KSP (Kotlin Source Processing) is promising, but will require major updates to support it directly. This means that any -kotlinextensions
artifacts are not rolled within the library.
Library now adds support for incremental annotation processing. Please report any issues!
New artifacts: paging
(architecture components Paging), coroutines
, contentprovider
, (splits out ContentProvider
usage out of main library), livedata
, reactive-streams
(RXJava3).
RXJava
1 and 2 support is dropped given, is now in maintenance mode. You simply need to copy paste the reactive-streams
files you need and then replace the package names back to their RXJava2 equivalent. RXJava 1 is not quite equivalent and not supported.
save()
methods on the ModelAdapter
classes now use a more efficient INSERT OR REPLACE
method, rather than check if exists
manually from the DB before inserting or replacing.
@Database
classes must now be an abstract class that extends DBFlowDatabase
(or related subclass)
Removed deprecated @Database
annotation fields including name
, databaseExtension
, and inMemory
. Use the DatabaseConfig.Builder
object when initializing DBFlow.
The implicit DatabaseWrapper
that was used in model operations is now required explicit.
ModelAdapter.bindToContentValues
and corresponding ContentValues
generated code is no l longer enabled by default. If you need the methods, set @Table(generateContentValues = true)
. 1. For @ContentProvider
object, your db must now extend ContentProviderDatabase
to supply ContentValues
methods on the database.
Explicitly marking every field in a @Table
with @Column
is no longer the default. By default any field in the model class are referenced. To enable the old behavior use @Table(allFields = false)
Adds @Fts3
and @Fts4
annotations. See SQLite docs on
@ModelView
: gets orderedCursorLookup
, assignDefaultValuesFromCursor
, and createWithDatabase
that were allowed on @Table
classes.
@ModelViewQuery
can now be used on a Property
@QueryModel
: gets orderedCursorLookup
, andassignDefaultValuesFromCursor
that were allowed on @Table
classes.
IMultiKeyCacheConverter
renamed to MultiKeyCacheConverter
Performing DB operations not in a transaction will throw a new warning in FlowLog
: Database Not Running in a Transaction. Performance may be impacted, observability will need manual updates via db.tableObserver.checkForTableUpdates()
QueryModelAdapter
is deprecated as RetrievalAdapter
performs all functionality.
DBFlowDatabase can now specify a JournalMode
to support write-ahead logging. Note: on higher end devices this will enable WriteAheadLogging
by default.
New TableObserver
class on a DBFlowDatabase
. Inspired by Room, this sets up Trigger
on table changes for observed tables to efficiently track which table changes. This is useful in recomputing queries for LiveData
, Flowable
, or Paging
DataSource
. Whenever a Transaction
is run on the DB, upon completing it, we check for any table changes and dispatch that to the active queries that are observed.
AlterTableMigration
supports default values for a column when adding a column.
Index.enable
renamed to createIfNotExists
, Index.disable
renamed to drop
.
Reduce generated code in tables.