Skip to content
This repository has been archived by the owner on Jul 24, 2024. It is now read-only.

Commit

Permalink
deprecation notice
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmartos96 committed Jul 24, 2024
1 parent 109a371 commit 710acea
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 6 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,21 @@
Electric Dart
</h1>

#### 🛠️ WORK IN PROGRESS 🛠
#### ⚠️ DEPRECATION NOTICE ⚠

[Electric](https://electric-sql.com/) is currently in **public alpha** phase, and the Dart client is currently being developed introducing the new features from the official client as they come out.
For development updates make sure to check out the official [ElectricSQL Discord](https://discord.gg/B7kHGwDcbj) server, as well as the official [Javascript client](https://www.npmjs.com/package/electric-sql)
With the introduction of Electric Next (https://next.electric-sql.com/about), the local first features from the original ElectricSQL project have been restructured. The team behind Electric has decided to improve reliability and performance by reducing the scope of the project and add more features incrementally.

Only the read path use case will be considered for the initial release. That is replicating rows to different devices via the Shapes API.
Regarding writes you will need to use a remote API endpoint that inserts, updates or deletes from your Postgres, and Electric Next will make sure to stream those changes to the clients .
What that means is that if your project needs offline CRUD operations on your apps, the new Electric won't be your best option for now.

Electric Dart is open source and will remain as that, but with the announcement of Electric Next it can be considered deprecated until previous features from the original ElectricSQL local first vision are reintroduced back at an undetermined date.

The good news is that if your app is fine with offline reads, and writes through an API, implementing a client should be very simple, as it's basically an HTTP wrapper that outputs JSON. You have the JS source code in the electric next repository (https://github.com/electric-sql/electric-next).

Sorry for being the bearer of bad news for those who are affected. Hopefully the full local first experience can be reached one day. The development experience we had with drift and Electric has been awesome.

If you are interested in the new approach or have questions make sure to check out the official [ElectricSQL Discord](https://discord.gg/B7kHGwDcbj) server.

---

Expand Down
5 changes: 5 additions & 0 deletions packages/electricsql/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## 0.8.3

* Deprecation notice. Please refer to the README for more information.


## 0.8.1

* Code based on official Typescript client [v0.12.1](https://github.com/electric-sql/electric/releases/tag/electric-sql%400.12.1).
Expand Down
2 changes: 1 addition & 1 deletion packages/electricsql/lib/src/version.dart
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
const kElectricProtocolVersion = '0.12';
const kElectricClientVersion = '0.8.1';
const kElectricClientVersion = '0.8.2';
2 changes: 1 addition & 1 deletion packages/electricsql/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: electricsql
description: A Dart implementation for ElectricSQL (electric-sql.com) client.
version: 0.8.1
version: 0.8.2
repository: https://github.com/SkillDevs/electric_dart

environment:
Expand Down
2 changes: 1 addition & 1 deletion todos_flutter/pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ packages:
path: "../packages/electricsql"
relative: true
source: path
version: "0.8.1"
version: "0.8.2"
electricsql_cli:
dependency: "direct dev"
description:
Expand Down

0 comments on commit 710acea

Please sign in to comment.