Turso Quickstart (TypeScript / JS)

Get started with Turso and TypeScript using the libSQL client in a few simple steps

In this JavaScript quickstart we will learn how to:

• Retrieve database credentials
• Install the JavaScript libSQL client
• Connect to a remote Turso database
• Execute a query using SQL

1. Retrieve database credentials

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

   Get database URL

   turso db show <database-name> --url
   

   Create database auth token

   turso db tokens create <database-name>
   

   You will want to store these as environment variables.
2. Install @libsql/client

   First begin by installing the @libsql/client:

   npm

   npm install @libsql/client
   
3. Initialize a new client

   Next add your database URL and auth token:

   Node.js

   import { createClient } from "@libsql/client";
   
   const client = createClient({
     url: "libsql://...",
     authToken: "...",
   });
   

   
   

   You can also connect to a local SQLite file by passing file: instead of a URL when using Node.js, learn more.

4. Execute a query using SQL

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

   await client.execute("SELECT * FROM users");
   

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

   Positional

   await client.execute({
     sql: "SELECT * FROM users WHERE id = ?",
     args: [1],
   });