Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sczerwinski/android-room
Extensions for Jetpack Room
https://github.com/sczerwinski/android-room
android room room-database
Last synced: 8 days ago
JSON representation
Extensions for Jetpack Room
- Host: GitHub
- URL: https://github.com/sczerwinski/android-room
- Owner: sczerwinski
- License: apache-2.0
- Created: 2020-12-18T21:27:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T13:27:25.000Z (over 1 year ago)
- Last Synced: 2024-08-01T19:57:36.630Z (4 months ago)
- Topics: android, room, room-database
- Language: Kotlin
- Homepage: https://czerwinski.it/projects/android-room/
- Size: 279 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - sczerwinski/android-room - Extensions for Jetpack Room (Kotlin)
README
[][ci-build]
# Extensions for Jetpack Room
## Room Extensions – Aggregate
[][room-extensions-release]
[][room-extensions-snapshot]
Artifact `it.czerwinski.android.room:room-extensions` aggregates artifacts:
- `room-database`,
- `room-database-sql`.
You can either use `room-extensions` or any combination of the other artifacts, whichever suites your project.
Kotlin
```kotlin
dependencies {
implementation("androidx.room:room-runtime:2.4.2")
implementation("it.czerwinski.android.room:room-extensions:[VERSION]")
}
```
Groovy
```groovy
dependencies {
implementation 'androidx.room:room-runtime:2.4.2'
implementation 'it.czerwinski.android.room:room-extensions:[VERSION]'
}
```
## Room Database Extensions
[][room-database-release]
[][room-database-snapshot]
Kotlin
```kotlin
dependencies {
implementation("androidx.room:room-runtime:2.4.2")
implementation("it.czerwinski.android.room:room-database:[VERSION]")
}
```
Groovy
```groovy
dependencies {
implementation 'androidx.room:room-runtime:2.4.2'
implementation 'it.czerwinski.android.room:room-database:[VERSION]'
}
```
### Room Database Builders
#### `roomDatabaseBuilder`
Creates a `RoomDatabase.Builder` for a persistent database with type `T` and the given `name`.
```kotlin
val database = context.roomDatabaseBuilder().build()
```
or:
```kotlin
val database = context.roomDatabaseBuilder(name = "database").build()
```
#### `roomInMemoryDatabaseBuilder`
Creates a `RoomDatabase.Builder` for an in memory database with type `T`.
```kotlin
val database = context.roomInMemoryDatabaseBuilder().build()
```
## Room Database SQL Extensions
[][room-database-sql-release]
[][room-database-sql-snapshot]
Kotlin
```kotlin
dependencies {
implementation("androidx.room:room-runtime:2.3.0")
implementation("it.czerwinski.android.room:room-database-sql:[VERSION]")
}
```
Groovy
```groovy
dependencies {
implementation 'androidx.room:room-runtime:2.3.0'
implementation 'it.czerwinski.android.room:room-database-sql:[VERSION]'
}
```
### SQL Script Executor
```kotlin
val database: SupportSQLiteDatabase
val sqlScriptExecutor = SQLScriptExecutor {
+"""
insert into users(id, username, password) values (1, 'root', 'qwerty');
insert into user_roles(user_id, role_id) values (1, 1);
"""
}
sqlScriptExecutor.executeOn(database)
```
### Room Database Builder Extensions
#### Populate From SQL
Configures Room to populate a newly created database with an SQL script.
```kotlin
val database = context.roomDatabaseBuilder()
.populateFromSql {
+"""
insert into users(id, username, password) values (1, 'root', 'qwerty');
insert into user_roles(user_id, role_id) values (1, 1);
"""
}
.build()
```
#### Populate From SQL Asset
Configures Room to populate a newly created database with an SQL script located in the application `assets/` folder.
```kotlin
val database = context.roomDatabaseBuilder()
.populateFromSqlAsset(context, "sql/populate.sql")
.build()
```
#### Add Migration From SQL
Adds an SQL script migration to the builder.
```kotlin
val database = context.roomDatabaseBuilder()
.addMigrationFromSql(startVersion = 1, endVersion = 2) {
+"""
create table if not exists users (
id integer primary key asc,
username text not null,
password text not null
);
"""
}
.build()
```
#### Add Migration From SQL Asset
Adds a migration to the builder, executing an SQL script located in the application `assets/` folder.
```kotlin
val database = context.roomDatabaseBuilder()
.addMigrationFromSqlAsset(startVersion = 1, endVersion = 2, context, "sql/migrate_1_2.sql")
.build()
```
#### Add Migrations From SQL Assets
Adds migrations to the builder, executing an SQL scripts located in the application `assets/` folder,
matching the given format.
```kotlin
val database = context.roomDatabaseBuilder()
.addMigrationsFromSqlAssets(context, sqlFilePathFormat = "sql/migrate_{}_{}.sql")
.build()
```
## Room `TypeConverter`s Generator (Removed)
**Removed in v1.2.0:** [Room 2.3.0][room:2.3.0] offers built-in `enum` support.
Latest release of the library no longer includes artifacts:
* `it.czerwinski.android.room:room-converters`
* `it.czerwinski.android.room:room-converters-processor`
[][room-converters-release]
### Deprecated `GenerateEnumTypeConverter` Annotation
**Removed in v1.2.0:** [Room 2.3.0][room:2.3.0] offers built-in `enum` support.
[ci-build]: https://github.com/sczerwinski/android-room/actions?query=workflow%3ABuild
[room-extensions-release]: https://repo1.maven.org/maven2/it/czerwinski/android/room/room-extensions/
[room-extensions-snapshot]: https://oss.sonatype.org/content/repositories/snapshots/it/czerwinski/android/room/room-extensions/
[room-database-release]: https://repo1.maven.org/maven2/it/czerwinski/android/room/room-database/
[room-database-snapshot]: https://oss.sonatype.org/content/repositories/snapshots/it/czerwinski/android/room/room-database/
[room-database-sql-release]: https://repo1.maven.org/maven2/it/czerwinski/android/room/room-database-sql/
[room-database-sql-snapshot]: https://oss.sonatype.org/content/repositories/snapshots/it/czerwinski/android/room/room-database-sql/
[room-converters-release]: https://repo1.maven.org/maven2/it/czerwinski/android/room/room-converters/
[room:2.3.0]: https://developer.android.com/jetpack/androidx/releases/room#2.3.0