-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
DominicGBauer
committed
Dec 20, 2023
1 parent
53e025c
commit b1b5709
Showing
43 changed files
with
6,304 additions
and
1 deletion.
There are no files selected for viewing
Submodule powersync.dart
deleted from
d12b07
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Flutter/Dart/Pub related | ||
**/doc/api/ | ||
**/ios/Flutter/.last_build_id | ||
.dart_tool/ | ||
.flutter-plugins | ||
.flutter-plugins-dependencies | ||
.packages | ||
.pub-cache/ | ||
.pub/ | ||
/build/ | ||
|
||
# IDE files | ||
.idea | ||
|
||
# Avoid committing pubspec.lock for library packages; see | ||
# https://dart.dev/guides/libraries/private-files#pubspeclock. | ||
pubspec.lock | ||
|
||
doc | ||
|
||
/test-db |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
## 1.0.0 | ||
|
||
- Start using stable version range. | ||
|
||
## 0.4.2 | ||
|
||
- Improve HTTP error messages. | ||
- Enable SQLite recursive triggers. | ||
- Support overriding view names. | ||
- Validate schema definitions for duplicates. | ||
|
||
## 0.4.1 | ||
|
||
- Use Apache 2.0 license. | ||
- Update uuid dependency. | ||
|
||
## 0.4.0 | ||
|
||
Improvements: | ||
|
||
- Some parameters to `PowerSyncCredentials` are now optional. | ||
- Upgrade dependencies. | ||
|
||
## 0.4.0-preview.6 | ||
|
||
New functionality: | ||
|
||
- Include transaction ids on crud entries, allowing transactions to be grouped together. | ||
- Simplify implementation of `PowerSyncBackendConnector` by automatically handling token caching. | ||
|
||
Fixes: | ||
|
||
- Only check token expiration on the server, avoiding issues when the local time is out of sync. | ||
- Fix some edge case errors that would kill the sync Isolate. | ||
- Fix errors when disconnecting shortly after connecting. | ||
|
||
Breaking changes: | ||
|
||
- `PowerSyncDatabase.disconnect()` now returns `Future<void>` instead of `void`. | ||
- Subclasses of `PowerSyncBackendConnector` must now implement `fetchCredentials()` instead of `refreshCredentials()` + `getCredentials()`. | ||
|
||
Other changes: | ||
|
||
- Update sqlite_async dependency to 0.4.0: <https://pub.dev/packages/sqlite_async/changelog> | ||
|
||
## 0.3.0-preview.5 | ||
|
||
- Link github repository. | ||
|
||
## 0.3.0-preview.4 | ||
|
||
The low-level SQLite-related code is extracted into a separate [sqlite_async](https://pub.dev/packages/sqlite_async) package. | ||
`sqlite_async` handles the the database connection, connection pooling, Isolate management, queries, | ||
transactions, default options, watching, and migrations. | ||
|
||
The `powersync` package now just adds automatic sync and dynamic schema management on top. This makes it easy to switch between | ||
using PowerSync, or just using a local database directly. | ||
|
||
Breaking changes: | ||
|
||
- `TableUpdate` renamed to `UpdateNotification`. | ||
- `PowerSyncDatabase.connectionFactory()` renamed to `PowerSyncDatabase.isolateConnectionFactory()`, | ||
and should only be used to pass the connection to a different isolate. | ||
- All tables apart from `ps_crud` are dropped and re-created when upgrading to this version. | ||
This will not result in any data loss, but a full re-sync is required. | ||
|
||
Fixes: | ||
|
||
- Fix queries not watching the correct tables in some cases. | ||
- Fix performance issues on bulk insert/update/delete. | ||
|
||
Other changes: | ||
|
||
- Views and triggers are now persisted in the database, instead of using temporary views. | ||
- This allows reading the views using other tools. | ||
- It is still not possible to update the views using other tools, since triggers use the custom `powersync_diff` function to compute changes. | ||
|
||
## 0.2.0-preview.3 | ||
|
||
- Use new write checkpoint API for reduced latency on data upload. | ||
- Improve consistency when custom primary keys are used. | ||
- Fix error on `getOptional()`. | ||
- Use `gen_random_uuid()` as an alias for `uuid()` (custom function for SQLite). | ||
|
||
## 0.2.0-preview.2 | ||
|
||
- Performance improvements in downloading changes. | ||
|
||
## 0.2.0-preview.1 | ||
|
||
Breaking change: | ||
|
||
- Rename internal tables to all start with `ps_`. All existing local data is deleted and re-synced. | ||
|
||
Other changes: | ||
|
||
- Add support for local indexes. | ||
- Add support for local-only tables - no changes recorded, and not synced with the remote service. | ||
- Add support for insert-only tables - records changes, but does not persist data or download from the remote service. | ||
- Add `executeBatch()` API: execute the same statement with multiple parameter sets. | ||
- Add `computeWithDatabase()` API: execute a function in the database isolate, with low-level synchronous database access. | ||
- Add `onChange()` call to receive notifications of changes to a set of tables. | ||
- Improve `watch()` to only listen for updates to relevant tables. | ||
- Faster `uuid()` implementation. | ||
|
||
## 0.1.1-preview.2 | ||
|
||
- Require Flutter SDK. | ||
|
||
## 0.1.1-preview.1 | ||
|
||
- First public version. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,177 @@ | ||
|
||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Copyright 2023 Journey Mobile, Inc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# PowerSync SDK for Dart/Flutter | ||
|
||
[PowerSync](https://powersync.co) is a service and set of SDKs that keeps PostgreSQL databases in sync with on-device SQLite databases. | ||
|
||
## SDK Features | ||
|
||
* Real-time streaming of changes. | ||
* Direct access to the SQLite database - use SQL on the client and server. | ||
* Operations are asynchronous by default - does not block the UI. | ||
* Supports one write and many reads concurrently. | ||
* No need for client-side database migrations - these are handled automatically. | ||
* Subscribe to queries for live updates. | ||
|
||
## Getting started | ||
|
||
```dart | ||
import 'package:powersync/powersync.dart'; | ||
import 'package:path_provider/path_provider.dart'; | ||
import 'package:path/path.dart'; | ||
const schema = Schema([ | ||
Table('customers', [Column.text('name'), Column.text('email')]) | ||
]); | ||
late PowerSyncDatabase db; | ||
openDatabase() async { | ||
final dir = await getApplicationSupportDirectory(); | ||
final path = join(dir.path, 'powersync-dart.db'); | ||
// Setup the database. | ||
db = PowerSyncDatabase(schema: schema, path: path); | ||
await db.initialize(); | ||
// Run local statements. | ||
await db.execute( | ||
'INSERT INTO customers(id, name, email) VALUES(uuid(), ?, ?)', | ||
['Fred', '[email protected]']); | ||
} | ||
connectPowerSync() async { | ||
// DevConnector stores credentials in-memory by default. | ||
// Extend the class to persist credentials. | ||
final connector = DevConnector(); | ||
// Login in dev mode. | ||
await connector.devLogin( | ||
endpoint: 'https://myinstance.powersync.co', | ||
user: 'demo', | ||
password: 'demo'); | ||
// Connect to PowerSync service and start sync. | ||
db.connect(connector: connector); | ||
} | ||
``` |
Oops, something went wrong.