Room Persistence Library Auto-Increment Primary Key in Kotlin

By the end of this page, you will understand how Room handles primary keys, how to enable automatic ID generation with @PrimaryKey(autoGenerate = true), how inserts behave, and how to avoid common mistakes when designing Room entities in Kotlin.

Room is Android's ORM layer on top of SQLite. When you define an @Entity, Room maps that Kotlin class to a database table.

A primary key is a column whose value uniquely identifies each row. In many apps, you do not want to manually assign this value every time you insert data. Instead, you want the database to generate a new unique ID automatically.

In Room, this is done with:

@PrimaryKey(autoGenerate = true)

When autoGenerate = true is enabled:

• Room treats the field as a generated primary key.
• You usually pass 0 for an Int key when inserting a new object.
• SQLite generates the actual ID value for the row.
• Room can return the inserted row ID from the DAO.

This matters because auto-generated IDs are very common in real apps:

• users
• products
• notes
• meals
• messages

Without auto-generation, you would need to manually manage unique IDs, which is error-prone and unnecessary in most local database use cases.

Think of a Room table like a notebook where each row needs a unique ticket number.

• The row data is the actual note you write.
• The primary key is the ticket number.
• autoGenerate = true means the notebook assigns the next ticket number automatically.

So instead of saying, "This food must have ID 17," you say, "Please add this food," and Room gives it the next available ID.

The key syntax is:

@PrimaryKey(autoGenerate = true)
var foodId: Int = 0

A common Room entity looks like this:

import androidx.room.Entity
import androidx.room.PrimaryKey

@Entity
data class Food(
    val foodName: String,
    val foodDesc: String,
    val protein: Double,
    val carbs: Double,
    val fat: Double,
    val calories: Double = 0.0,
    @PrimaryKey(autoGenerate = true)
    val foodId: Int = 0
)

Why 0?

For an Int primary key with auto-generation, 0 is commonly used as the default value for new objects. Room understands that this row does not yet have a real ID from the database.

DAO example

Consider this entity and insert call:

@Entity
data class Food(
    val foodName: String,
    val foodDesc: String,
    val protein: Double,
    val carbs: Double,
    val fat: Double,
    @PrimaryKey(autoGenerate = true)
    val foodId: Int = 0
)

val food = Food(
    foodName = "Egg",
    foodDesc = "Boiled egg",
    protein = 6.0,
    carbs = 0.6,
    fat = 5.0
)

val id = foodDao.insert(food)

What happens step by step:

1. A Food object is created.
2. foodId is left at its default value of 0.
3. foodDao.insert(food) sends the object to Room.
4. Room sees that foodId is the primary key and has autoGenerate = true.

Auto-generated primary keys are useful in many real applications:

• Food tracking apps: each meal or food item gets a unique local ID.
• Notes apps: every note needs a stable identifier.
• Offline-first apps: items created locally need unique IDs before syncing.
• Inventory apps: each product record needs a distinct key.
• Task managers: every task should be uniquely identifiable for updates and deletes.

For example, if you want to edit or delete a food item later, the generated foodId gives you a reliable way to find that exact row.

In real projects, developers often combine auto-generated IDs with a few common patterns.

1. Insert and get the generated ID

@Insert
suspend fun insert(food: Food): Long

This is useful when you need to immediately navigate to a detail screen or save related data.

2. Use the ID for updates and deletes

@Update
suspend fun update(food: Food)

@Delete
suspend fun delete(food: Food)

The primary key helps Room know which row to update.

3. Keep entity creation simple

Developers usually create new entities without manually assigning IDs:

val food = Food("Apple", "Fresh apple", 0.3, 14.0, 0.2)

4. Validation before insert

1. Forgetting autoGenerate = true

Broken example:

@PrimaryKey
var foodId: Int = 0

Problem:

• Room treats foodId as a normal primary key.
• If you keep inserting rows with 0, you can get conflicts.

Fix:

@PrimaryKey(autoGenerate = true)
var foodId: Int = 0

2. Manually setting IDs for new rows unnecessarily

Broken example:

val food = Food("Milk", "Low fat milk", 3.4, 5.0, 1.0, foodId = 99)

Problem:

• You may create collisions with existing rows.
• It defeats the purpose of auto-generation.

Fix:

• Let Room assign the ID unless you have a specific reason not to.

3. Expecting the object to automatically update its property after insert

Int vs Long for Room primary keys

@PrimaryKey(autoGenerate = true)
val id: Int = 0

Rules

• Add autoGenerate = true to the primary key annotation.
• Use 0 for Int or 0L for Long as the default value.
• Do not manually assign IDs for normal inserts.
• Use the DAO @Insert return value to get the generated row ID.

Example entity

@Entity
data class Food(
    val foodName: String,
    val foodDesc: String,
    val protein: Double,
    val carbs: Double,
    val fat: Double,
    val calories: Double = 0.0,
    @PrimaryKey(autoGenerate = true)
    val foodId: Int = 0
)

Example DAO

How do I make a Room primary key auto-increment?

Use @PrimaryKey(autoGenerate = true) on the ID field.

Should I use Int or Long for a Room primary key?

Both work, but Long is often preferred for safety in larger databases.

What default value should I use for an auto-generated ID in Room?

Use 0 for Int or 0L for Long.

Do I need to set the ID before inserting a row?

No. For auto-generated keys, let Room and SQLite create it.

Can I still update a row if the ID is auto-generated?

Yes. Once the row exists, its generated primary key identifies it for updates and deletes.

Does Room automatically return the generated ID after insert?

It can, if your @Insert DAO method returns Long or List<Long>.

Is auto-increment the same as a unique key?

Not exactly. A primary key must be unique. Auto-generation is just a way to create that unique value automatically.

• @Entity — defines a Room table from a Kotlin class.
• @PrimaryKey — marks the unique identifier for each row.
• @Dao — contains database operations such as insert, update, and delete.
• @Insert — adds rows to a Room table and can return generated IDs.
• @Update — modifies existing rows using the primary key.
• @Delete — removes rows identified by their primary key.
• SQLite row IDs — helps explain how generated IDs work underneath Room.
• Data classes in Kotlin — commonly used for concise Room entity definitions.