Web Worker Driverを使用したマルチプラットフォームのセットアップ

まず、プロジェクトに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ビルドの一部としても実行されます。

kotlin {
  // ターゲットとするプラットフォームに応じて、必要なドライバーが変わります：

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

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

  sourceSets.jvmMain.dependencies {
    implementation "app.cash.sqldelight:sqlite-driver:2.1.0"
  }

  sourceSets.jsMain.dependencies {
    implementation "app.cash.sqldelight:web-worker-driver:2.1.0"
    implementation npm("sql.js", "1.6.2")
    implementation devNpm("copy-webpack-plugin", "9.1.0")
  }
}

ドライバーの作成

まず、共通コード（common code）内でドライバーを作成する方法を設定します。これは expect/actual を使用するか、あるいは共通インターフェースとそのインターフェースのプラットフォーム固有の実装を用意することで行えます。

expect suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver

SqlSchema インターフェースには QueryResult ジェネリック型引数が含まれており、これは generateAsync 設定オプションを true に設定して生成されたスキーマコードを区別するために使用されます。 一部のドライバーはスキーマの作成や移行時に同期的な動作に依存するため、非同期スキーマを使用する場合は synchronous() 拡張メソッドを使用して、同期ドライバーで使用できるように適合させることができます。

src/jsMain/kotlinsrc/jvmMain/kotlinsrc/androidMain/kotlinsrc/nativeMain/kotlin

actual suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver {
  return WebWorkerDriver(
    Worker(
      js("""new URL("@cashapp/sqldelight-sqljs-worker/sqljs.worker.js", import.meta.url)""")
    )
  ).also { schema.create(it).await() }
}

actual suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver {
  return JdbcSqliteDriver(JdbcSqliteDriver.IN_MEMORY)
    .also { schema.create(it).await() }
}

actual suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver {
  return AndroidSqliteDriver(schema.synchronous(), context, "test.db")
}

actual suspend fun provideDbDriver(
  schema: SqlSchema<QueryResult.AsyncValue<Unit>>
): SqlDriver {
  return NativeSqliteDriver(schema.synchronous(), "test.db")
}