RoomDatabase.Callback

Callback for RoomDatabase

Summary

Public constructors
android
Cmn
N

Public functions
open Unit

Called when the database is created for the first time.
Cmn
android
N
open Unit

Called when the database is created for the first time.
android
open Unit

Called after the database was destructively migrated.
Cmn
android
N
open Unit

Called after the database was destructively migrated
android
open Unit
onOpen(connection: SQLiteConnection)

Called when the database has been opened.
Cmn
android
N
open Unit

Called when the database has been opened.
android

Public constructors

Callback

android
Added in 2.0.0
Callback()

Callback

Cmn
Added in 2.0.0
Callback()

Callback

N
Added in 2.0.0
Callback()

Public functions

onCreate

Cmn android N
Added in 2.7.2
open fun onCreate(connection: SQLiteConnection): Unit

Called when the database is created for the first time.

This function called after all the tables are created.

Parameters
connection: SQLiteConnection

The database connection.

onCreate

android
Added in 2.0.0
open fun onCreate(db: SupportSQLiteDatabase): Unit

Called when the database is created for the first time. This is called after all the tables are created.

This function is only called when Room is configured without a driver. If a driver is set using androidx.room.RoomDatabase.Builder.setDriver, then only the version that receives a SQLiteConnection is called.

Parameters
db: SupportSQLiteDatabase

The database.

onDestructiveMigration

Cmn android N
Added in 2.7.2
open fun onDestructiveMigration(connection: SQLiteConnection): Unit

Called after the database was destructively migrated.

Parameters
connection: SQLiteConnection

The database connection.

onDestructiveMigration

android
Added in 2.2.0
open fun onDestructiveMigration(db: SupportSQLiteDatabase): Unit

Called after the database was destructively migrated

This function is only called when Room is configured without a driver. If a driver is set using androidx.room.RoomDatabase.Builder.setDriver, then only the version that receives a SQLiteConnection is called.

Parameters
db: SupportSQLiteDatabase

The database.

onOpen

Cmn android N
Added in 2.7.2
open fun onOpen(connection: SQLiteConnection): Unit

Called when the database has been opened.

Parameters
connection: SQLiteConnection

The database connection.

onOpen

android
Added in 2.0.0
open fun onOpen(db: SupportSQLiteDatabase): Unit

Called when the database has been opened.

This function is only called when Room is configured without a driver. If a driver is set using androidx.room.RoomDatabase.Builder.setDriver, then only the version that receives a SQLiteConnection is called.

Parameters
db: SupportSQLiteDatabase

The database.