JS SDK Introduction

npm package Build Status Downloads Issues codecov


npm install @sqlitecloud/drivers


import { Database } from '@sqlitecloud/drivers'

let database = new Database('sqlitecloud://user:password@xxx.sqlite.cloud:8860/chinook.db')

let name = 'Breaking The Rules'

let results = await database.sql`SELECT * FROM tracks WHERE name = ${name}`
// => returns [{ AlbumId: 1, Name: 'Breaking The Rules', Composer: 'Angus Young... }]

Use Database.sql to execute prepared statements or plain SQL queries asynchronously. This method returns an array of rows for SELECT queries and supports the standard syntax for UPDATE, INSERT, and DELETE.

We aim for full compatibility with the established sqlite3 API, with the primary distinction being that our driver connects to SQLiteCloud databases. This allows you to migrate your SQLite to the cloud while continuing to use your existing codebase.

The package is developed entirely in TypeScript and is fully compatible with JavaScript. It doesn’t require any native libraries. This makes it a straightforward and effective tool for managing cloud-based databases in a familiar SQLite environment.


How do I deploy SQLite in the cloud?

How do I connect SQLite cloud with Javascript?

How can I contribute or suggest features?