【Jetpack】使用 Room Migration 升级数据库并导出 Schema 文件 ( Schema 文件简介 | 生成 Schema 文件配置 | 生成 Schema 文件过程 )

article/2025/10/9 0:05:10

文章目录

  • 一、Schema 文件简介
  • 二、生成 Schema 文件配置
  • 三、生成 Schema 文件过程
    • 1、数据库版本 1 - 首次运行应用
    • 2、数据库版本 1 升级至 数据库版本 2 - 第二次运行应用
    • 3、数据库版本 2 升级至 数据库版本 3 - 第三次运行应用





一、Schema 文件简介


使用 Room Migration 升级数据库 , 需要根据当前数据库版本和目标版本编写一系列 Migration 迁移类 , 并生成一个升级的 Schema 文件 , 该文件是 json 格式的文件 , 其中包含如下内容 :

  • 版本信息 : 包括 当前版本 和 目标版本 ;
  • 创建表语句 : 包括 新增的表的 定义 和 字段信息 ;
  • 删除表语句 : 包括 需要删除的 表的名称 ;
  • 修改表语句 : 包括 需要修改的表的名称 和 需要修改的字段的定义信息 ;
  • 插入数据语句 : 包括 需要插入数据的表的名称 和 插入的数据 ;
  • 删除数据语句 : 包括 需要删除数据的表的名称 和 删除的条件 ;

Schema 文件是 描述 Room 数据库结构的文件 , 通过该文件 , 可以 很方便地开发者了解数据库的历史变更记录 , 方便排查问题 ;

Schema 文件 定义了数据库中的表、列、索引等元素的结构 , 并包含了创建和升级数据库的 SQL 脚本 ;


使用 Room 的 Migration 升级数据库 , 生成的 Schema 文件的方式通常是通过 Gradle 构建脚本中的 roomExportSchema 任务，它会将 Schema 文件导出到指定的目录中 , 该目录需要在 build.gradle 构建脚本中配置 ;





二、生成 Schema 文件配置


在进行 Room 数据库升级时 , 可以使用 Room Migration 工具生成 Schema 文件 ;

如果想要 导出 Schema 文件 , 需要在 RoomDatabase 实现类的 @Database 注解中 , 设置 exportSchema = true 参数 ;

@Database(entities = [Student::class], version = 3, exportSchema = true)
abstract class StudentDatabase: RoomDatabase() {

在之前的博客中 , exportSchema 参数都设置为了 false , 没有导出 Schema 文件 ;


此外 , 还要在 build.gradle 构建脚本中 配置 Schema 文件的生成位置 , 在 " android / defaultConfig / javaCompileOptions / annotationProcessorOptions " 层级中的 arguments 中 , 配置 "room.schemaLocation": "$projectDir/schemas".toString() 参数 ;

完整的配置层级如下 :

android {namespace 'kim.hsl.rvl'compileSdk 32defaultConfig {applicationId "kim.hsl.rvl"minSdk 21targetSdk 32javaCompileOptions {annotationProcessorOptions {// 指定 Room Migration 升级数据库导出的 Schema 文件位置arguments = ["room.schemaLocation": "$projectDir/schemas".toString()]}}}
}

projectDir 是 Module 模块的根目录 , 生成的 schemas 目录 , 与 src , build , build.gradle 是一个级别的文件 ;





三、生成 Schema 文件过程



1、数据库版本 1 - 首次运行应用


运行数据库版本 1 的应用 , 首次运行 ,

        fun inst(context: Context): StudentDatabase {if (!::instance.isInitialized) {synchronized(StudentDatabase::class) {// 创建数据库instance = Room.databaseBuilder(context.applicationContext,StudentDatabase::class.java,"student_database.db")//.addMigrations(MIGRATION_1_2)//.addMigrations(MIGRATION_2_3)//.fallbackToDestructiveMigration().allowMainThreadQueries() // Room 原则上不允许在主线程操作数据库// 如果要在主线程操作数据库需要调用该函数.build()}}return instance;}

将 Entity 实体类中 新增的字段 注释掉 ;

    /*** 性别字段* 数据库表中的列名为 sex* 数据库表中的类型为 INTEGER 文本类型*//*@ColumnInfo(name = "sex", typeAffinity = ColumnInfo.INTEGER)var sex: Int = 0*//*** degree字段* 数据库表中的列名为 sex* 数据库表中的类型为 INTEGER 文本类型*//*@ColumnInfo(name = "degree", typeAffinity = ColumnInfo.INTEGER)var degree: Int = 0*/

将数据块版本设置为 1 :

@Database(entities = [Student::class], version = 1, exportSchema = true)
abstract class StudentDatabase: RoomDatabase() {

首次运行应用 , 生成 数据库版本 1 的 Schema 文件 1.json ;

Schema 文件的生成位置是 " app/schemes/包名/1.json " 路径 ;

{"formatVersion": 1,"database": {"version": 1,"identityHash": "acca4b709e6c8b9b88d8328be36b9032","entities": [{"tableName": "student","createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `name` TEXT, `age` INTEGER NOT NULL)","fields": [{"fieldPath": "id","columnName": "id","affinity": "INTEGER","notNull": true},{"fieldPath": "name","columnName": "name","affinity": "TEXT","notNull": false},{"fieldPath": "age","columnName": "age","affinity": "INTEGER","notNull": true}],"primaryKey": {"columnNames": ["id"],"autoGenerate": true},"indices": [],"foreignKeys": []}],"views": [],"setupQueries": ["CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)","INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'acca4b709e6c8b9b88d8328be36b9032')"]}
}

在这里插入图片描述


2、数据库版本 1 升级至 数据库版本 2 - 第二次运行应用


首先 , 设置 Entity 实体类中的字段 , 在 数据库版本 1 的基础上 , 添加 sex 字段 ;

    /*** 性别字段* 数据库表中的列名为 sex* 数据库表中的类型为 INTEGER 文本类型*/@ColumnInfo(name = "sex", typeAffinity = ColumnInfo.INTEGER)var sex: Int = 0

然后 , 定义 数据库 版本 1 升级为 数据库 版本 2 的 Migration 迁移类 ,

        /*** 数据库版本 1 升级到 版本 2 的迁移类实例对象*/val MIGRATION_1_2: Migration = object : Migration(1, 2) {override fun migrate(database: SupportSQLiteDatabase) {Log.i("Room_StudentDatabase", "数据库版本 1 升级到 版本 2")database.execSQL("alter table student add column sex integer not null default 1")}}

再后 , 调用 RoomDatabase.Builder#addMigrations 添加上述定义的 Migration 迁移类 ;

        fun inst(context: Context): StudentDatabase {if (!::instance.isInitialized) {synchronized(StudentDatabase::class) {// 创建数据库instance = Room.databaseBuilder(context.applicationContext,StudentDatabase::class.java,"student_database.db").addMigrations(MIGRATION_1_2)//.addMigrations(MIGRATION_2_3)//.fallbackToDestructiveMigration().allowMainThreadQueries() // Room 原则上不允许在主线程操作数据库// 如果要在主线程操作数据库需要调用该函数.build()}}return instance;}

最后 , 修改数据库版本 为 2 ,

@Database(entities = [Student::class], version = 2, exportSchema = true)
abstract class StudentDatabase: RoomDatabase() {

生成的 数据库 版本 1 升级到 数据库 版本 2 的 Schema 文件如下 :

{"formatVersion": 1,"database": {"version": 2,"identityHash": "84fb235f8062b0a6b0c8d1a6d1035c4f","entities": [{"tableName": "student","createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `name` TEXT, `age` INTEGER NOT NULL, `sex` INTEGER NOT NULL)","fields": [{"fieldPath": "id","columnName": "id","affinity": "INTEGER","notNull": true},{"fieldPath": "name","columnName": "name","affinity": "TEXT","notNull": false},{"fieldPath": "age","columnName": "age","affinity": "INTEGER","notNull": true},{"fieldPath": "sex","columnName": "sex","affinity": "INTEGER","notNull": true}],"primaryKey": {"columnNames": ["id"],"autoGenerate": true},"indices": [],"foreignKeys": []}],"views": [],"setupQueries": ["CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)","INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, '84fb235f8062b0a6b0c8d1a6d1035c4f')"]}
}

在这里插入图片描述


3、数据库版本 2 升级至 数据库版本 3 - 第三次运行应用


首先 , 设置 Entity 实体类中的字段 , 在 数据库版本 2 的基础上 , 添加 degree 字段 ;

    /*** 性别字段* 数据库表中的列名为 sex* 数据库表中的类型为 INTEGER 文本类型*/@ColumnInfo(name = "sex", typeAffinity = ColumnInfo.INTEGER)var sex: Int = 0/*** degree字段* 数据库表中的列名为 sex* 数据库表中的类型为 INTEGER 文本类型*/@ColumnInfo(name = "degree", typeAffinity = ColumnInfo.INTEGER)var degree: Int = 0

然后 , 定义 数据库 版本 2 升级为 数据库 版本 3 的 Migration 迁移类 ,

        /*** 数据库版本 2 升级到 版本 3 的迁移类实例对象*/val MIGRATION_2_3: Migration = object : Migration(2, 3) {override fun migrate(database: SupportSQLiteDatabase) {Log.i("Room_StudentDatabase", "数据库版本 2 升级到 版本 3")database.execSQL("alter table student add column degree integer not null default 1")}}

再后 , 调用 RoomDatabase.Builder#addMigrations 添加上述定义的 Migration 迁移类 ;

        fun inst(context: Context): StudentDatabase {if (!::instance.isInitialized) {synchronized(StudentDatabase::class) {// 创建数据库instance = Room.databaseBuilder(context.applicationContext,StudentDatabase::class.java,"student_database.db").addMigrations(MIGRATION_1_2).addMigrations(MIGRATION_2_3)//.fallbackToDestructiveMigration().allowMainThreadQueries() // Room 原则上不允许在主线程操作数据库// 如果要在主线程操作数据库需要调用该函数.build()}}return instance;}

最后 , 修改数据库版本 为 3 ,

@Database(entities = [Student::class], version = 2, exportSchema = true)
abstract class StudentDatabase: RoomDatabase() {

生成的 数据库 版本 2 升级到 数据库 版本 3 的 Schema 文件如下 :

{"formatVersion": 1,"database": {"version": 3,"identityHash": "d88859680a038f5155613d94de7888cc","entities": [{"tableName": "student","createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `name` TEXT, `age` INTEGER NOT NULL, `sex` INTEGER NOT NULL, `degree` INTEGER NOT NULL)","fields": [{"fieldPath": "id","columnName": "id","affinity": "INTEGER","notNull": true},{"fieldPath": "name","columnName": "name","affinity": "TEXT","notNull": false},{"fieldPath": "age","columnName": "age","affinity": "INTEGER","notNull": true},{"fieldPath": "sex","columnName": "sex","affinity": "INTEGER","notNull": true},{"fieldPath": "degree","columnName": "degree","affinity": "INTEGER","notNull": true}],"primaryKey": {"columnNames": ["id"],"autoGenerate": true},"indices": [],"foreignKeys": []}],"views": [],"setupQueries": ["CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)","INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'd88859680a038f5155613d94de7888cc')"]}
}

在这里插入图片描述


http://chatgpt.dhexx.cn/article/8FyJlvMe.shtml

相关文章

数据库，schema，catalog三者的涵义（简单描述）

数据库，schema，catalog三者的涵义（简单描述）

你是否经常见到schema，catalog这些单词，在数据库的背景下是什么意思呢？ 两篇参考：http://www.iteye.com/problems/9738 及 http://luckybat.iteye.com/blog/259976 taopian (高级程序员) 2009-01-07 写道 schema是对一个数据库的结…
阅读更多...
mysql中information_schema数据库

mysql中information_schema数据库

目录 1、information_schema说明 2、information_schema下的表 2.1 schemata表 2.2 tables表 2.3 columns表 2.4 statistics表 2.5、user_privileges表（用户权限表） 2.7 table_privileges表（表权限表） 2.8 column_privileges…
阅读更多...
数据库中Schema和Database有什么区别

数据库中Schema和Database有什么区别

本文源自： 数据库中Schema和Database有什么区别 - 人生似烟的日志 - 网易博客 http://blog.163.com/baibai_zheng/blog/static/51980755201022125325689/ ------------------------------------------------------------------------------------------------------…
阅读更多...
数据库的 Schema 变更实现

数据库的 Schema 变更实现

一、减少元数据变更的措施 元数据变更是数据库管理中不可避免的工作项，减少元数据变更次数可降低数据库维护和管理成本，减轻对业务的影响。这里我们可以优先考虑以下 3 点： 精细计划 在数据库设计和开发阶段，精细设计元数据结构…
阅读更多...
数据库中的 Schema 变更实现

数据库中的 Schema 变更实现

线上沙龙-技术流第 30 期营业啦 05月09日（周二）19:30 KaiwuDB - B站直播间 传统数据库操作 Schema 变更时，第一步便是锁表，需持续到 Schema 变更操作完成。这样的做法虽然实现简单，无需考虑事务并发带来的影响&#…
阅读更多...
SQL SERVER 中的Schema详解

SQL SERVER 中的Schema详解

以往 SQL Server 内的对象命名是“服务器.数据库.用户名.对象”，但新版的对象命名改为“服务器.数据库.Schema.对象”。这让你规划数据库对象命名时更有弹性。 架构是形成单个命名空间的数据库实体的集合。命名空间是一个集合，其中每个元素的名称都是唯…
阅读更多...
Schema是什么

Schema是什么

数据库中的Schema 在SQL环境下，schema就是数据库对象的集合， 所谓的数据库对象也就是常说的表，索引，视图，存储过程等。 所谓的数据库对象也就是常说的表，索引，视图，存储过程等。 所…
阅读更多...
如何理解MYSQL中schema的概念

如何理解MYSQL中schema的概念

学习ES中用到了mapping，百度说类似与MYSQL中的schema，于是对schema的概念很模糊，这里做一下笔记，进行学习。 schema 读音： /ˈskiːmə/ ，汉语意思：（计划或理论的）提要&a…
阅读更多...
MySQL的Schema是什么?

MySQL的Schema是什么?

1 Schema概念 schema在数据库中表示的是数据库对象集合，它包含了各种对像，比如：表，视图，存储过程，索引等等。 一般一个用户对应一个集合，所以为区分不同集合就需给不同集合起名。用户的schema名…
阅读更多...
【database】数据库schema概念解读

【database】数据库schema概念解读

schema概念定义 数据库中的schema有多种不同含义和实现： 数据库中的数据模型(data model)数据库中的整个数据结构(data structure)和程序(program)命名空间(namespace)是SQL的一个元素 1. Data Model 数据库schema的含义之一是数据库中表之间的结构，…
阅读更多...
SQL Server: 数据库模式SCHEMA

SQL Server: 数据库模式SCHEMA

在SQLServer等关系数据库管理系统(RDBMS)中，数据库包含各种对象。 在数据库中，模式(SCHEMA)是指数据库对象的逻辑集合。可以根据应用程序、访问权限和安全性使用模式(SCHEMA)来對对象分組。 SQL Server schemas SQL Server提供以下内置逻辑模式&#…
阅读更多...
数据库中的SCHEMA到底是什么？MySQL

数据库中的SCHEMA到底是什么？MySQL

平时在看一些数据库相关的书籍或是文档的时候总会出现这样一个词SCHEMA（模式），那这个SCHEMA到底是指什么？下面就来看看 SHCHEMA的定义 官方文档定义 Conceptually, a schema is a set of interrelated database objects, such …
阅读更多...
数据库中的Schema是什么?

数据库中的Schema是什么?

在数据库中，schema（发音 “skee-muh” 或者“skee-mah”，中文叫模式）是数据库的组织和结构，schemas 和schemata都可以作为复数形式。模式中包含了schema对象，可以是表(table)、列(column)、数据类型(data t…
阅读更多...
django数据库的字段新增和添加数据

django数据库的字段新增和添加数据

通过django给数据库添加一个新的字段 控制台输入: python manage.py makemigrations common # 让 Django 知道我们在我们的模型有一些变更控制台输入: python manage.py migrate #创建表结构给数据库添加数据 from django.http import HttpResponsefrom common.models imp…
阅读更多...
数据库添加字段

数据库添加字段

数据库添加字段 在使用数据库添加字段的时候要避免使用关键字 在SQL数据库编辑进行增删改查的时候，发现index这个字段的内容无法进行增删改查,希望大家在使用的时候就不要起那些关键字，嘿嘿，继续加油！
阅读更多...
mysql数据库表添加字段_mysql数据库怎么给表增加一个字段？

mysql数据库表添加字段_mysql数据库怎么给表增加一个字段？

mysql数据库给表增加一个字段的方法：可以使用“ALTER TABLE”语句来增加一个字段，语法格式“ALTER TABLE 表名 ADD 新字段名 数据类型 [约束条件];”，默认是在表的最后位置添加新字段。 mysql中数据表添加新字段 可以使用“ALTER TABLE”语句来实现，一个完整的字段包括字段…
阅读更多...
数据库 - 字段属性

数据库 - 字段属性

数据库 - 字段属性 主键 – 唯一键和自增长 主键 增加主键 大体分为三种增加主键的方式： 方案一： 高清图： 方案二：有多个字段作为主键可以是复合主键。 方案三： 主键约束 创建约束的目的就是保证数据的完整性和…
阅读更多...
线上数据库增加字段导致服务请求超时总结

线上数据库增加字段导致服务请求超时总结

2019独角兽企业重金招聘Python工程师标准>>> 今天的一个需求上线需要在数据库的某个表中增加一个字段。这个数据库是服务中一个业务量比较少的数据库，与主要业务的数据库是隔离的。执行增加操作后生效比较慢，没有关注，过了一段时间…
阅读更多...
mysql添加字段语句_mysql增加字段 mysql数据库更新字段语句

mysql添加字段语句_mysql增加字段 mysql数据库更新字段语句

myesl是一个关系型数据库管理系统，也是目前最流行的管理系统之一，目前网页设计方面对一个系统的使用频率是比较高的，因此想要学会网页设计，那么有关myesl的基础知识以及应用就一定要掌握。而今天我们就来看一看myesl增加字段是如何…
阅读更多...
Linux 配置 DNS服务（亲测实操），手把手教你看着一篇就够了

Linux 配置 DNS服务（亲测实操），手把手教你看着一篇就够了

Linux 配置 DNS服务（亲测实操），手把手教你看着一篇就够了 DNS 简介DNS 工作过程DNS 配置文件DNS 服务搭建1）基本服务器搭建2）主从DNS服务器搭建3）缓存DNS服务器搭建4）智能DNS（分离解…
阅读更多...
推荐文章

Copyright @ 2022~2023