Turso Quickstart (Android)

You will need an existing database to continue. If you don’t have one, create one.

Get the database URL:

turso db show --url <database-name>

Get the database authentication token:

turso db tokens create <database-name>

Assign credentials to the environment variables inside .env.

TURSO_DATABASE_URL=
TURSO_AUTH_TOKEN=

Add libsql as a implementation dependency in Gradle:

dependencies {
    implementation("tech.turso.libsql:libsql:0.1.0")
}

You must first create a Database object and then open a Connection to it:

import tech.turso.libsql.Libsql

val db = Libsql.open(
    path = "./local.db",
    url = "TURSO_DATABASE_URL",
    authToken = "TURSO_AUTH_TOKEN",
)

val conn = db.connect()

import tech.turso.libsql.Libsql

val db = Libsql.open(path = "./local.db")
val conn = db.connect()

import tech.turso.libsql.Libsql

val db = Libsql.open(
    url = "TURSO_DATABASE_URL",
    authToken = "TURSO_AUTH_TOKEN",
)

val conn = db.connect()

You can execute a SQL query against your existing database by calling execute():

db.connect().use {
    it.execute("INSERT INTO users (id) VALUES (1)")
}

If you need to use placeholders for values, you can do that:

When using embedded replicas you should call sync() on the database type to sync your local database with the primary database, unless you are using syncInterval (though there is no issue with calling sync with syncInterval enabled):

db.sync()