Simple tool to backup and restore your room database in Android
Android-Room-Database-Backup library is pushed
to Maven Central
.
Add the dependency for Android-Room-Database-Backup
to your app-level build.gradle
file.
implementation 'de.raphaelebner:roomdatabasebackup:1.0.1'
If the version makes any technical problems please feel free to contact me. I made some changes in Gradle/Kotlin DSL and not sure if everything is working as excepted
Required
Current context
Attention
Must be declared outside of an onClickListener before lifecycle state changes to started
RoomBackup(this)
.database(*YourDatabase*.getInstance(this))
e.g. YourDatabase.kt
Optional
The following options are optional and the default options
Enable logging, for debugging and some error messages
.enableLogDebug(false)
Set custom log tag
.customLogTag("debug_RoomBackup")
Enable and set maxFileCount
.maxFileCount(5)
Encrypt your backup
.backupIsEncrypted(false)
Encrypt your backup with your own password / key
.backupIsEncrypted(true)
is setAttention
i do not assume any liability for the loss of your key
.customEncryptPassword("YOUR_SECRET_PASSWORD")
Save your backup to different storage
External
storage path: /storage/emulated/0/Android/data/package/files/backup/
This files will be deleted, if you uninstall your app
RoomBackup.BACKUP_FILE_LOCATION_EXTERNAL
Internal
Private, storage not accessible
This files will be deleted, if you uninstall your app
RoomBackup.BACKUP_FILE_LOCATION_INTERNAL
Custom Dialog (beta)
You can choose to save or restore where ever you want. A CreateDocument() or OpenDocument() Activity will be launched where you can choose the location
If your backup is encrypted I reccomend you using a custom encrption password else you can't restore your backup
RoomBackup.BACKUP_FILE_LOCATION_CUSTOM_DIALOG
Custom File (beta)
You can choose to save or restore to/from a custom File.
If your backup is encrypted I reccomend you using a custom encrption password else you can't restore your backup
Please use backupLocationCustomFile(File)
to set a custom File
RoomBackup.BACKUP_FILE_LOCATION_CUSTOM_FILE
Attention
For custom dialog and custom file I only verified the functionality for local storage. For thirt party storage please try and contact me if it is not working. I hope I can find a solution and fix it :)
.backupLocation(RoomBackup.BACKUP_FILE_LOCATION_INTERNAL)
Set a custom File to save/restore to/from
Only working if backupLocation
is set to BACKUP_FILE_LOCATION_CUSTOM_FILE
You have to define a File withe Filename and extension
.backupLocationCustomFile(backupLocationCustomFile: File)
Set a custom dialog title, when showing list of available backups to restore (only for external or internal storage)
.customRestoreDialogTitle("Choose file to restore")
Set your custom name to the Backup files
Attention\ If a backup file with the same name already exists, it will be replaced
.customBackupFileName(*DatabaseName* + *currentTime* + ".sqlite3")
Run some code, after backup / restore process is finished
.onCompleteListener { success, message, exitCode ->
}
Restart your Application. Can be implemented in the onCompleteListener, when "success == true"
Attention\ it does not always work reliably!\ But you can use other methods.\ Important is that all activities / fragments that are still open must be closed and reopened\ Because the Database instance is a new one, and the old activities / fragments are trying to work with the old instance
.restartApp(Intent(this@MainActivity, MainActivity::class.java))
Here are all exit codes for the onCompleteListener.
They can be calles using OnCompleteListener.$NAME$
Exit Code | Name | Description |
---|---|---|
0 | EXIT_CODE_SUCCESS |
No error, action successful |
1 | EXIT_CODE_ERROR |
Other Error |
2 | EXIT_CODE_ERROR_BACKUP_FILE_CHOOSER |
Error while choosing backup to restore. Maybe no file selected |
3 | EXIT_CODE_ERROR_BACKUP_FILE_CREATOR |
Error while choosing backup file to create. Maybe no file selected |
4 | EXIT_CODE_ERROR_BACKUP_LOCATION_FILE_MISSING |
[BACKUP_FILE_LOCATION_CUSTOM_FILE] is set but [RoomBackup.backupLocationCustomFile] is not set |
5 | EXIT_CODE_ERROR_BACKUP_LOCATION_MISSING |
[RoomBackup.backupLocation] is not set |
6 | EXIT_CODE_ERROR_BY_USER_CANCELED |
Restore dialog for internal/external storage was canceled by user |
7 | EXIT_CODE_ERROR_DECRYPTION_ERROR |
Cannot decrypt provided backup file |
8 | EXIT_CODE_ERROR_ENCRYPTION_ERROR |
Cannot encrypt database backup |
9 | EXIT_CODE_ERROR_RESTORE_BACKUP_IS_ENCRYPTED |
You tried to restore a encrypted backup but [RoomBackup.backupIsEncrypted] is set to false |
10 | EXIT_CODE_ERROR_RESTORE_NO_BACKUPS_AVAILABLE |
No backups to restore are available in internal/external sotrage |
11 | EXIT_CODE_ERROR_ROOM_DATABASE_MISSING |
No room database to backup is provided |
12 | EXIT_CODE_ERROR_STORAGE_PERMISSONS_NOT_GRANTED |
Storage permissions not granted for custom dialog |
13 | EXIT_CODE_ERROR_WRONG_DECRYPTION_PASSWORD |
Cannot decrypt provided backup file because the password is incorrect |
val backup = RoomBackup(this)
...
backup
.database(FruitDatabase.getInstance(this))
.enableLogDebug(true)
.backupIsEncrypted(true)
.customEncryptPassword("YOUR_SECRET_PASSWORD")
.backupLocation(RoomBackup.BACKUP_FILE_LOCATION_INTERNAL)
.maxFileCount(5)
.apply {
onCompleteListener { success, message, exitCode ->
Log.d(TAG, "success: $success, message: $message, exitCode: $exitCode")
if (success) restartApp(Intent(this@MainActivity, MainActivity::class.java))
}
}
.backup()
val backup = RoomBackup(this)
...
backup
.database(FruitDatabase.getInstance(this))
.enableLogDebug(true)
.backupIsEncrypted(true)
.customEncryptPassword("YOUR_SECRET_PASSWORD")
.backupLocation(RoomBackup.BACKUP_FILE_LOCATION_INTERNAL)
.apply {
onCompleteListener { success, message, exitCode ->
Log.d(TAG, "success: $success, message: $message, exitCode: $exitCode")
if (success) restartApp(Intent(this@MainActivity, MainActivity::class.java))
}
}
.restore()
final RoomBackup roomBackup = new RoomBackup(MainActivityJava.this);
...
roomBackup.database(FruitDatabase.Companion.getInstance(getApplicationContext()));
roomBackup.enableLogDebug(enableLog);
roomBackup.backupIsEncrypted(encryptBackup);
roomBackup.backupLocation(RoomBackup.BACKUP_FILE_LOCATION_INTERNAL);
roomBackup.maxFileCount(5);
roomBackup.onCompleteListener((success, message, exitCode) -> {
Log.d(TAG, "success: " + success + ", message: " + message + ", exitCode: " + exitCode);
if (success) roomBackup.restartApp(new Intent(getApplicationContext(), MainActivityJava.class));
});
roomBackup.backup();
final RoomBackup roomBackup = new RoomBackup(MainActivityJava.this);
...
roomBackup.database(FruitDatabase.Companion.getInstance(getApplicationContext()));
roomBackup.enableLogDebug(enableLog);
roomBackup.backupIsEncrypted(encryptBackup);
roomBackup.backupLocation(RoomBackup.BACKUP_FILE_LOCATION_INTERNAL);
roomBackup.onCompleteListener((success, message, exitCode) -> {
Log.d(TAG, "success: " + success + ", message: " + message + ", exitCode: " + exitCode);
if (success) roomBackup.restartApp(new Intent(getApplicationContext(), MainActivityJava.class));
});
roomBackup.restore();
FragmentActivity.kt
MainFragment.kt
FragmentActivityJava.java
MainFragmentJava.java
MIT License
Copyright (c) 2024 Raphael Ebner
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.