Skip to content

Getting Started on Android

First apply the gradle plugin in your project's top-level build.gradle.

buildscript {
  repositories {
  dependencies {
    classpath 'com.squareup.sqldelight:gradle-plugin:1.5.3'

Then apply the gradle plugin in your app or module's build.gradle.

apply plugin: 'com.squareup.sqldelight'

Put your SQL statements in a .sq file under src/main/sqldelight. Typically the first statement in the SQL file creates a table.

-- src/main/sqldelight/com/example/sqldelight/hockey/data/Player.sq

CREATE TABLE hockeyPlayer (
  player_number INTEGER 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');

From this SQLDelight will generate a Database Kotlin class with an associated Schema object that can be used to create your database and run your statements on it. Doing this also requires a driver, which SQLDelight provides implementations of:

dependencies {
  implementation "com.squareup.sqldelight:android-driver:1.5.3"
val driver: SqlDriver = AndroidSqliteDriver(Database.Schema, context, "test.db")

It's recommended to switch Android Studio to use the "Project" view instead of the "Android" view of your files, in order to find and edit SQLDelight files.

SQL statements inside a .sq file can be labeled to have a typesafe function generated for them available at runtime.

FROM hockeyPlayer;

INSERT INTO hockeyPlayer(player_number, full_name)
VALUES (?, ?);

INSERT INTO hockeyPlayer(player_number, full_name)

Files with labeled statements in them will have a queries file generated from them that matches the .sq file name - putting the above sql into Player.sq generates PlayerQueries.kt. To get a reference to PlayerQueries you need to wrap the driver we made above:

// In reality the database and driver above should be created a single time
// and passed around using your favourite dependency injection/service
// locator/singleton pattern.
val database = Database(driver)

val playerQueries: PlayerQueries = database.playerQueries

// Prints [HockeyPlayer(15, "Ryan Getzlaf")]

playerQueries.insert(player_number = 10, full_name = "Corey Perry")
// Prints [HockeyPlayer(15, "Ryan Getzlaf"), HockeyPlayer(10, "Corey Perry")]

val player = HockeyPlayer(10, "Ronald McDonald")

And that's it! Check out the other pages on the sidebar for other functionality.