How to improve my Room database architecture? - android-room

I am new to databases. I am not a professional developer. I would like your advice. I want to create a database that manages the students in a class. Students belong to only one class. I present to you my model. Can you let me know if this is correct please?
My data class: Gru
#Entity(tableName = "groupe_table")
data class Gru (
#PrimaryKey(autoGenerate = true) #ColumnInfo(name = "idGroup") var idGroup: Int=0,
#ColumnInfo(name = "nameGroupG") var nameGroupG : String
):Parcelable
#Entity(tableName = "user_table", foreignKeys = arrayOf(
ForeignKey(entity = Gru::class,
parentColumns = arrayOf("idGroup"),
childColumns = arrayOf("id"),
onDelete = ForeignKey.CASCADE)
))
#Parcelize
data class User(#PrimaryKey(autoGenerate = true) #ColumnInfo(name = "id") var id: Int=0,
#ColumnInfo(name = "nameGroup") var nameGroup: String,
#ColumnInfo(name = "firstName") var firstName: String,
#ColumnInfo(name = "lastName") var lastName: String,
#ColumnInfo(name = "nbTeam") var nbTeam: String
):Parcelable
#Entity(tableName = "eval_table", foreignKeys = arrayOf(
ForeignKey(entity = User::class,
parentColumns = arrayOf("id"),
childColumns = arrayOf("idEval"),
onDelete = ForeignKey.CASCADE)
))
data class Eval(#PrimaryKey(autoGenerate = true) #ColumnInfo(name = "idEval") var idEval: Int=0,
#ColumnInfo(name = "note_classement") var note_classement: String,
#ColumnInfo(name = "note_attaque") var note_attaque: String,
#ColumnInfo(name = "note_passe") var note_passe: String,
#ColumnInfo(name = "note_afl2") var note_afl2: String,
#ColumnInfo(name = "note_afl3") var note_afl3: String,
#ColumnInfo(name = "note_sur_vingt") var note_sur_vingt: String)
Here my dataclass to create relations
data class GruWithUser(
var idGroup: Int,
var nameGroupG: String,
var id: Int,
var nameGroup: String,
var firstName: String,
var lastName: String,
var nbTeam: String
):Parcelable
and the last dataclass relation: User With Eval
#Parcelize
data class UserWithEval(
var id: Int,
var nameGroup: String,
var firstName: String,
var lastName: String,
var nbTeam: String,
var note_attaque: String,
var note_passe: String,
var note_classement: String,
var note_afl2: String,
var note_afl3: String,
var note_sur_vingt: String
): Parcelable
Thanks you so much for your help

Issue 1
You appear to have an issue that will likely cause some frustration if not addressed.
That is a User, has it's primary key as the reference to the parent group (Gru). As such a Group could only have a single User (Student) as the primary key, for the User must be unique.
Likewise for Eval's.
So you could consider the following:-
#Entity(tableName = "groupe_table")
data class Gru (
#PrimaryKey(autoGenerate = true) #ColumnInfo(name = "idGroup") var idGroup: Int=0,
#ColumnInfo(name = "nameGroupG") var nameGroupG : String
): Parcelable
#Entity(tableName = "user_table", foreignKeys = arrayOf(
ForeignKey(entity = Gru::class,
parentColumns = arrayOf("idGroup"),
//childColumns = arrayOf("id"), //<<<<< REMOVED
childColumns = ["gru_id_reference"], //<<<<< REPLACED WITH
onDelete = ForeignKey.CASCADE)
))
#Parcelize
data class User(#PrimaryKey(autoGenerate = true) #ColumnInfo(name = "id") var id: Int=0,
#ColumnInfo(name = "nameGroup") var nameGroup: String,
#ColumnInfo(name = "firstName") var firstName: String,
#ColumnInfo(name = "lastName") var lastName: String,
#ColumnInfo(name = "nbTeam") var nbTeam: String,
#ColumnInfo(index = true) //<<<<< ADDED (may be more efficient)
var gru_id_reference: Int //<<<<< ADDED
):Parcelable
#Entity(tableName = "eval_table", foreignKeys = arrayOf(
ForeignKey(entity = User::class,
parentColumns = arrayOf("id"),
childColumns = arrayOf("user_id_reference"), //<<<<< CHANGED
onDelete = ForeignKey.CASCADE)
))
data class Eval(#PrimaryKey(autoGenerate = true) #ColumnInfo(name = "idEval") var idEval: Int=0,
#ColumnInfo(name = "note_classement") var note_classement: String,
#ColumnInfo(name = "note_attaque") var note_attaque: String,
#ColumnInfo(name = "note_passe") var note_passe: String,
#ColumnInfo(name = "note_afl2") var note_afl2: String,
#ColumnInfo(name = "note_afl3") var note_afl3: String,
#ColumnInfo(name = "note_sur_vingt") var note_sur_vingt: String,
#ColumnInfo(index = true) var user_id_reference: Int //<<<<< ADDED
)
See the comments
note that there is no need to use #ColumnInfo to name a column the same name as the field/member (hence the added code doesn't, but instead uses the annotation to introduce an index on the additional column use to reference the parent).
Without going into all the other code, the following code:-
db = TheDatabase.getInstance(this)
dao = db.getAllDao()
val g1id = dao.insert(Gru(nameGroupG = "Group001"))
val g2id = dao.insert(Gru(nameGroupG = "Group002"))
val g3id = dao.insert(Gru(nameGroupG = "group003"))
val u1id = dao.insert(User(nameGroup = "Why have this here?", firstName = "Fred", lastName = "Bloggs", nbTeam = "TeamA", gru_id_reference = g1id.toInt()))
val u2id = dao.insert(User(nameGroup = "?????", firstName = "Jane", lastName = "Doe", nbTeam = "TeamX", gru_id_reference = g1id.toInt()))
val u3id = dao.insert(User(nameGroup = "?????", firstName = "Mary", lastName = "Smith", nbTeam = "TeamB", gru_id_reference = g2id.toInt()))
val u4id = dao.insert(User(nameGroup = "?????", firstName = "Tom", lastName = "Cobbely", nbTeam = "TeamC", gru_id_reference = g3id.toInt()))
var baseEval = Eval(note_classement = "CMENT_", note_attaque = "ATTQ_", note_afl2 = "AFL2_", note_afl3 = "AFL3_", note_passe = "PASSE_", note_sur_vingt = "SV_",user_id_reference = -99)
for (i in 1..10) {
dao.insert(
Eval(
note_classement = baseEval.note_classement + i,
note_attaque = baseEval.note_classement + i,
note_afl2 = baseEval.note_afl2 + i,
note_afl3 = baseEval.note_afl3 + i,
note_passe = baseEval.note_passe + i,
note_sur_vingt = baseEval.note_sur_vingt + i,
user_id_reference = Random.nextInt(4) + 1
)
)
}
results in a database (i.e. tests the changed code) as per :-
The 3 Groups (Gru's/Classes) :-
The 4 users :-
Note how Fred and Jane are both in Group001
And the 10 Eval's spread across the 4 Users
A query that joins the data according to the relationships looks like:-
- here you can see that there are 3 evaluations for Group001, 2 of them for Fred and 1 for Jane etc
- (note Eval's reference a random User)
The above data was obtained by running the code above and then using App Inspection (available in Android Studio).
Issue 2
You may well encounter subsequent issues due to both the user_table and the eval_table having a column named id. From an SQL point of view this can be overcome by qualifying the column with it's table name (see SQL used above where the tablename . column is used to disambiguate the ambiquity). However, as far as the resultant output there would still be 2 id columns. This ambiguity can be overcome using AS to rename the output column but you may then encounter issues. I would suggest ensuring that all column names are unique (so perhaps have column names userId and evalId instead of just id).

Related

Kotlin MVVM, How to get the latest value from Entity in ViewModel?

I have created an app where I try to insert a record with the latest order number increased by one.
The main function is triggered from Activity, however, the whole process is in my ViewModel.
Issue no 1, After I insert a new record the order by number is not updated.
Issue no 2, When I insert first record the order by number is null, for that reason I am checking for null and setting the value to 0.
My goal here is to get the latest order_by number from Entity in my ViewModel, increased by 1 and add that new number to my new record using fun addTestData(..).
Entity:
#Entity(tableName = "word_table")
data class Word(
#ColumnInfo(name = "id") val id: Int,
#ColumnInfo(name = "word") val word: String,
#ColumnInfo(name = "order_by") val orderBy: Int
Dao:
#Query("SELECT order_by FROM word_table ORDER BY order_by DESC LIMIT 1")
suspend fun getHighestOrderId(): Int
Repository:
#Suppress("RedundantSuspendModifier")
#WorkerThread
suspend fun getHighestOrderId(): Int {
return wordDao.getHighestOrderId()
}
ViewModel:
private var _highestOrderId = MutableLiveData<Int>()
val highestOrderId: LiveData<Int> = _highestOrderId
fun getHighestOrderId() = viewModelScope.launch {
val highestOrderId = repository.getHighestOrderId()
_highestOrderId.postValue(highestOrderId)
}
fun addTestData(text: String) {
for (i in 0..1500) {
getHighestOrderId()
var highestNo = 0
val highestOrderId = highestOrderId.value
if (highestOrderId == null) {
highestNo = 0
} else {
highestNo = highestOrderId
}
val addNumber = highestNo + 1
val word2 = Word(0, text + "_" + addNumber,addNumber)
insertWord(word2)
}
}
Activity:
wordViewModel.addTestData(text)

Get data from 4 tables in Android Room

I'm trying to get data from the database using Room, I want to get the data in the format {registration_number, List, List} but I'm getting an error:
"Cannot find the parent entity column area_name in ... and my intermediate class"
and in fact I hide that maybe I am taking the wrong approach, please guide me, because I am new in this area
to extract the data I use an intermediate class
my class is:
data class LastConfiscats(
#ColumnInfo(name = "registration_number")
var slaugh_num: String,
// #ColumnInfo(name = "area_name",
#Relation(entity = Area::class, parentColumn = "area_name", entityColumn = "name")
var areaName: List<String>,
// #ColumnInfo(name = "confiscation_name")
#Relation(entity = Confiscation::class, parentColumn = "confiscation_name", entityColumn = "name")
var confiscationName: List<String>
and DAO method to select data:
#Query("SELECT registration_number, area.[name] AS area_name, confiscations.[name] AS confiscation_name " +
"FROM car_body, car_body_confiscations" +
"INNER JOIN area ON car_body_confiscations.area_id == area.id " +
"INNER JOIN confiscations ON car_body_confiscations.confiscation_id == confiscations.id " +
"WHERE car_body.id == car_body_confiscations.car_body_id ORDER BY car_body.id DESC LIMIT :row_count")
fun getLastConfiscats(row_count: Int): LiveData<List<LastConfiscats>>
The linkage scheme between the tables that I am trying to implement is as follows:
There are examples on the internet how to make a relationship between 2 tables but I need to create a relationship between 4 tables.
Please help me to get the data in the right way
UPDATE :
My Area entity is:
#Entity(tableName = "area")
data class Area( #PrimaryKey(autoGenerate = true) var id: Int?, var name: String? )
but in my Confiscation entity I also have "name" column:
#Entity(tableName = "confiscations")
data class Confiscation( #PrimaryKey(autoGenerate = true) var id: Int?, var name: String? )
The actual message you are getting is because when you use #Relation the parent MUST exist and be annotated with #Embedded.
The parent and entity columns MUST be columns in the respective classes.
As an example the following will enable you to get a List of Confiscations, with the related CarBody and the respective Areas (note colum names based upon the screen shots):-
data class LastConfiscats(
#Embedded
var carBodyConfiscations: Car_Body_Confiscations,
#Relation(entity = CarBody::class, parentColumn = "car_body_id", entityColumn = "id")
var carBody: CarBody,
#Relation(entity = Area::class, parentColumn = "areaId", entityColumn = "id")
var area: List<Area>
)
You could use the above with a query such as:-
#Query("SELECT * FROM Car_Body_Confiscations")
fun getCardBodyJoinedWithStuff(): List<LastConfiscats>
No JOINS needed. That is because Room builds the underlying SQL. First is basically the copy of the supplied query. After retrieving the Car_Body_Confiscations it then uses queries based upon the field names/#ColumnInfo and runs queries for each Car_Body_Connfiscation.
For each #Relationship it populates the respective fields (1 carBody and the List of Areas) using queries that it builds. Here's and example of part of the code, for the above from the java(generated) for the query above :-
Main (parent query)
#Override
public List<LastConfiscats> getCardBodyJoinedWithStuff() {
final String _sql = "SELECT * FROM Car_Body_Confiscations";
final RoomSQLiteQuery _statement = RoomSQLiteQuery.acquire(_sql, 0);
....
Later Nn (getting the CarBody(s) there will only be 1)
StringBuilder _stringBuilder = StringUtil.newStringBuilder();
_stringBuilder.append("SELECT `id`,`registrationNumber`,`datetime`,`userId`,`testId` FROM `CarBody` WHERE `id` IN (");
final int _inputSize = _map.size();
Even Later On (Areas)
StringBuilder _stringBuilder = StringUtil.newStringBuilder();
_stringBuilder.append("SELECT `id`,`name` FROM `Area` WHERE `id` IN (");
Now if you want to code your own JOINS etc and alias columns then you will have to consider a few things.
The receiving class MUST be able to be built from the result set and thus column names MUST match the fields in the POJO (unless using #Prefix annotation).
You also need to be aware that the result set will be the cartesian product, thus in the case of doing the above, bypassing how Room does it, the for each combination/permutation of confiscation/carbody/area you get a row (unless grouped/excluded by where clause). So if you have 1 confiscation joined to 1 car but with 10 areas then you would get 10 rows all with the same confiscation and carbody.
You may wish to consider having a look at Room #Relation annotation with a One To Many relationship. Which explains this a little more and includes an example of using a JOINs
Additional - User and TestLists
You may well want to include the CarBody's User and the Test_Lists so you have a result with all of the related data.
This needs to be looked at from a hierarchical perspective. That is the confiscation has a direct link/reference/map to the CarBody but underneath that are the links/references/mappings to the User from the CarBody and to the Test_Lists.
So to incorporate this you need a POJO for a CarBody with it's User and it's Test_Lists. So, for example:-
data class CarBodyWithUserAndWithTestList(
#Embedded
var carBody: CarBody,
#Relation(
entity = Users::class,
parentColumn = "userId",
entityColumn = "id"
)
var users: Users,
#Relation(
entity = Test_List::class,
parentColumn = "testId",
entityColumn = "id"
)
var testList: List<Test_List>
)
With this you can then amend the LastConfiscats to include a CarBodyWithUserAndWithTestList instead of just a CarBody e.g.:
data class LastConfiscats(
#Embedded
var carBodyConfiscations: Car_Body_Confiscations,
#Relation(entity = CarBody::class, parentColumn = "car_body_id", entityColumn = "id")
//var carBody: CarBody, /* REMOVED */
var carBodyWithUserAndWithTestList: CarBodyWithUserAndWithTestList, /* ADDED */
#Relation(entity = Area::class, parentColumn = "areaId", entityColumn = "id")
var area: List<Area>
)
Note that the #Relation has the CarBody class as the entity. That is because the CarBody is the class that needs to be inspected in order for Room to ascertain the columns used for the links/references/,mappings.
*Working Example/Demo
Here's the entire code for a Working example that inserts some data into all the tables and then extracts the data using the getCardBodyJoinedWithStuff query, it then writes the data to the Log.
the code includes ForeignKey constraints which enforces and helps to maintain referential integrity.
for id's Long rather than Int has been used as Long properly reflects the potential size of the field/value.
autoGenerate = true has not been used as this is inefficient and not needed see https://sqlite.org/autoinc.html, which includes as the very first statement The AUTOINCREMENT keyword imposes extra CPU, memory, disk space, and disk I/O overhead and should be avoided if not strictly needed. It is usually not needed. (autoGenerate = true results in AUTOINCREMENT)
So all the classes/interfaces :-
#Entity(
foreignKeys = [
ForeignKey(
Users::class,
parentColumns = ["id"],
childColumns = ["userId"],
onDelete = ForeignKey.CASCADE,
onUpdate = ForeignKey.CASCADE
),
ForeignKey(
Test_List::class,
parentColumns = ["id"],
childColumns = ["testId"],
onDelete = ForeignKey.CASCADE,
onUpdate = ForeignKey.CASCADE
)
]
)
data class CarBody(
#PrimaryKey
var id: Long?=null,
var registrationNumber: Int,
var datetime: String,
#ColumnInfo(index = true)
var userId: Long,
#ColumnInfo(index = true)
var testId: Long
)
#Entity
data class Users(
#PrimaryKey
var id:Long?=null,
var name: String,
var lastName: String,
var email: String,
var password: String
)
#Entity
data class Test_List(
#PrimaryKey
var id: Long?=null,
var date: String,
var is_saved: Boolean
)
#Entity(
foreignKeys = [
ForeignKey(
entity = CarBody::class,
parentColumns = ["id"],
childColumns = ["car_body_id"],
onDelete = ForeignKey.CASCADE,
onUpdate = ForeignKey.CASCADE
),
ForeignKey(
entity = Confiscation::class,
parentColumns = ["id"],
childColumns = ["confiscation_id"],
onDelete = ForeignKey.CASCADE,
onUpdate = ForeignKey.CASCADE
),
ForeignKey(
entity = Area::class,
parentColumns = ["id"],
childColumns = ["areaId"],
onDelete = ForeignKey.CASCADE,
onUpdate = ForeignKey.CASCADE
)
]
)
data class Car_Body_Confiscations(
#PrimaryKey
var id: Long?=null,
#ColumnInfo(index = true)
var car_body_id: Long,
#ColumnInfo(index = true)
var confiscation_id: Long,
#ColumnInfo(index = true)
var areaId: Long
)
#Entity
data class Area(
#PrimaryKey
var id: Long?=null,
var name: String
)
#Entity
data class Confiscation(
#PrimaryKey
var id: Long?=null,
var name: String
)
#Dao
interface AllDao {
#Insert(onConflict = OnConflictStrategy.IGNORE)
fun insert(area: Area): Long
#Insert(onConflict = OnConflictStrategy.IGNORE)
fun insert(carBodyConfiscations: Car_Body_Confiscations): Long
#Insert(onConflict = OnConflictStrategy.IGNORE)
fun insert(carBody: CarBody): Long
#Insert(onConflict = OnConflictStrategy.IGNORE)
fun insert(confiscation: Confiscation): Long
#Insert(onConflict = OnConflictStrategy.IGNORE)
fun insert(users: Users): Long
#Insert(onConflict = OnConflictStrategy.IGNORE)
fun insert(testList: Test_List): Long
#Transaction
#Query("SELECT * FROM Car_Body_Confiscations")
fun getCardBodyJoinedWithStuff(): List<LastConfiscats>
}
#Database(entities = [
Area::class,
Car_Body_Confiscations::class,
CarBody::class,
Confiscation::class,
Users::class,
Test_List::class
],
exportSchema = false, version = 1)
abstract class TheDatabase: RoomDatabase() {
abstract fun getAllDao(): AllDao
companion object {
private var instance: TheDatabase?=null
fun getInstance(context: Context): TheDatabase {
if (instance==null) {
instance = Room.databaseBuilder(context,TheDatabase::class.java,"the_database.db")
.allowMainThreadQueries()
.build()
}
return instance as TheDatabase
}
}
}
data class LastConfiscats(
#Embedded
var carBodyConfiscations: Car_Body_Confiscations,
#Relation(entity = Confiscation::class, parentColumn = "confiscation_id", entityColumn = "id")
var confiscation: Confiscation,
#Relation(entity = CarBody::class, parentColumn = "car_body_id", entityColumn = "id")
//var carBody: CarBody, /* REMOVED */
var carBodyWithUserAndWithTestList: CarBodyWithUserAndWithTestList, /* ADDED */
#Relation(entity = Area::class, parentColumn = "areaId", entityColumn = "id")
var area: List<Area>
)
data class CarBodyWithUserAndWithTestList(
#Embedded
var carBody: CarBody,
#Relation(
entity = Users::class,
parentColumn = "userId",
entityColumn = "id"
)
var users: Users,
#Relation(
entity = Test_List::class,
parentColumn = "testId",
entityColumn = "id"
)
var testList: List<Test_List>
)
The following activity code (note that main thread used for brevity and convenience):-
class MainActivity : AppCompatActivity() {
lateinit var db: TheDatabase
lateinit var dao: AllDao
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
db = TheDatabase.getInstance(this)
dao = db.getAllDao()
dao.insert(Users(100,"Fred","Bloggs","fredBloggs#mail.com","password"))
dao.insert(Users(200,"Jane","Doe","janeDoe#email.org","password"))
/* example where id is autogenerated */
val marySmithId = dao.insert(Users(name = "Mary", lastName = "Smith", email = "marysmith#mailit.co.uk", password = "1234567890"))
dao.insert(Test_List(1,"2022-01-01",false))
dao.insert(Test_List(2,"2022-02-02",true))
dao.insert(CarBody(1000,1234,"2022-01-01",100 /* Fred Bloggs*/,2 ))
dao.insert(CarBody(2000,4321,"2021-12-05",100,1))
dao.insert(CarBody(3000,1111,"2021-09-10",200,2))
dao.insert(Area(100,"Area100"))
dao.insert(Area(200,"Area200"))
dao.insert(Area(300,"Area300"))
dao.insert(Area(400,"Area400"))
dao.insert(Confiscation(901,"C1"))
dao.insert(Confiscation(902,"C2"))
dao.insert(Confiscation(903,"C3"))
dao.insert(Confiscation(904,"C4"))
dao.insert(Car_Body_Confiscations(500,1000,901,100))
dao.insert(Car_Body_Confiscations(510,2000,904,400))
dao.insert(Car_Body_Confiscations(520,3000,902,300))
/* Extract the data and output to the Log */
for(cbc in dao.getCardBodyJoinedWithStuff()) {
val areaList = StringBuilder()
for (a in cbc.area) {
areaList.append("\n\t\tArea is ${a.name} ID is ${a.id}")
}
val testList = StringBuilder()
testList.append("\n\t\tThere are ${cbc.carBodyWithUserAndWithTestList.testList.size} TestLists, they are:")
for (t in cbc.carBodyWithUserAndWithTestList.testList) {
testList.append("\n\t\t\t${t.date} Save is ${t.is_saved} ID is ${t.id}")
}
Log.d(
"DBINFO",
"CBC ID =${cbc.carBodyConfiscations.id}" +
"\n\tConfiscation Name is ${cbc.confiscation.name}" +
"\n\tAreas (there is/are ${cbc.area.size}) they are $areaList}" +
"\n\tCarBody Reg is ${cbc.carBodyWithUserAndWithTestList.carBody.registrationNumber} " +
"Date is ${cbc.carBodyWithUserAndWithTestList.carBody.datetime}" +
"\n\t\tUser is ${cbc.carBodyWithUserAndWithTestList.users.name}" +
",${cbc.carBodyWithUserAndWithTestList.users.lastName} " +
"email is ${cbc.carBodyWithUserAndWithTestList.users.email}" +
"$testList"
)
}
}
}
Result
The Log after running:-
D/DBINFO: CBC ID =500
Confiscation Name is C1
Areas (there is/are 1) they are
Area is Area100 ID is 100}
CarBody Reg is 1234 Date is 2022-01-01
User is Fred,Bloggs email is fredBloggs#mail.com
There are 1 TestLists, they are:
2022-02-02 Save is true ID is 2
D/DBINFO: CBC ID =510
Confiscation Name is C4
Areas (there is/are 1) they are
Area is Area400 ID is 400}
CarBody Reg is 4321 Date is 2021-12-05
User is Fred,Bloggs email is fredBloggs#mail.com
There are 1 TestLists, they are:
2022-01-01 Save is false ID is 1
D/DBINFO: CBC ID =520
Confiscation Name is C2
Areas (there is/are 1) they are
Area is Area300 ID is 300}
CarBody Reg is 1111 Date is 2021-09-10
User is Jane,Doe email is janeDoe#email.org
There are 1 TestLists, they are:
2022-02-02 Save is true ID is 2
Re the Comment
I actually have a Cartesian product, I had to process it somehow, although I do not know how yet.
You may find that the above is fine and processes the product pretty easily.
Where Room's relationship handling can become restrictive is if you want to selectively retrieve related data. The way Room handles #Relation means that it retrieves ALL children irrespective of any JOINS and WHERE clauses. They are only effective if they affect the result of the topmost parent.
In your case, where you don't actually cater for lists (such as multiple users per carbody) then Room should suffice.
The original Query - revisited
Changing your query a little to (largely to suit the previous classes ) to:-
#Query("SELECT " +
"registrationNumber, " +
"area.[name] AS area_name, " +
"confiscation.[name] AS confiscation_name " +
"FROM carbody, car_body_confiscations " +
"INNER JOIN area ON car_body_confiscations.areaId == area.id " +
"INNER JOIN confiscation ON car_body_confiscations.confiscation_id == confiscation.id " +
"WHERE carbody.id == car_body_confiscations.car_body_id " +
"ORDER BY carbody.id DESC " +
"LIMIT :row_count"
)
fun getLastConfiscats(row_count: Int): /*LiveData<*/List<MyQueryPOJO>/*>*/
see the following re MyQueryPOJO
And adding a suitable class (no #Embeddeds or #Relations needed, so Room doesn't get confused with column names) :-
data class MyQueryPOJO(
/* The output columns of the query */
var registrationNumber: Int,
#ColumnInfo(name = "area_name")
var not_the_area_name: String,
var confiscation_name: String
)
note how the not_the_area_name field has the #ColumnInfo annotation to tell it to use the area_name output column
In the activity, using:-
for (mqo in dao.getLastConfiscats(10)) {
Log.d("DBINFO","Reg = ${mqo.registrationNumber} Confiscation = ${mqo.confiscation_name} Area Name = ${mqo.not_the_area_name}")
}
Results in (with the same data) :-
D/DBINFO: Reg = 1111 Confiscation = C2 Area Name = Area300
D/DBINFO: Reg = 4321 Confiscation = C4 Area Name = Area400
D/DBINFO: Reg = 1234 Confiscation = C1 Area Name = Area100
as the relationships all all basically 1-1 (the references are back to front for a 1-many) the cartesian product is fine as there will not be any duplicates.

how to save a complex object in a Room database?

I'm trying to save Lists and Books data in a local database using Room.
where each list contains books.
but have a problem implementing this.
Well, I used type converters & it worked but the google docs suggest that that's not an ideal way of saving complex objects and suggest using Relationships
So I tried to define a relationship between the two objects but I couldn't get it to work.
can someone please help out.
#Entity(tableName = "lists_table")
data class Lists(
#PrimaryKey
#ColumnInfo(name = "display_name")
#Json(name = "display_name") val displayName: String,
val books: List<Books>
)
#Entity(tableName = "books_table")
data class Books(
#PrimaryKey
#ColumnInfo(name = "author") val author: String,
#ColumnInfo(name = "book_image") #Json(name = "book_image") val bookImage: String,
#ColumnInfo(name = "width") #Json(name = "book_image_width") val imageWidth: Int,
#ColumnInfo(name = "height") #Json(name = "book_image_height") val imageHeight: Int,
#ColumnInfo(name = "contributor") val contributor: String,
#ColumnInfo(name = "description") val description: String,
#ColumnInfo(name = "publisher") val publisher: String,
#ColumnInfo(name = "rank") val rank: Int,
#ColumnInfo(name = "rank_last_week") #Json(name = "rank_last_week") val rankLastWeek: Int,
#ColumnInfo(name = "title") val title: String,
#ColumnInfo(name = "weeks_on_list") #Json(name = "weeks_on_list") val weeksOnList: Int,
)
Assuming that a Book can exist in many lists, not just one list (a many-many relationship) then you have an table (know by many names such as a reference table, mapping table, associative table ....). Such a table has a map to one of the objects (list or book) an a map to the other (book or list).
To map an object then the map must uniquely identify the mapped object. As PRIMARY KEYS must be UNIQUE then in your case the display_name column is the primary key for a Lists object and the author column is the primary key for a book object.
You may wish to reconsider, as the implication is that every book must have an author unique to the book, so an author could not have multiple books.
So the mapping table would consist of these two columns (display_name and author). The display_name together with the author would be the primary key.
You cannot use the #PrimaryKey annotation to specify a composite primary key, so you use the primaryKeys parameter of the #Entity annotation, which takes a value that is an array of Strings (the respective column names) .
A consideration, is whether or not to enforce the relationships actually being true relationships. ForeignKey constraints (rules) can not only enforce referential integrity they can also help maintain the integrity by specifying that children or updated/deleted in line with the parent.
So you could have:-
#Entity(
primaryKeys = ["display_name_map","bookId_map"],
/* Optional but suggested */
foreignKeys = [
ForeignKey(
entity = Lists::class,
parentColumns = ["display_name"],
childColumns = ["display_name_map"],
onDelete = ForeignKey.CASCADE,
onUpdate = ForeignKey.CASCADE
),
ForeignKey(
entity = Books::class,
parentColumns = ["bookId"],
childColumns = ["bookId_map"],
onDelete = ForeignKey.CASCADE,
onUpdate = ForeignKey.CASCADE
)
]
)
data class ListsBookMap(
val display_name_map: String,
#ColumnInfo(index = true) /* have an index associated with the table according to bookId */
val bookId_map: Long
)
Note that bookId is the mapped column, thus an author can author many books
i.e. Books has changed to:-
#PrimaryKey
val bookId: Long?=null, /* ADDED as the primary key so that an author can have many books */
#ColumnInfo(name = "author") val author: String,
To facilitate retrieving the parent (Lists) with it's related children (Books) then you utilise a POJO with the parent annotated with #Embedded and the list of children annotated with the #Relation annotation that includes the associateBy parameter to specify the mapping table and the columns therein, i.e. the Junction.
So this could be:-
data class ListWithBooks(
#Embedded
val list: Lists,
#Relation(
entity = Books::class,
parentColumn = "display_name",
entityColumn = "bookId",
associateBy = Junction(
ListsBookMap::class,
parentColumn = "display_name_map",
entityColumn = "bookId_map"
)
)
val booksList: List<Books>
)
You would ned to be able to insert data, including the mappings so you could have an #Dao annotated interface such as :-
#Dao
interface ListAndBookDao {
#Insert(onConflict = OnConflictStrategy.IGNORE)
fun insert(books: Books): Long
#Insert(onConflict = OnConflictStrategy.IGNORE)
fun insert(lists: Lists): Long
#Insert(onConflict = OnConflictStrategy.IGNORE)
fun insert(listsBookMap: ListsBookMap): Long
#Transaction
#Query("SELECT * FROM lists_table")
fun getAllListsWithListOfBooks(): List<ListsWithBooks>
}
Note the #Query this will retrieve Lists with the books for the current Lists.
Demo
Using the above, and a suitable #Database annotated abstract class, and the following in an activity (note run on the main thread for convenience and brevity):-
class MainActivity : AppCompatActivity() {
lateinit var db: TheDatabase
lateinit var dao: ListAndBookDao
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
db = TheDatabase.getInstance(this)
dao = db.getListAndBookDao()
val b1Id = dao.insert(Books(null,"A1","B1IMAGE",10,12,"C","Desc","P",5,4,"The Book 1",10))
val b2Id = dao.insert(Books(null,"A2","B2IMAGE",10,12,"C","Desc","P",5,4,"The Book 2",10))
val b3Id = dao.insert(Books(null,"A3","B3IMAGE",10,12,"C","Desc","P",5,4,"The Book 3",10))
val b4Id = dao.insert(Books(null,"A1","B4IMAGE",10,12,"C","Desc","P",5,4,"The Book 4",10))
val b5Id = dao.insert(Books(null,"A4","B5IMAGE",10,12,"C","Desc","P",5,4,"The Book 5",10))
val list1Name = "BL001"
val list2Name = "BL002"
val list3Name = "BL003"
val list4Name = "BL004"
val list5Name ="BL005"
dao.insert(Lists(list1Name))
dao.insert(Lists(list2Name))
dao.insert(Lists(list3Name))
dao.insert(Lists(list4Name))
dao.insert(Lists(list5Name))
/* Add books to the lists (i.e. the mappings)*/
dao.insert(ListsBookMap(list1Name,b1Id))
dao.insert(ListsBookMap(list1Name,b3Id))
dao.insert(ListsBookMap(list1Name,b5Id))
dao.insert(ListsBookMap(list2Name,b2Id))
dao.insert(ListsBookMap(list2Name,b4Id))
dao.insert(ListsBookMap(list3Name,b1Id))
dao.insert(ListsBookMap(list3Name,b2Id))
dao.insert(ListsBookMap(list3Name,b3Id))
dao.insert(ListsBookMap(list3Name,b4Id))
dao.insert(ListsBookMap(list3Name,b5Id))
dao.insert(ListsBookMap(list4Name,b3Id))
val sb = StringBuilder()
for (lwb in dao.getAllListsWithListOfBooks()) {
sb.clear()
for (b in lwb.booksList) {
sb.append("\n\tBook is ${b.title}, Author is ${b.author} Image is ${b.bookImage} ....")
}
Log.d("DBINFO","List is ${lwb.list.displayName} it has ${lwb.booksList.size} books. They are:-$sb")
}
}
}
When run (only designed to run once) then the output to the log includes:-
D/DBINFO: List is BL001 it has 3 books. They are:-
Book is The Book 1, Author is A1 Image is B1IMAGE ....
Book is The Book 3, Author is A3 Image is B3IMAGE ....
Book is The Book 5, Author is A4 Image is B5IMAGE ....
D/DBINFO: List is BL002 it has 2 books. They are:-
Book is The Book 2, Author is A2 Image is B2IMAGE ....
Book is The Book 4, Author is A1 Image is B4IMAGE ....
D/DBINFO: List is BL003 it has 5 books. They are:-
Book is The Book 1, Author is A1 Image is B1IMAGE ....
Book is The Book 2, Author is A2 Image is B2IMAGE ....
Book is The Book 3, Author is A3 Image is B3IMAGE ....
Book is The Book 4, Author is A1 Image is B4IMAGE ....
Book is The Book 5, Author is A4 Image is B5IMAGE ....
D/DBINFO: List is BL004 it has 1 books. They are:-
Book is The Book 3, Author is A3 Image is B3IMAGE ....
D/DBINFO: List is BL005 it has 0 books. They are:-
i.e. as expected

Filter inside MemberProperties return error : Expected type mismatch: inferred type is KProperty1<out Any!, Any?>? but KProperty1<T, *>? was expected

I'm trying to create a inline function that can return entity column name, but get error when i try to filter list of memberProperties from a instance class that i create
This is the error i get :
Expected type mismatch: inferred type is KProperty1<out Any!, Any?>? but KProperty1<T, *>? was expected
i try the tutorial from this Create a class instance using a string containing the package name and class name
Here is my entity:
#Entity
#Table(name = "employee", schema = "dbo")
data class Employee(
#Id
#Column(name = "id", nullable = false, length = 20)
var id: String,
#Column(name = "employee_name", nullable = true, length = 30)
var employeeName: String? = "",
#ManyToOne
#JoinColumn(name = "dept_code", referencedColumnName = "dept_code", nullable = true)
var dept: MasterDept? = null
)
#Entity
#Table(name = "ms_dept", schema = "dbo")
data class MasterDept(
#Id
#Column(name = "dept_code", nullable = false, length = 20)
var code: String,
#Column(name = "dept_desc", nullable = true, length = 100)
var desc: String? = "",
#ManyToOne
#JoinColumn(name = "div_code", referencedColumnName = "div_code", nullable = true)
var div: MasterDiv? = null
)
#Entity
#Table(name = "ms_div", schema = "dbo")
data class MasterDiv(
#Id
#Column(name = "div_code", nullable = false, length = 20)
var code: String,
#Column(name = "div_desc", nullable = true, length = 100)
var desc: String? = ""
)
i try to get column name from property desc of entity MasterDept or MasterDiv, depend of usage
here is my function :
inline fun <reified T : Any> getColumnName(filt:String):String {
var listFilter:List<String> = listOf();
if(filt.contains(".", true)){
listFilter = filt.split(".")
filt = listFilter.get(0)
}
var property = T::class.memberProperties.filter { prop -> prop.name == filt}.firstOrNull()//here is working
var colName : String = ""
var tableName:String = ""
if(listFilter.size > 1){
var idx:Int = 1
for(item : String in listFilter) {
if(idx < listFilter.size){
val cls = Class.forName(property!!.returnType.toString()).kotlin
var table = cls.annotations.find { it.annotationClass == Table::class } as? Table
tableName = table!!.name
property = cls.memberProperties.filter { prop -> prop.name == listFilter.get(idx)}.firstOrNull() //error in here
}
idx++
}
}
var field = property!!.javaField!!
var column = field.getAnnotation(Column::class.java)
return tableName + "." + column!!.name()
}
filt parameter sometimes is "employeeName", "dept.desc" or "dept.div.desc"
am i missing something??
I would be glad for any help.
Kotlin is a strongly typed language. You can't declare a variable with a type KProperty1<T, *>? and reassign it with a value of type KProperty1<out Any, *>? (because the latter is not a subtype of the former). Actually, you haven't declared these types explicitly; they were inferred by the compiler.
Not sure what's going on in this code (and if it is possible to avoid mutation of the property variable, which is preferrable), but you can fix this error by declaring property's type as KProperty1<*, *>?, which is a supertype of all other KProperty1 types; also its declaration could be simplified:
var property: KProperty1<*, *>? = T::class.memberProperties.firstOrNull { it.name == filt }

How do you make composite primary key with one being autogenerated?

I have the following object:
#Entity(tableName = "Section", primaryKeys = ["sectionID","number","numberOfServers"])
data class Section(
#ColumnInfo(name = "number")
var number: Int,
#ColumnInfo(name = "numberOfServer")
var numberOfServers: Int
){
#ColumnInfo(name = "sectionID")
var id: Long = 0
}
then I have the DAO method to insert into room as such:
#Insert(onConflict = OnConflictStrategy.IGNORE)
suspend fun insertSection(section: Section): Long
My goal is for an insert operation to be ignored if a Section object with the same pair of number and numberOfServers already exists in the database. In addition I want the section to have an id which is autogenerated by room. I have seen posts that use indexes and the unique attribute to achieve the composite primary key part of my goal and then use the #PrimaryKey(autogenerate = true) to generate the id. However I am not sure that using indexes works the same as primaryKeys does. As far as I see it if I use indexes and set those to unique room will check
if(index1 != unique){
ignore
}else if(index2 != unique){
ignore
...
etc.
while what I want is more of a
if((index1 && index2 combination) != unique){
ignore
}
It seems that indexes do offer the functionality I need according to the documentation and so I ended up with this:
#Entity(tableName = "Section", indices = [Index(value = ["number","numberOfServer"], unique = true)])
data class Section(
#ColumnInfo(name = "number")
var number: Int,
#ColumnInfo(name = "numberOfServer")
var numberOfServers: Int
){
#PrimaryKey(autoGenerate = true)
#ColumnInfo(name = "sectionID")
var id: Long = 0
}
Thank you for participating

Resources