Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 478 Commits
.devcontainer		.devcontainer
.github		.github
.husky		.husky
.vscode		.vscode
examples		examples
scripts		scripts
src		src
test		test
.env.example		.env.example
.gitattributes		.gitattributes
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
jest.config.js		jest.config.js
package-lock.json		package-lock.json
package.json		package.json
tsconfig.build.json		tsconfig.build.json
tsconfig.json		tsconfig.json
webpack.config.js		webpack.config.js

Repository files navigation

@sqlitecloud/drivers

Install

npm install @sqlitecloud/drivers

React Native / Expo Install

You also have to install Peer Dependencies

npm install @sqlitecloud/drivers react-native-tcp-socket react-native-quick-base64

React Native run iOS

cd ios&& pod install&&cd ..&& npm run ios

React Native run Android (without ./ in Windows)

cd android&& ./gradlew clean build&&cd ..&& npm run android

Expo run iOS

npx expo prebuild&& npx expo run:ios

Expo run Android

npx expo prebuild&& npx expo run:android

Usage

import{Database}from'@sqlitecloud/drivers'letdatabase=newDatabase('sqlitecloud://user:password@xxx.sqlite.cloud:8860/chinook.sqlite')// or use sqlitecloud://xxx.sqlite.cloud:8860?apikey=xxxxxxxletname='Breaking The Rules'letresults=awaitdatabase.sql('SELECT * FROM tracks WHERE name = ?',name)// => returns [{ AlbumId: 1, Name: 'Breaking The Rules', Composer: 'Angus Young... }]

UseDatabase.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 establishedsqlite3 API, with the primary distinction being that our driver connects to SQLiteCloud databases. This allows you to migrate yourSQLite 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.

Publish / Subscribe (Pub/Sub)

import{Database}from'@sqlitecloud/drivers'import{PubSub,PUBSUB_ENTITY_TYPE}from'@sqlitecloud/drivers/lib/drivers/pubsub'letdatabase=newDatabase('sqlitecloud://user:password@xxx.sqlite.cloud:8860/chinook.sqlite')// or use sqlitecloud://xxx.sqlite.cloud:8860?apikey=xxxxxxxconstpubSub:PubSub=awaitdatabase.getPubSub()awaitpubSub.listen(PUBSUB_ENTITY_TYPE.TABLE,'albums',(error,results,data)=>{if(results){// Changes on albums table will be received here as JSON objectconsole.log('Received message:',results)}})awaitdatabase.sql("INSERT INTO albums (Title, ArtistId) values ('Brand new song', 1)")// Stop listening changes on the tableawaitpubSub.unlisten(PUBSUB_ENTITY_TYPE.TABLE,'albums')

Pub/Sub is a messaging pattern that allows multiple applications to communicate with each other asynchronously. In the context of SQLiteCloud, Pub/Sub can be used to provide real-time updates and notifications to subscribed applications whenever data changes in the database or it can be used to send payloads (messages) to anyone subscribed to a channel.

Pub/Sub Documentation:https://docs.sqlitecloud.io/docs/pub-sub