多平台設定與 Web Worker 驅動器

首先在您的專案中應用 Gradle 外掛。

Kotlin

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

repositories {
  google()
  mavenCentral()
}

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

Groovy

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

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    Database { // This will be the name of the generated database class.
      packageName = "com.example"
    }
  }
}

您可以在 src/main/sqldelight 目錄下的 .sq 檔案中撰寫您的 SQL 語句。通常 .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 將會生成一個 Database 類別，附帶一個相關的 Schema 物件，可用於建立您的資料庫並在其上執行語句。這個 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:sqljs-driver:2.1.0"
    implementation npm("sql.js", "1.6.2")
    implementation devNpm("copy-webpack-plugin", "9.1.0")
  }
}

建立驅動器

首先，在您的通用程式碼中設定一個建立驅動器的方式。這可以使用 expect/actual 來完成，或者簡單地使用一個通用介面及該介面的平台特定實作。

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

SqlSchema 介面包含一個泛型 QueryResult 類型參數，用於區分透過將 generateAsync 配置選項設定為 true 而產生的結構描述 (schema) 程式碼。有些驅動器在建立或遷移結構描述時依賴同步行為，因此若要使用非同步結構描述，您可以使用 synchronous() 擴充方法來使其適應同步驅動器使用。

src/jsMain/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() }
}

src/jvmMain/kotlin

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

src/androidMain/kotlin

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

src/nativeMain/kotlin

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