わかりやすく解説！Android SQLiteOpenHelper onCreate() / onUpgrade() の動作タイミング

2024-04-02

Android SQLiteOpenHelper: onCreate()とonUpgrade()の動作タイミング

このクラスには、データベース作成時やバージョン変更時に呼び出されるonCreate()とonUpgrade()という重要なメソッドがあります。

それぞれのメソッドがどのようなタイミングで実行されるのか、詳細な説明とサンプルコードを交えて解説します。

onCreate()

実行タイミング:

アプリケーションが初めてデータベースを開こうとした時
データベースファイルが存在しない場合
データベースのバージョンが0の場合

概要:

onCreate()メソッドは、データベースが作成された時に最初に呼び出されます。このメソッド内で、テーブルの作成、初期データの挿入などの処理を行います。

public class MyOpenHelper extends SQLiteOpenHelper {

    public MyOpenHelper(Context context) {
        super(context, "my_database", null, 1);
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        // テーブル作成
        db.execSQL("CREATE TABLE IF NOT EXISTS my_table (id INTEGER PRIMARY KEY, name TEXT)");

        // 初期データ挿入
        db.execSQL("INSERT INTO my_table (name) VALUES (?)", new String[]{"John Doe"});
    }
}

onUpgrade()

データベースのバージョンが、前回開いた時のバージョンよりも大きい場合

onUpgrade()メソッドは、データベースのバージョンが更新された時に呼び出されます。このメソッド内で、データベーススキーマの変更処理を行います。

public class MyOpenHelper extends SQLiteOpenHelper {

    public MyOpenHelper(Context context) {
        super(context, "my_database", null, 2);
    }

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

注意点:

onUpgrade()メソッドは、データベースのバージョンが前回開いた時のバージョンよりも大きい場合にのみ実行されます。
バージョン管理は開発者自身が責任を持って行う必要があります。
バージョンアップ処理は、複雑な場合もあるので、慎重に設計する必要があります。

その他の考慮事項

onCreate()とonUpgrade()は、必ずしも順番に実行されるとは限りません。
複数のスレッドからデータベースにアクセスする場合は、同期処理が必要になります。
データベース操作は、パフォーマンスに影響を与える可能性があるため、効率的に実行する必要があります。

まとめ

SQLiteOpenHelperクラスのonCreate()とonUpgrade()メソッドは、データベースの作成・更新処理において重要な役割を果たします。それぞれのメソッドがどのようなタイミングで実行されるのかを理解し、適切な処理を実装することで、安全で効率的なデータベース操作を実現できます。

補足

上記のサンプルコードはあくまで基本的な例です。実際の開発では、より複雑な処理が必要になる場合があります。

データベース操作に関する詳細は、Android公式ドキュメントやその他の参考資料を参照してください。

public class MyOpenHelper extends SQLiteOpenHelper {

    public MyOpenHelper(Context context) {
        super(context, "my_database", null, 2);
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        // テーブル作成
        db.execSQL("CREATE TABLE IF NOT EXISTS my_table (id INTEGER PRIMARY KEY, name TEXT)");

        // 初期データ挿入
        db.execSQL("INSERT INTO my_table (name) VALUES (?)", new String[]{"John Doe"});
    }

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

MainActivity.java

public class MainActivity extends AppCompatActivity {

    private MyOpenHelper helper;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        helper = new MyOpenHelper(this);

        // データベース読み込み
        SQLiteDatabase db = helper.getReadableDatabase();

        // データ検索
        Cursor cursor = db.rawQuery("SELECT * FROM my_table", null);

        while (cursor.moveToNext()) {
            int id = cursor.getInt(0);
            String name = cursor.getString(1);

            Log.d("TAG", "id: " + id + ", name: " + name);
        }

        cursor.close();

        // データベース書き込み
        db = helper.getWritableDatabase();

        db.execSQL("INSERT INTO my_table (name) VALUES (?)", new String[]{"Jane Doe"});

        db.close();
    }
}