iOS SQLite 数据库迁移

1、概述

随着应用的不断升级,原有的数据库结构不再适应新的功能,这时候,就需要对SQLite数据库的结构进行迁移升级。推荐使用 FMDBMigrationManager

2、FMDBMigrationManager

FMDBMigrationManager对数据的操作是基于FMDB的,所以必须在项目中引入FMDB

Podfile 文件:

use_frameworks!
platform :ios, '8.0'
target ‘AppName’ do

# SQLite 本地数据库
pod 'FMDB'

# SQLite 本地数据库版本升级管理

pod 'FMDBMigrationManager'

2.1、实现细节

FMDBMigrationManager对版本的管理通过在数据库中引入一个schema_migrations表。表的每一个行记录着一个应用的版本号。

CREATE TABLE schema_migrations(
    version INTEGER UNIQUE NOT NULL
);

2.2、版本号的命名

推荐使用时间戳的方式来命名,可使用下面的语法来生成。

ruby -e "puts Time.now.strftime('%Y%m%d%H%M%S%3N').to_i"

2.3、迁移文件的命名

通过(版本号_描述文字).sql 的方式来命名。描述文字是可选的的。

2.4、生成sql文件

可通过下面的命令生成

touch "`ruby -e "puts Time.now.strftime('%Y%m%d%H%M%S%3N').to_i"`"_CreateMyAwesomeTable.sql

2.4、 计算未应用的迁移

使用下面的算法来指定给数据的迁移

  1. 计算database的origin version
  2. 对于给定bundle的的migrations(迁移)创建一个包含version的数组
  3. 创建一个包含所以应用到database的迁移版本(SELECT version FROM schema_migrations)
  4. 从列表中移除所以比origin version小的migration
  5. 比较迁移数组的差异。剩余的集合是(pending migrations)待迁移的集合。
  6. 对pending migrations进行升序排列,并对其从旧到新的应用进行数据库的迁移。

3、用法

3.1、通过.sql文件进行迁移升级

  • 创建第一个.sql 文件
$ touch "`ruby -e "puts Time.now.strftime('%Y%m%d%H%M%S%3N').to_i"`"_CreateMyUserTable.sql

  • 编辑.sql文件 输入下面的命令
// 创建User表
CREATE TABLE User(
id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
name TEXT
);
  • 创建第二个.sql 文件
$touch "`ruby -e "puts Time.now.strftime('%Y%m%d%H%M%S%3N').to_i"`"_CreateMyGroupTable.sql

  • 编辑.sql文件 输入下面的命令
// 创建Grouping表,并修改User表添加一个TEXT类型的email字段
CREATE TABLE Grouping(
id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
name TEXT
);

ALTER TABLE User ADD email TEXT;

  • 创建第三个.sql 文件
$ touch "`ruby -e "puts Time.now.strftime('%Y%m%d%H%M%S%3N').to_i"`"_AlterMyGroupTable.sql


  • 编辑.sql文件 输入下面的命令
// 修改Grouping表添加一个TEXT类型的remark字段
ALTER TABLE Grouping ADD remark TEXT;

  • 具体用法代码
// 创建.sql文件的方式进行迁移, 自动扫描包内以.sql结尾的文件
    func migrate1() {
        //db路径
        let path = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)
        let filePath = path.first?.appendingPathComponent("User.db").path
        
        // 迁移管理器
        let manager = FMDBMigrationManager(databaseAtPath: filePath, migrationsBundle: Bundle.main)!
       
                // 判断是否有迁移表,如果没有 则创建 schema_migrations表 里面记录着创建的版本信息
        if !manager.hasMigrationsTable  {
            do {
                try  manager.createMigrationsTable()
            }catch{
                print("createMigrationsTable- error: \(error)")
            }
        }
        // 迁移数据库
        do {
            try  manager.migrateDatabase(toVersion: UINT64_MAX, progress: nil)
        }catch{
            print("migrateDatabase - error: \(error)")
        }
        
        // 迁移表 存储版本号信息
        print("Has `schema_migrations` table?: ", manager.hasMigrationsTable ? "true" : "false")
        // 原始版本
        print("Origin Version: ", manager.originVersion)
        // 当前版本
        print("Current version: ", manager.currentVersion)
        // 所有的版本
        print("All migrations: ", manager.migrations)
        // 这次更新应用的版本
        print("Applied versions: ", manager.appliedVersions)
        // 要更新的版本
        print("Pending versions: ", manager.pendingVersions)
        
        /**
         Has `schema_migrations` table?:  true
        Origin Version:  0
        Current version:  20170315173002899
        All migrations:  [, , , ]
        Applied versions:  [0, 20170315171810827, 20170315172759084, 20170315173002899]
        Pending versions:  []
 **/
    }

3.2、通过自定义对象进行迁移升级

定义对象FSMigration 遵循FMDBMigrating协议

class FSMigration: NSObject, FMDBMigrating {

    // 只读 计算属性
    var name: String! {
        return myName
    }
    var version: UInt64 {
        return myVersion
    }
    private var updateArray = [String]() // 更新数组
    
    private var myName:String!  // 名字
    private var myVersion: UInt64 = 0 // 版本
    
    override init() {
        super.init()
    }
    convenience init(name:String, version: UInt64, updateArray:[String]) {
        self.init()
        myName = name
        myVersion = version
        self.updateArray = updateArray
        
        print("self.updateArray: \(self.updateArray)")

    }
    func migrateDatabase(_ database: FMDatabase!) throws {
        
        print("updateArray: \(self.updateArray)")
        for updateStr in self.updateArray {
            do {
                try database.executeUpdate(updateStr, values: nil)
            }catch {
                throw error
            }
        }
    }
    
}

  • 具体使用代码
// 数据库表迁移
    func migrate() {
        
        //db路径
        let path = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)
        let filePath = path.first?.appendingPathComponent("person.db").path
        
        // 迁移管理器
        let manager = FMDBMigrationManager(databaseAtPath: filePath, migrationsBundle: Bundle.main)!
        // 版本 1
        let migration1 = FSMigration(name: "新增User表", version: 1, updateArray: ["create table User(id integer primary key autoincrement, name text, age integer)"])
        // 版本 2
         let migration2 = FSMigration(name: "USer表新增字段email", version: 2, updateArray: ["alter table User add email text"])
        
        // 报错 不能修改
        let migration3 = FSMigration(name: "修改email类型为integer", version: 3, updateArray: ["alter table User alter column email integer"])
        // 报错 不能删除
        let migration4 = FSMigration(name: "删除email列", version: 4, updateArray: ["ALTER TABLE User DROP COLUMN email"])
        
        // 添加版本到 manager
        manager.addMigration(migration1)
        manager.addMigration(migration2)
        
        manager.addMigration(migration3)
        manager.addMigration(migration4)

        
        // 判断是否有迁移表,如果没有 则创建 schema_migrations表 里面记录着创建的版本信息
            if !manager.hasMigrationsTable  {
                do {
                    try  manager.createMigrationsTable()
                }catch{
                    print("createMigrationsTable- error: \(error)")
                }
            }
       // 迁移数据库
        do {
            try  manager.migrateDatabase(toVersion: UINT64_MAX, progress: nil)
        }catch{
            print("migrateDatabase - error: \(error)")
        }
        
        print("Has `schema_migrations` table?: ", manager.hasMigrationsTable ? "true" : "false")
        print("Origin Version: ", manager.originVersion)
        print("Current version: ", manager.currentVersion)
        print("All migrations: ", manager.migrations)
        print("Applied versions: ", manager.appliedVersions)
        print("Pending versions: ", manager.pendingVersions)
    }

4、修改SQLite数据库的限制性

SQLite supports a limited subset of ALTER TABLE. The ALTER TABLE command in SQLite allows the user to rename a table or to add a new column to an existing table. It is not possible to rename a column, remove a column, or add or remove constraints from a table.

SQLite 对 ALERT TABLE 命令受限制,SQLite 中的 ALERT TABLE 命令只能允许用户重命名表或者添加新列,不能重命名列或者删除列或者删除约束。

5、参考

  • FMDBMigrationManager
  • iOS SQLite 数据库迁移

你可能感兴趣的:(iOS SQLite 数据库迁移)