Kotlin/Native에서 SQLDelight 시작하기

Kotlin/Native 메모리 관리자(Memory Manager)

SQLDelight 2.0부터 SQLDelight Native 드라이버는 Kotlin/Native의 새로운 메모리 관리자(new memory manager)만 지원합니다.

먼저 프로젝트에 Gradle 플러그인을 적용하고.

Kotlin

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

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

Groovy

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

repositories {
  google()
  mavenCentral()
}

sqldelight {
  databases {
    register("Database") { // 이는 생성될 데이터베이스 클래스의 이름이 됩니다.
      packageName = "com.example"
    }
  }
}

문을 `src/main/sqldelight` 아래의 `.sq` 파일에 작성하세요.
로 `.sq` 파일의 첫 번째 문은 테이블을 생성하지만, 인덱스를 생성하거나 기본 콘텐츠를 설정할 수도 있습니다.

ql title="src/main/sqldelight/com/example/sqldelight/hockey/data/Player.sq"
TE TABLE hockeyPlayer (
ayer_number INTEGER PRIMARY KEY NOT NULL,
ll_name TEXT NOT NULL


TE INDEX hockeyPlayer_full_name ON hockeyPlayer(full_name);

RT INTO hockeyPlayer (player_number, full_name)
ES (15, 'Ryan Getzlaf');

문들을 바탕으로 SQLDelight는 데이터베이스를 생성하고 SQL 문을 실행하는 데 사용할 수 있는 연관된 `Schema` 객체를 포함한 `Database` 클래스를 생성합니다. `Database` 클래스는 `generateSqlDelightInterface` Gradle 태스크에 의해 생성되며, 이 태스크는 `.sq` 파일을 편집할 때 SQLDelight IDE 플러그인에 의해 자동으로 실행되거나 일반적인 Gradle 빌드의 일부로 실행됩니다.

 생성된 데이터베이스를 사용하려면 프로젝트에 SQLDelight Native 드라이버 의존성을 추가해야 합니다.

"Kotlin"

kotlin {
  // 또는 iosMain, windowsMain 등
  sourceSets.nativeMain.dependencies {
    implementation("app.cash.sqldelight:native-driver:2.1.0")
  }
}
```

Groovy

kotlin {
  // 또는 iosMain, windowsMain 등
  sourceSets.nativeMain.dependencies {
    implementation "app.cash.sqldelight:native-driver:2.1.0"
  }
}

드라이버 인스턴스는 아래와 같이 생성할 수 있으며, 생성된 Schema 객체에 대한 참조가 필요합니다.

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

타입 세이프(Typesafe) 쿼리 정의하기

SQLDelight는 .sq 파일에 레이블(labeled)이 지정된 모든 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 커넥션 풀(Reader Connection Pools)

디스크 데이터베이스는 (선택적으로) 여러 개의 reader 커넥션을 가질 수 있습니다. reader 풀을 구성하려면 NativeSqliteDriver의 다양한 생성자에 maxReaderConnections 파라미터를 전달하세요:

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

Reader 커넥션은 트랜잭션 외부에서 쿼리를 실행할 때만 사용됩니다. 모든 쓰기 호출 및 트랜잭션 내의 모든 작업은 트랜잭션 전용 단일 커넥션을 사용합니다.