You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/powersync_attachments_helper/README.md
+12-6Lines changed: 12 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,19 @@
1
1
# PowerSync Attachments Helper for Dart/Flutter
2
2
3
-
[PowerSync Attachments Helper](https://pub.dev/packages/powersync_attachments_helper) is a package that assist in keeping files in sync with local and remote storage.
3
+
[PowerSync Attachments Helper](https://pub.dev/packages/powersync_attachments_helper) is a package that assists in keeping files in sync between local and remote storage.
4
4
5
5
> [!WARNING]
6
-
> There is a new attachments helper library in the core PowerSync package, available under
7
-
> `package:powersync_core/attachments/attachments.dart`. While this package will continue to receive
8
-
> bugfixes, new feature development will only happen in the other package.
6
+
> This package will eventually be replaced by a new attachments helper library in the core PowerSync package, available through:
> The `powersync_core/attachments` library is in alpha and brings improved APIs and functionality that is more in line with our other SDKs, such as the ability to write your own local storage implementation.
12
+
>
13
+
> Check out the [docs here](/packages/powersync_core/doc/attachments.md) to get started.
14
+
>
15
+
> While the `powersync_attachments_helper` package will still get bug fixes if you need them,
16
+
> new features will only be developed on `powersync_core/attachments`.
Copy file name to clipboardExpand all lines: packages/powersync_core/doc/attachments.md
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ PowerSync.
5
5
Embedding this data directly in your source databases is [inefficient and not recommended](https://docs.powersync.com/usage/use-case-examples/attachments).
6
6
7
7
Instead, the PowerSync SDK for Dart and Flutter provides utilities you can use to _reference_ this binary data
8
-
in your primary data model, and then download it from a secondary data store such as S3.
8
+
in your local database, and then download it from a secondary data store such as Supabase Storage or S3.
9
9
Because binary data is not directly stored in the source database in this model, we call these files _attachments_.
10
10
11
11
## Alpha release
@@ -31,8 +31,7 @@ The attachments' state is stored in a local-only attachments table.
31
31
32
32
### Example implementation
33
33
34
-
See the [supabase todolist](https://github.com/powersync-ja/powersync.dart/tree/main/demos/supabase-todolist) demo for
35
-
a basic example of attachment syncing.
34
+
See the [supabase-todolist](https://github.com/powersync-ja/powersync.dart/tree/main/demos/supabase-todolist) demo for a basic example of attachment syncing.
36
35
37
36
### Setup
38
37
@@ -77,7 +76,6 @@ final attachmentQueue = AttachmentQueue(
77
76
```
78
77
79
78
Here,
80
-
81
79
- An instance of `LocalStorageAdapter`, such as the `IOLocalStorage` provided by the SDK, is responsible for storing
82
80
attachment contents locally.
83
81
- An instance of `RemoteStorageAdapter` is responsible for downloading and uploading attachment contents to the secondary
0 commit comments