Turso Quickstart (Flutter / Dart)

This SDK is community maintained and may not be officially supported by Turso, or up to date with the latest features. Join the #libsql-dart channel on Discord for help and feedback.

In this Flutter/Dart quickstart we will learn how to:

Retrieve database credentials
Install the Flutter/Dart libSQL client
Connect to a local or remote Turso database
Execute a query using SQL
Sync changes to local database (optional)

Retrieve database credentials

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=

You will want to store these as environment variables.

Install libsql_dart

flutter pub add libsql_dart

Initialize

Now connect to your local or remote database using the LibsqlClient constructor:

Embedded Replicas

final dir = await getApplicationCacheDirectory();
final path = '${dir.path}/local.db';

final client = LibsqlClient(path)
  ..authToken = '<TOKEN>'
  ..syncUrl = '<TURSO_OR_LIBSQL_URL>'
  ..syncIntervalSeconds = 5
  ..readYourWrites = true;

Local only

final dir = await getApplicationCacheDirectory();
final path = '${dir.path}/local.db';

final client = LibsqlClient(path);

final client = LibsqlClient(":memory:");

Remote only

final client = LibsqlClient('<TURSO_OR_LIBSQL_URL>')
  ..authToken = '<TOKEN>';

Connect

await client.connect();

Execute

await client.execute("create table if not exists customers (id integer primary key, name text);");

await client.query("insert into customers(name) values ('John Doe')");

print(await client.query("select * from customers"));

await client.batch("""insert into customers (name) values ('Jane Doe'); insert into customers (name) values ('Jake Doe');""");

final statement = await client
	.prepare("select * from customers where id = ?");

await statement.query(positional: [1])

final tx = await client.transaction();

await tx
	.execute("update customers set name = 'John Noe' where id = 1");
await tx
	.execute("update customers set name = 'Jane Noe' where id = 2");
print(await tx
	.query("select * from customers where id = ?", positional: [1]));

await tx.commit();

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

final statement = await client
  .prepare("select * from customers where id = ?");

await statement.query(positional: [1])

final statement = await client
	.prepare("select * from customers where id = :id");

await statement.query(named: {"id": 1})

Sync (Embedded Replicas only)

When using embedded replicas you should call sync() on the connector to sync your local database with the primary database.

await client.sync();

Turso Cloud

SDKs

CLI

API Reference

Integrations

Turso Quickstart (Flutter / Dart)