SQLiteOpenHelper を使って Android アプリのデータベースを安全にアップグレードする方法

2024-04-02

Android アプリにおけるデータベースバージョンアップと新しいテーブルの追加

データベースバージョン

SQLite データベースにはバージョン番号が設定できます。アプリ起動時に、データベースファイルのバージョンとアプリが想定するバージョンを比較し、必要に応じてデータベースのアップグレード処理を実行します。

データベースバージョンアップの手順

データベースバージョンを上げる: onCreate() または onUpgrade() メソッド内で、データベースファイルのバージョン番号を更新します。
アップグレード処理を実装する: onUpgrade() メソッド内で、古いバージョンのデータベースから新しいバージョンのデータベースへの移行処理を実装します。
- テーブルの追加、削除、変更
- データの移行
新しいテーブルを追加する: onCreate() または onUpgrade() メソッド内で、新しいテーブルを作成する SQL クエリを実行します。

データベースバージョンアップのサンプルコード

public class MyOpenHelper extends SQLiteOpenHelper {

    public static final int DATABASE_VERSION = 2;

    public MyOpenHelper(Context context) {
        super(context, "mydb", null, DATABASE_VERSION);
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        // 初期化処理
        db.execSQL("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)");
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        if (oldVersion < 2) {
            // バージョン 1 から 2 へのアップグレード処理
            db.execSQL("ALTER TABLE users ADD COLUMN age INTEGER");
        }
    }
}

注意点

データベースバージョンアップ処理は、ユーザーのデータ損失を防ぐために慎重に行う必要があります。
アプリのバージョンアップ前に、必ずバックアップを取るようにしてください。
テスト環境でデータベースバージョンアップ処理を十分に検証してから、本番環境に適用してください。

上記は基本的な手順であり、複雑なデータベーススキーマ変更の場合は、より詳細な処理が必要になる場合があります。

必要に応じて、サードパーティライブラリなどを活用するのも有効です。

public class MyOpenHelper extends SQLiteOpenHelper {

    public static final int DATABASE_VERSION = 2;

    public MyOpenHelper(Context context) {
        super(context, "mydb", null, DATABASE_VERSION);
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        // 初期化処理
        db.execSQL("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)");
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        if (oldVersion < 2) {
            // バージョン 1 から 2 へのアップグレード処理
            // テーブル users に age 列を追加
            db.execSQL("ALTER TABLE users ADD COLUMN age INTEGER");
        }

        if (oldVersion < 3) {
            // バージョン 2 から 3 へのアップグレード処理
            // 新しいテーブル addresses を作成
            db.execSQL("CREATE TABLE addresses (id INTEGER PRIMARY KEY, user_id INTEGER, address TEXT)");
        }
    }
}