Turso Quickstart (Laravel)

In this Laravel quickstart we will learn how to:

Install the Turso Laravel adapter
Configure Laravel to use Turso
Create a model and migration
Perform CRUD operations using Eloquent

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

Install the package to your Laravel project using Composer:

composer require turso/libsql-laravel

Make sure to enable FFI in your PHP configuration to use the Laravel adapter.

Configure

Choose your preferred setup and configure accordingly:

Local only

Update your config/database.php:

return [
    "default" => env("DB_CONNECTION", "libsql"),

    "connections" => [
        "libsql" => [
            "driver" => "libsql",
            "database" => database_path("database.db"),
        ],
        // ...
    ],
];

This will use a local SQLite file with the libSQL adapter.

Remote only

Update your config/database.php:

return [
    "default" => env("DB_CONNECTION", "libsql"),

    "connections" => [
        "libsql" => [
            "driver" => "libsql",
            "url" => env("TURSO_DATABASE_URL"),
            "password" => env("TURSO_AUTH_TOKEN"),
        ],
        // ...
    ],
];

Then add to your .env file:

DB_CONNECTION=libsql
TURSO_DATABASE_URL=libsql://...
TURSO_AUTH_TOKEN=...

Embedded Replicas

Update your config/database.php:

return [
    "default" => env("DB_CONNECTION", "libsql"),

    "connections" => [
        "libsql" => [
            "driver" => "libsql",
            "database" => database_path("database.db"),
            "url" => env("TURSO_DATABASE_URL"),
            "password" => env("TURSO_AUTH_TOKEN"),
            "sync_interval" => env("TURSO_SYNC_INTERVAL", 300),
        ],
        // ...
    ],
];

Then add to your .env file:

DB_CONNECTION=libsql
TURSO_DATABASE_URL=libsql://...
TURSO_AUTH_TOKEN=...
TURSO_SYNC_INTERVAL=300

The sync_interval is optional and defaults to 300 seconds (5 minutes).

Create a model and migration

Create a User model and migration:

php artisan make:model User -m

Update the migration file:

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->timestamps();
    });
}

Run migrations

Apply the migration to create the users table:

php artisan migrate

Execute CRUD operations

Now you can perform CRUD operations using Eloquent:

use App\Models\User;

$user = User::create([
    'name' => 'John Doe',
    'email' => 'john@example.com',
]);

use App\Models\User;

// Fetch all users
$allUsers = User::all();

// Find a specific user by ID
$user = User::find(1);

// Filter users
$filteredUsers = User::where('name', 'John Doe')->get();

use App\Models\User;

// Update a single record
$user = User::find(1);
$user->name = 'Jane Doe';
$user->save();

// Update multiple records
User::where('name', 'John Doe')->update(['name' => 'Jane Doe']);

use App\Models\User;

// Delete a single record
$user = User::find(1);
$user->delete();

// Delete multiple records
User::where('name', 'Jane Doe')->delete();