Android での SQLite のはじめかた

まず、プロジェクトにGradleプラグインを適用します。

KotlinGroovy

plugins {
  id("app.cash.sqldelight") version "2.1.0"
}

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    register("Database") {
      packageName.set("com.example")
    }
  }
}

plugins {
  id "app.cash.sqldelight" version "2.1.0"
}

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    register("Database") { // これは生成されるデータベースクラスの名前になります。
      packageName = "com.example"
    }
  }
}

Tip

SQLDelight ファイルを見つけて編集しやすくするために、Android Studio の表示を「Android」ビューではなく「Project（プロジェクト）」ビューに切り替えて使用することをお勧めします。

SQLステートメントは、src/main/sqldelight 配下の .sq ファイルに記述します。 通常、.sq ファイルの最初のステートメントでテーブルを作成しますが、インデックスの作成やデフォルトコンテンツのセットアップも可能です。

CREATE TABLE hockeyPlayer (
  player_number INTEGER PRIMARY KEY NOT NULL,
  full_name TEXT NOT NULL
);

CREATE INDEX hockeyPlayer_full_name ON hockeyPlayer(full_name);

INSERT INTO hockeyPlayer (player_number, full_name)
VALUES (15, 'Ryan Getzlaf');

これらのステートメントから、SQLDelightはデータベースの作成やステートメントの実行に使用できる、Schemaオブジェクトが関連付けられたDatabaseクラスを生成します。DatabaseクラスはgenerateSqlDelightInterface Gradleタスクによって生成されます。このタスクは、.sqファイルを編集した際にSQLDelight IDEプラグインによって自動的に実行されるほか、通常のGradleビルドの一部としても実行されます。

生成されたデータベースをコード内で使用するには、SQLDelight Android ドライバの依存関係をプロジェクトに追加する必要があります。

KotlinGroovy

dependencies {
  implementation("app.cash.sqldelight:android-driver:2.1.0")
}

dependencies {
  implementation "app.cash.sqldelight:android-driver:2.1.0"
}

ドライバのインスタンスは以下のように構築でき、生成された Schema オブジェクトへの参照が必要になります。

val driver: SqlDriver = AndroidSqliteDriver(Database.Schema, context, "test.db")

Info

AndroidSqliteDriver は、ドライバが構築されるときにスキーマを自動的に作成または移行（マイグレーション）します。必要に応じて、移行を手動で実行することも可能です。詳細は Code Migrations を参照してください。

型安全なクエリの定義

SQLDelightは、.sq ファイル内のラベル付きSQLステートメントに対して、型安全な関数を生成します。

selectAll:
SELECT *
FROM hockeyPlayer;

insert:
INSERT INTO hockeyPlayer(player_number, full_name)
VALUES (?, ?);

insertFullPlayerObject:
INSERT INTO hockeyPlayer(player_number, full_name)
VALUES ?;

ラベル付きステートメントを含む各 .sq ファイルに対して、「Queries」オブジェクトが生成されます。 例えば、上記の Player.sq ファイルに対しては、PlayerQueries オブジェクトが生成されます。 このオブジェクトを使用して生成された型安全な関数を呼び出すことで、実際のSQLステートメントを実行できます。

fun doDatabaseThings(driver: SqlDriver) {
  val database = Database(driver)
  val playerQueries: PlayerQueries = database.playerQueries

  println(playerQueries.selectAll().AsList()) 
  // [HockeyPlayer(15, "Ryan Getzlaf")]

  playerQueries.insert(player_number = 10, full_name = "Corey Perry")
  println(playerQueries.selectAll().AsList()) 
  // [HockeyPlayer(15, "Ryan Getzlaf"), HockeyPlayer(10, "Corey Perry")]

  val player = HockeyPlayer(10, "Ronald McDonald")
  playerQueries.insertFullPlayerObject(player)
}

以上です！その他の機能については、サイドバーの他のページを確認してください。

SQLite のバージョン

Android プロジェクトでは、SQLDelight Gradle プラグインがプロジェクトの minSdkVersion 設定に基づいて SQLite ダイアレクト (dialect) のバージョンを自動的に選択します。各 Android SDK レベルでサポートされている SQLite バージョンのリストについては、こちら を参照してください。