Web Worker 드라이버를 사용한 멀티플랫폼 설정

먼저 프로젝트에 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는 데이터베이스를 생성하고 SQL 문을 실행하는 데 사용할 수 있는 연관된 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 인터페이스는 generateAsync 설정 옵션이 true로 설정되어 생성된 스키마 코드를 구분하기 위해 사용되는 제네릭 QueryResult 타입 인자를 포함합니다. 일부 드라이버는 스키마를 생성하거나 마이그레이션할 때 동기 동작(synchronous behaviours)에 의존하므로, 비동기 스키마를 사용하려면 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")
}