Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.turso.tech/llms.txt

Use this file to discover all available pages before exploring further.

In this PHP quickstart we will learn how to:
  • Install libSQL with Composer
  • Retrieve database credentials
  • Connect to a Turso database
  • Execute a query using SQL
  • Sync changes to local database (optional)
1

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.
2

Install

Install the package to your project using composer:
composer require turso/libsql
3

Connect

Now connect to your local or remote database using the libSQL connector:
use Libsql\Database;

$db = new Database(
    path: 'test.db',
    url: getenv('TURSO_URL'),
    authToken: getenv('TURSO_AUTH_TOKEN')
    syncInterval: 100 // Sync every second
);
$conn = $db->connect();

use Libsql\Database;

$db = new Database(path: "database.db");
Or just:
use Libsql\Database;

$db = new Database("database.db");

use Libsql\Database;

$db = new Database(path: "database.db");
Or just:
use Libsql\Database;

$db = new Database("database.db");

use Libsql\Database;

$db = new Database(
    url: getenv('TURSO_URL'),
    authToken: getenv('TURSO_AUTH_TOKEN'),
)
4

Execute

You can execute SQL queries against your existing database as follows:
$createUsers = "
  CREATE TABLE IF NOT EXISTS users (
      id INTEGER PRIMARY KEY AUTOINCREMENT,
      name TEXT,
      age INTEGER
  );
  INSERT INTO users (name, age) VALUES ('Prof. Ir. Onno Widodo Purbo, M.Eng., Ph.D', 61);
  INSERT INTO users (name, age) VALUES ('Jim Geovedi', 41);
  INSERT INTO users (name, age) VALUES ('Nasirun', 59);
";

$db->executeBatch($createUsers);
$db->query("SELECT * FROM users")->fetchArray();
If you need to use placeholders for values, you can do that:
$db->query("SELECT * FROM users WHERE id = ?", [1])->fetchArray();
5

Sync (Embedded Replicas only)

When using embedded replicas you should call sync() on the database type to sync your local database with the primary database:
<?php

$db->sync();