diff --git a/README.md b/README.md index e8d3e20a5..c80cef47b 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ - ElectricSQL logo @@ -15,7 +15,7 @@

- PGlite - the WASM build of Postgres from ElectricSQL.
+ PGlite - the WASM build of Postgres from Electric.
Build reactive, realtime, local-first apps directly on Postgres.

diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 9c01e1a70..2f8ece018 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -80,7 +80,7 @@ export default defineConfig({ { text: 'About', link: '/docs/about' }, { text: 'Docs', link: '/docs/' }, { text: 'REPL', link: '/repl/' }, - { text: 'ElectricSQL', link: 'https://www.electric-sql.com' }, + { text: 'Electric', link: 'https://www.electric.ax' }, { text: 'GitHub', link: 'https://github.com/electric-sql/pglite', @@ -119,7 +119,7 @@ export default defineConfig({ { text: 'Multi-tab Worker', link: '/docs/multi-tab-worker' }, { text: 'REPL Component', link: '/docs/repl' }, { text: 'ORMs & Query Builders', link: '/docs/orm-support' }, - { text: 'Sync using ElectricSQL', link: '/docs/sync' }, + { text: 'Sync using Postgres Sync', link: '/docs/sync' }, { text: 'PGlite Socket', link: '/docs/pglite-socket' }, { text: 'PGlite tools', @@ -159,7 +159,7 @@ export default defineConfig({ footer: { message: 'Dual-licensed under Apache 2.0 and the PostgreSQL License', - copyright: '© ElectricSQL', + copyright: '© Electric', }, search: { provider: 'local', diff --git a/docs/docs/about.md b/docs/docs/about.md index 74f8a0b10..f96de9687 100644 --- a/docs/docs/about.md +++ b/docs/docs/about.md @@ -16,7 +16,7 @@ It can be used as an ephemeral in-memory database, or with persistence either to Unlike previous "Postgres in the browser" projects, PGlite does not use a Linux virtual machine - it is simply Postgres in WASM. -It's being developed by [ElectricSQL](https://electric-sql.com/) for our use case of embedding into applications, either locally or at the edge, allowing users to sync a subset of their server-side Postgres database. +It's being developed by [Electric](https://electric.ax/) for our use case of embedding into applications, either locally or at the edge, allowing users to sync a subset of their server-side Postgres database. However, there are many more use cases for PGlite beyond its use as an embedded application database: diff --git a/docs/docs/sync.md b/docs/docs/sync.md index d7e3aaadf..298901eea 100644 --- a/docs/docs/sync.md +++ b/docs/docs/sync.md @@ -1,6 +1,6 @@ -# Sync using ElectricSQL +# Sync using Electric -At [ElectricSQL](https://electric-sql.com/) we are building a sync engine to enable realtime partial replication from Postgres to any other datastore, be it a JavaScript framework state store in a webapp, a database at the edge, or an embedded database in the mobile application. +At [Electric](https://electric.ax/) we are building a sync engine to enable realtime partial replication from Postgres to any other datastore, be it a JavaScript framework state store in a webapp, a database at the edge, or an embedded database in the mobile application. To accompany Electric, we are developing a sync extension for PGlite that will enable you to synchronise a remote Postgres with PGlite. @@ -113,12 +113,12 @@ The `electricSync` plugin can be given some configuration options to allow custo ## syncShapeToTable API -The `syncShapeToTable` is a relatively thin wrapper around the Electric [ShapeStream API](https://next.electric-sql.com/api/clients/typescript#shapestream) designed to do the minimal required to sync a shape _into_ a table. +The `syncShapeToTable` is a relatively thin wrapper around the Electric [ShapeStream API](https://electric.ax/docs/api/clients/typescript#shapestream) designed to do the minimal required to sync a shape _into_ a table. It takes the following options as an object: - `shape: ShapeStreamOptions`
- The shape stream specification to sync, described by the Electric [ShapeStream API](https://electric-sql.com/docs/api/clients/typescript#shapestream) options, see the [ShapeStream API](https://electric-sql.com/docs/api/clients/typescript#options) for more details. + The shape stream specification to sync, described by the Electric [ShapeStream API](https://electric.ax/docs/api/clients/typescript#shapestream) options, see the [ShapeStream API](https://electric.ax/docs/api/clients/typescript#options) for more details. - `table: string`
The name of the table to sync into. @@ -169,7 +169,7 @@ The returned `shape` object from the `syncShapeToTable` call has the following m Unsubscribe from the shape. Note that this does not clear the state that has been synced into the table. - `stream: ShapeStream`
- The underlying `ShapeStream` instance, see the [ShapeStream API](https://electric-sql.com/docs/api/clients/typescript#shapestream) for more details. + The underlying `ShapeStream` instance, see the [ShapeStream API](https://electric.ax/docs/api/clients/typescript#shapestream) for more details. ## syncShapesToTables API diff --git a/docs/index.md b/docs/index.md index 4abcf146e..451e0b35d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -56,7 +56,7 @@ async function renderGitHub() { if (!countEl) { countEl = document.createElement('span') countEl.classList.add('count') - countEl.innerText = `(${toShortDecimal(initialStarCount)})`; + countEl.innerText = `( ☆ ${toShortDecimal(initialStarCount)})`; const icon = document.createElement('span') icon.classList.add('vpi-social-github') @@ -84,7 +84,7 @@ async function renderGitHub() { clearInterval(intervalId); } - countEl.innerText = `(${toShortDecimal(currentCount)})`; + countEl.innerText = `( ☆ ${toShortDecimal(currentCount)})`; }; const intervalId = setInterval(animateCount, 64); } diff --git a/packages/pglite-react/test/hooks.test.tsx b/packages/pglite-react/test/hooks.test.tsx index 6d51e0f83..75dcc0e13 100644 --- a/packages/pglite-react/test/hooks.test.tsx +++ b/packages/pglite-react/test/hooks.test.tsx @@ -412,11 +412,11 @@ function testLiveQuery(queryHook: 'useLiveQuery' | 'useLiveIncrementalQuery') { ) // Trigger an update await db.exec( - `INSERT INTO pattern_matching (statement) VALUES ('ElectricSQL + pglite = <3');`, + `INSERT INTO pattern_matching (statement) VALUES ('Electric + pglite = <3');`, ) await waitFor(() => expect(result.current?.rows[0].statement).toBe( - 'ElectricSQL + pglite = <3', + 'Electric + pglite = <3', ), ) }) diff --git a/packages/pglite-sync/README.md b/packages/pglite-sync/README.md index 5f1f0a323..f6116d9ec 100644 --- a/packages/pglite-sync/README.md +++ b/packages/pglite-sync/README.md @@ -1,6 +1,6 @@ -# PGlite ElectricSQL Sync Plugin +# PGlite Postgres Sync Plugin -A [sync plugin](https://pglite.dev/docs/sync) for [PGlite](https://pglite.dev/) using [ElectricSQL](https://electric-sql.com/). Full documentation is available at [pglite.dev/docs/sync](https://pglite.dev/docs/sync). +A [sync plugin](https://pglite.dev/docs/sync) for [PGlite](https://pglite.dev/) using [Electric](https://electric.ax/). Full documentation is available at [pglite.dev/docs/sync](https://pglite.dev/docs/sync). To install: diff --git a/packages/pglite-sync/package.json b/packages/pglite-sync/package.json index f6616982d..a7a72e7df 100644 --- a/packages/pglite-sync/package.json +++ b/packages/pglite-sync/package.json @@ -1,7 +1,7 @@ { "name": "@electric-sql/pglite-sync", "version": "0.5.5", - "description": "ElectricSQL Sync for PGlite", + "description": "Postgres Sync for PGlite", "type": "module", "private": false, "publishConfig": { diff --git a/packages/pglite-sync/src/index.ts b/packages/pglite-sync/src/index.ts index 641dae7e5..97dfe2b78 100644 --- a/packages/pglite-sync/src/index.ts +++ b/packages/pglite-sync/src/index.ts @@ -514,7 +514,7 @@ export type PGliteWithSync = PGliteInterface & { export function electricSync(options?: ElectricSyncOptions) { return { - name: 'ElectricSQL Sync', + name: 'Postgres Sync', setup: async (pg: PGliteInterface) => { const { namespaceObj, close } = await createPlugin(pg, options) return { diff --git a/packages/pglite/README.md b/packages/pglite/README.md index 2618e95d2..d3e09b44b 100644 --- a/packages/pglite/README.md +++ b/packages/pglite/README.md @@ -7,7 +7,7 @@ - ElectricSQL logo @@ -15,7 +15,7 @@

- PGlite - the WASM build of Postgres from ElectricSQL.
+ PGlite - the WASM build of Postgres from Electric.
Build reactive, realtime, local-first apps directly on Postgres.