Security News
pnpm 10.0.0 Blocks Lifecycle Scripts by Default
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
electric-sql
Advanced tools
ElectricSQL TypeScript client for developing local-first SQL apps. Supports JavaScript based mobile, web and edge applications.
ElectricSQL is a local-first SQL system. It provides active-active cloud sync for embedded SQLite databases and a reactive programming model to bind components to live database queries.
The ElectricSQL Typescript Client is the main ElectricSQL client library for developing node, web and JavaScript-based mobile applications. It's designed to work with any SQLite driver or bindings, with convienience functions to integrate with the most popular ones, including the primary drivers for Expo, React Native, SQL.js and Node.js.
See the:
Using yarn:
yarn add electric-sql
Or using npm:
npm install --save electric-sql
Instantiate and use your SQLite driver as normal and call electrify
when opening a new database connection. For example using react-native-sqlite-storage
:
import { electrify } from 'electric-sql/react-native'
// Import your SQLite driver
import SQLite from 'react-native-sqlite-storage'
SQLite.enablePromise(true)
// Import your app config and migrations
import config from '.electric/@config'
// Open an SQLite database connection
const original = await SQLite.openDatabase('example.db')
// ⚡ Electrify it
const db = electrify(original, config)
// Use as normal, e.g.:
db.transaction((tx) => tx.executeSql('SELECT 1'))
Electric uses SQL.js in the browser with absurd-sql for persistence. This runs in a web worker (which we also use to keep background replication off the main thread). As a result, the electrified db client provides an asynchronous version of a subset of the SQL.js driver interface.
First create a worker.js
file that imports and starts an ElectricWorker
process:
import { ElectricWorker } from 'electric-sql/browser'
ElectricWorker.start(self)
Then, in your main application:
import { initElectricSqlJs } from 'electric-sql/browser'
// Import your app config and migrations
import config from '.electric/@config'
// Start the background worker
const url = new URL('./worker.js', import.meta.url)
const worker = new Worker(url, { type: 'module' })
// Electrify the SQL.js / absurd-sql machinery
const SQL = await initElectricSqlJs(worker, {
locateFile: (file) => `/${file}`,
})
// Open a named database connection
const db = await SQL.openDatabase('example.db', config)
This gives you persistent, local-first SQL with active-active replication in your web browser 🤯. Use the db client as normal, with the proviso that the methods are now async (they return promises rather than direct values).
See the Quickstart guide for more information.
Once electrified, you can bind live database queries to your reactive components, so they automatically update when data changes or comes in over the replication stream. For example:
import React from 'react'
import { Pressable, Text, View } from 'react-native'
import { useElectric, useElectricQuery } from 'electric-sql/react'
export const LiveComponent = () => {
const db = useElectric()
const { results } = useElectricQuery('SELECT value FROM items')
const addItem = () => {
sql.execute('INSERT INTO items VALUES(?)', [crypto.randomUUID()])
}
return (
<View>
{results.map((item, index) => (
<Text key={index}>Item: {item.value}</Text>
))}
<Pressable onPress={addItem}>
<Text>Add</Text>
</Pressable>
</View>
)
}
See the Reactivity guide for more information.
Please raise any bugs, issues and feature requests on GitHub Issues.
See the Community Guidelines including the Guide to Contributing and Contributor License Agreement.
We have an open community Discord. If you’re interested in the project, please come and say hello and let us know if you have any questions or need any help or support getting things running.
FAQs
ElectricSQL TypeScript client for developing local-first SQL apps. Supports JavaScript based mobile, web and edge applications.
The npm package electric-sql receives a total of 156 weekly downloads. As such, electric-sql popularity was classified as not popular.
We found that electric-sql demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.