Kotlin/Native で SQLDelight を使い始める

Kotlin/Native メモリマネージャー

SQLDelight 2.0 以降、SQLDelight Native ドライバは Kotlin/Native の 新しいメモリマネージャー のみをサポートしています。

まず、プロジェクトに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"
    }
  }
}

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 Native ドライバの依存関係を追加する必要があります。

KotlinGroovy

kotlin {
  // または iosMain, windowsMain など
  sourceSets.nativeMain.dependencies {
    implementation("app.cash.sqldelight:native-driver:2.1.0")
  }
}

kotlin {
  // または iosMain, windowsMain など
  sourceSets.nativeMain.dependencies {
    implementation "app.cash.sqldelight:native-driver:2.1.0"
  }
}

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

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

型安全なクエリの定義

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)
}

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

読み取り接続プール (Reader Connection Pools)

ディスクデータベースでは、（オプションで）複数の読み取り接続を持つことができます。読み取りプールを構成するには、NativeSqliteDriver の各種コンストラクタに maxReaderConnections パラメータを渡します。

val driver: SqlDriver = NativeSqliteDriver(
    Database.Schema, 
    "test.db", 
    maxReaderConnections = 4
)

読み取り接続は、トランザクション外でクエリを実行する場合にのみ使用されます。すべての書き込み呼び出し、およびトランザクション内のすべての処理は、トランザクション専用の単一の接続を使用します。