멀티플랫폼에서 SQLite 시작하기

먼저 프로젝트에 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 { // 이는 생성될 데이터베이스 클래스의 이름이 됩니다.
      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 클래스는 .sq 파일을 편집할 때 SQLDelight IDE 플러그인에 의해 자동으로 실행되고, 일반 Gradle 빌드의 일부로도 실행되는 generateSqlDelightInterface Gradle 태스크에 의해 생성됩니다.

생성된 데이터베이스를 코드에서 사용하려면 프로젝트에 SQLDelight 드라이버 의존성을 추가해야 합니다. 각 타겟 플랫폼에는 고유한 드라이버 구현이 있습니다.

Kotlin

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

  // or iosMain, windowsMain, etc.
  sourceSets.nativeMain.dependencies {
    implementation("app.cash.sqldelight:native-driver:2.1.0")
  }

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

Groovy

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

  // or iosMain, windowsMain, etc.
  sourceSets.nativeMain.dependencies {
    implementation "app.cash.sqldelight:native-driver:2.1.0"
  }

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

드라이버 인스턴스 생성

SqlDriver 인스턴스를 얻기 위한 공통 팩토리 클래스 또는 메서드를 생성하세요.

import com.example.Database

expect class DriverFactory {
  fun createDriver(): SqlDriver
}

fun createDatabase(driverFactory: DriverFactory): Database {
  val driver = driverFactory.createDriver()
  val database = Database(driver)

  // Do more work with the database (see below).
}

그런 다음 이를 각 타겟 플랫폼별로 구현합니다:

src/androidMain/kotlin

actual class DriverFactory(private val context: Context) {
  actual fun createDriver(): SqlDriver {
    return AndroidSqliteDriver(Database.Schema, context, "test.db")
  }
}

src/nativeMain/kotlin

actual class DriverFactory {
  actual fun createDriver(): SqlDriver {
    return NativeSqliteDriver(Database.Schema, "test.db")
  }
}

src/jvmMain/kotlin

actual class DriverFactory {
  actual fun createDriver(): SqlDriver {
    val driver: SqlDriver = JdbcSqliteDriver("jdbc:sqlite:test.db", Properties(), Database.Schema)
    return driver
  }
}

Kotlin/JS에서 사용하려면 여기서 확인하세요.

타입 안전 쿼리 정의

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

이것으로 끝입니다! 사이드바의 다른 페이지에서 다른 기능들을 확인하십시오.