Document minimum supported platform/OS versions #458
There are no files selected for viewing
This file contains hidden or 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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,32 +3,65 @@ | |||||
| description: "Supported platforms and feature availability for each PowerSync Client SDK across mobile, web, and desktop." | ||||||
| --- | ||||||
|
|
||||||
| Jump to: [Source Databases](#supported-source-databases), [SDK Platforms](#supported-sdk-platforms), [Supported Platforms Policy](#supported-platforms-policy), [SDK Versioning Policy](#sdk-versioning-policy) | ||||||
|
|
||||||
| ## Supported Source Databases | ||||||
|
|
||||||
| Each supported source database has a minimum required version to be compatible with PowerSync. | ||||||
|
|
||||||
| | Database | Version | Notes | | ||||||
| | --- | --- | --- | | ||||||
| | <Icon icon="elephant" iconType="solid" /> PostgreSQL | 11+ | | | ||||||
| | <Icon icon="leaf" iconType="solid" /> MongoDB | 6.0+ | | | ||||||
| | <Icon icon="dolphin" iconType="solid" /> MySQL | 5.7+ | | | ||||||
| | <Icon icon="server" iconType="solid" /> SQL Server (beta) | SQL Server 2019+ (15.0+) or Azure SQL Database | Beta release.<br />Azure SQL Database is always running on the latest version of the SQL Server DB Engine. | | ||||||
| | <Icon icon="database" iconType="solid" /> Convex (alpha) | — | Alpha release. | | ||||||
|
|
||||||
| ## Supported SDK Platforms | ||||||
|
|
||||||
| Jump to: [<Icon icon="flutter" iconType="solid" /> Dart/Flutter SDK](#dart/flutter-sdk), [<Icon icon="react" iconType="solid" /> React Native SDK](#react-native-sdk), [<Icon icon="js" iconType="solid" /> Javascript SDK](#js/web-sdk), [<Icon icon="c" iconType="solid" /> Capacitor SDK](#capacitor-sdk), [<Icon icon="rust" /> Tauri SDK](#tauri-sdk), [<Icon icon="node-js" /> Node.js SDK](#node-js-sdk), [<Icon icon="android" /> Kotlin SDK](#kotlin-sdk), [<Icon icon="swift" iconType="solid" /> Swift SDK](#swift-sdk), [<Icon icon="microsoft" iconType="solid" /> .NET SDK](#net-sdk), [<Icon icon="rust" /> Rust SDK](#rust-sdk) | ||||||
|
Collaborator
There was a problem hiding this comment. Similar comment as above. I get why we have it - there's a lot of content here, but if you're worried about excessive scrolling maybe rather consider accordions (a collapsible section) for each SDK like we have in https://docs.powersync.com/intro/examples?
Collaborator
There was a problem hiding this comment. probably don't need either a jump to or an accordion. it's ok to scroll this page IMO since it's typically not on the golden path |
||||||
|
|
||||||
| ### Widespread SDK Platform Support | ||||||
|
|
||||||
| The versions below are the minimum supported versions across all PowerSync Client SDKs, so you can expect them to work regardless of which SDK you use. | ||||||
|
LucDeCaf marked this conversation as resolved.
|
||||||
|
|
||||||
| Note: Some client SDKs may support lower versions than the ones listed here. | ||||||
|
|
||||||
| | Platform | Version | | ||||||
| | --- | --- | | ||||||
| | <Icon icon="android" /> Android | SDK 24 (Android 7.0) | | ||||||
| | <Icon icon="apple" /> iOS | 15.0 | | ||||||
| | <Icon icon="apple" /> macOS | 14.0 (Sonoma) | | ||||||
| | <Icon icon="windows" /> Windows | 10 | | ||||||
| | <Icon icon="linux" /> Linux | glibc 2.34+ | | ||||||
| | <Icon icon="js" /> Web | See [Web Compatibility](#web-compatibility). | | ||||||
|
|
||||||
| ### <Icon icon="flutter" iconType="solid" size={24}/> Dart/Flutter SDK | ||||||
|
Collaborator
There was a problem hiding this comment. I think just above these SDK sections we should add a callout or something stating that if a Platform Version isn't indicated (e.g. there are a lot of empty cells in the "Platform Version" column in these tables below) it means it's as of yet unspecified or untested or unknown - not sure what the correct term here is and users should refer to Widespread SDK table for now. i.e. that these tables below are a WIP?
Collaborator
There was a problem hiding this comment. On the same note, if an entire table does not ahve a value in that column (e.g. Tauri) I think let's leave it out for now - it looks a bit jarring being just and empty column, or add some placeholder content there. |
||||||
|
|
||||||
| | Platform / Feature | Supported? | Platform Version | Notes | | ||||||
| | --- | --- | --- | --- | | ||||||
| | Android | Yes (x86-64, aarch64, armv7) | SDK 24 (Android 7.0) | Requires Flutter | | ||||||
| | iOS | Yes | 13.0 | Requires Flutter | | ||||||
| | macOS | Yes (x86-64, aarch64) | 12.0 (Monterey) | | | ||||||
| | Windows | Yes (x86-64, x86, aarch64) | 10 | | | ||||||
| | Linux | Yes (x86-64, x86, aarch64, armv7, riscv64gc) | Requires glibc 2.34+ | | | ||||||
| | Web | Yes | OPFS by default, IndexedDB as backup ([see more](/client-sdks/frameworks/flutter-web-support)) | Only dart2js is tested, dart2wasm has issues | | ||||||
| | HTTP connection method | Yes | | | | ||||||
| | WebSocket connection method | No | | | | ||||||
|
|
||||||
| ### <Icon icon="react" iconType="solid" size={24}/> React Native SDK | ||||||
|
|
||||||
| | Platform / Feature | Supported? | Platform Version | Notes | | ||||||
| | --- | --- | --- | --- | | ||||||
| | React Native | Yes | | | | ||||||
| | React Native w/ Expo | Yes | | | | ||||||
| | React Native for Web | Yes | See [Web Compatibility](#web-compatibility). | | | ||||||
| | React Strict DOM | YMMV - not tested | | | | ||||||
| | React Native for Windows | No | | | | ||||||
| | HTTP connection method | Yes | | | | ||||||
| | WebSocket connection method | Yes | | Default | | ||||||
|
|
||||||
| ### <Icon icon="js" iconType="solid" size={24}/> JS/Web SDK | ||||||
|
|
||||||
| | Platform / Feature | Supported? | Notes | | ||||||
| | --- | --- | --- | | ||||||
|
|
@@ -38,97 +71,129 @@ | |||||
| | HTTP connection method | Yes | | | ||||||
| | WebSocket connection method | Yes | | | ||||||
|
|
||||||
| #### Web Compatibility | ||||||
|
|
||||||
| PowerSync's web-targeting SDKs use either [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) or [OPFS](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system) virtual filesystem (VFS) to persist rows on the user's device. On Dart/Flutter, the VFS is chosen automatically. On JS, the developer can choose which VFS strategy they prefer. Each VFS enjoys differing levels of platform support across browsers / devices / operating systems. | ||||||
|
|
||||||
| | VFS | Chrome | Chrome incognito | Firefox | Firefox incognito | Safari | Safari incognito | iOS Webkit | Android Chrome | | ||||||
| | --- | --- | --- | --- | --- | --- | --- | --- | --- | | ||||||
| | IDBBatchAtomicVFS | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | ||||||
| | OPFSCoopSyncVFS | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ | ✅ | ✅ | | ||||||
| | AccessHandlePoolVFS | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ | ✅ | ✅ | | ||||||
| | OPFSWriteAheadVFS | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | | ||||||
|
|
||||||
| ### <Icon icon="c" iconType="solid" size={24}/> Capacitor SDK | ||||||
|
|
||||||
| Requires Capacitor 8 or later. See the [Capacitor v8 upgrade guide](https://capacitorjs.com/docs/updating/8-0) if you are on Capacitor 6 or 7. | ||||||
|
|
||||||
| | Platform / Feature | Supported? | Platform Version | Notes | | ||||||
| | --- | --- | --- | --- | | ||||||
| | iOS | Yes | 15.0 | Uses native SQLite via Capacitor Community SQLite. | | ||||||
| | Android | Yes | SDK 24 (Android 7.0) | Uses native SQLite via Capacitor Community SQLite. | | ||||||
| | Web | Yes | See [Web Compatibility](#web-compatibility). | Uses WASQLite via the PowerSync Web SDK. | | ||||||
| | Electron | Yes | Electron 28+ (TO BE VERIFIED) | Uses WASQLite via the PowerSync Web SDK. | | ||||||
| | HTTP connection method | Yes | | | | ||||||
| | WebSocket connection method | Yes | | | | ||||||
|
|
||||||
| ### <Icon icon="/logo/tauri.svg" iconType="solid" size={24}/> Tauri SDK | ||||||
|
|
||||||
| | Platform / Feature | Supported? | Platform Version | Notes | | ||||||
| | --- | --- | --- | --- | | ||||||
| | Windows | Yes | | Untested. | | ||||||
| | macOS | Yes | | | | ||||||
| | Linux | Yes | | | | ||||||
| | iOS | Yes | | Untested. | | ||||||
| | Android | Yes | | Untested. | | ||||||
| | HTTP connection method | Yes | | Connections must currently be managed through Rust. | | ||||||
| | WebSocket connection method | No | | | | ||||||
|
|
||||||
| ### <Icon icon="node-js" iconType="solid" size={24}/> Node.js SDK | ||||||
|
|
||||||
| The Node SDK supports all [non-EOL Node.js versions](https://nodejs.org/en/about/previous-releases#looking-for-the-latest-release-of-a-version-branch) (i.e. current and LTS). | ||||||
|
|
||||||
| | Platform / Feature | Supported? | Platform Version | Notes | | ||||||
| | --- | --- | --- | --- | | ||||||
| | macOS | Yes | 14.0 | | | ||||||
| | Linux | Yes | glibc 2.34+ | | | ||||||
| | Windows | Yes | 10 | | | ||||||
| | HTTP connection method | Yes | | | | ||||||
| | WebSocket connection method | Yes | | | | ||||||
|
|
||||||
| ### <Icon icon="android" iconType="solid" size={24}/> Kotlin SDK | ||||||
|
|
||||||
| | Platform / Feature | Supported? | Platform Version | Notes | | ||||||
| | --- | --- | --- | --- | | ||||||
| | Android | Yes (x86-64, x86, aarch64, armv7) | | | | ||||||
| | Android native | No | | | | ||||||
| | iOS | Yes (aarch64 device and simulator) | | | | ||||||
| | macOS (native) | Yes (aarch64) | | | | ||||||
| | macOS catalyst (native) | No | | Blocked on [KT-40442: Support building Kotlin/Native for Mac Catalyst (x86-64 and arm64)](https://youtrack.jetbrains.com/issue/KT-40442/Support-building-Kotlin-Native-for-Mac-Catalyst-x86-64-and-arm64) | | ||||||
| | watchOS | Yes (aarch64 device, armv8 32-bit pointers ABI, aarch64 simulator) | | | | ||||||
| | tvOS | Yes (aarch64 device, aarch64 simulator) | | | | ||||||
| | visionOS | No | | Blocked on [KT-59571: Add support for visionOS SDK](https://youtrack.jetbrains.com/issue/KT-59571/Add-support-for-visionOS-SDK) | | ||||||
| | Windows (JVM) | Yes (x86-64 only) | | | | ||||||
| | Linux (JVM) | Yes (x86-64, aarch64) | | | | ||||||
| | macOS (JVM) | Yes (x86-64, aarch64) | | | | ||||||
| | Linux (native) | No | | Maybe soon | | ||||||
| | Windows (native) | No | | Maybe soon | | ||||||
| | JS | No | | | | ||||||
| | WebAssembly | No | | | | ||||||
| | HTTP connection method | Yes | | | | ||||||
| | WebSocket connection method | Yes | | Note: Only as an automated fallback for clients without backpressure support. | | ||||||
|
|
||||||
| ### <Icon icon="swift" iconType="solid" size={24}/> Swift SDK | ||||||
|
|
||||||
| | Platform / Feature | Supported? | Platform Version | Notes | | ||||||
| | --- | --- | --- | --- | | ||||||
| | macOS | Yes | 12.0 (Monterey) | | | ||||||
| | iOS | Yes | | 15.0 | | ||||||
| | watchOS | Yes | | 9.0 | | ||||||
| | iPadOS | Yes | 15.0 | | | ||||||
| | tvOS | Yes | 15.0 | Added in v1.11.0 | | ||||||
| | macOS Catalyst | No | | Please [reach out](https://github.com/powersync-ja/powersync-swift/issues/138) if you're interested. | | ||||||
| | visionOS | No | | Please [reach out](https://github.com/powersync-ja/powersync-swift/issues/138) if you're interested. | | ||||||
| | Non-apple targets (Linux, Windows) | No | | No good way to link PowerSync | | ||||||
| | HTTP connection method | Yes | | | | ||||||
| | WebSocket connection method | No | | | | ||||||
|
|
||||||
| ### <Icon icon="microsoft" iconType="solid" size={24}/> .NET SDK | ||||||
|
|
||||||
| | Platform / Feature | Supported? | Platform Version | Notes | | ||||||
| | --- | --- | --- | --- | | ||||||
| | WPF | Yes | Windows 10 | | | ||||||
| | MAUI for Android | Yes | SDK 24 (Android 7.0) | | | ||||||
| | MAUI for iOS | Yes | 14.0 | | | ||||||
| | MAUI for Windows | Yes | 10 | | | ||||||
| | MAUI for Mac Catalyst | Yes | Catalyst 17.0 (macOS 14.0) | Added in `PowerSync.Maui` 0.1.2. | | ||||||
| | Winforms | YMMV - not tested | | | | ||||||
| | CLI Windows | Yes (x64, ARM) | | | | ||||||
| | CLI Mac | Yes (x64, ARM) | | | | ||||||
| | CLI Linux | Yes (x64, ARM) | | | | ||||||
| | Avalonia UI | YMMV - not tested | | | | ||||||
| | HTTP connection method | Yes | | | | ||||||
| | WebSocket connection method | No | | | | ||||||
|
|
||||||
| ### <Icon icon="rust" iconType="solid" size={24}/> Rust SDK | ||||||
|
|
||||||
| | Platform / Feature | Supported? | Notes | | ||||||
| | --- | --- | --- | | ||||||
| | All | Yes | The SDK supports all `std` Rust targets, but is currently only tested on Linux. | | ||||||
| | HTTP connection method | Yes | | | ||||||
| | WebSocket connection method | No | | | ||||||
|
|
||||||
| ## Supported Platforms Policy | ||||||
|
|
||||||
| PowerSync supports a wide number of target platforms across its many SDKs. We aim to support as many platforms and versions as are useful for users and practical to maintain. | ||||||
|
|
||||||
| ### When we raise the minimum version | ||||||
|
Contributor
There was a problem hiding this comment. Should we mention that we generally raise the minimum version of an OS only in new major SDK versions? Or is that not really feasible in all cases? This would specifically apply for things like Android/iOS/Windows or DB versions, not something that the user can easily upgrade like NodeJS/Flutter/RN versions. cc @simolus3 / @Chriztiaan - you may have more experience in what is practical for us here.
Contributor
There was a problem hiding this comment. I'm leaning towards this not being feasible in all cases. Using AndroidX as an example, they don't use major versions to raise their minimum Android SDK versions. So at that point we'd have to either stop updating our dependencies or cut a major release ourselves. Another example is Kotlin/Native moving towards deprecating X64 Apple targets, we had to drop them too to support the latest dependencies.
Contributor
There was a problem hiding this comment. Ok, happy to just leave that out in that case. |
||||||
|
|
||||||
| In general, PowerSync aims to support any platform version that still receives security updates from the platform provider. For platforms that follow an LTS and Current release model, this means we aim to support all active LTS releases along with the Current release. | ||||||
|
|
||||||
| Supporting every version that fits the above criteria is [not always feasible](#exceptions). When we cannot support all of them, we prioritise support for newer versions over older versions to ease maintenance. We will occasionally maintain support for an older version if an enterprise customer requires it. | ||||||
|
Collaborator
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ### Exceptions | ||||||
|
|
||||||
| - **Dart/Flutter**: The Dart/Flutter team only supports the latest stable release (three-month cycle). We don't follow this release schedule, since dropping support for versions only three months old is undesirable. For the Dart/Flutter SDK's minimum Dart SDK version, see [pub.dev](https://pub.dev/packages/powersync/versions) / the project's [pubspec.yaml](https://github.com/powersync-ja/powersync.dart/blob/main/pubspec.yaml#L6). | ||||||
|
|
||||||
| - **Android**: Several of our SDKs require [AndroidX](https://developer.android.com/jetpack/androidx/versions) libraries. We set our minimum to the current AndroidX default `minSdk` (which AndroidX picks to cover ~99% of Play Store users), except in cases where other factors force a higher `minSdk`. | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We generally rely on the "On this page" breakdown on the side for this, this feels redundant (and inconsistent). If we want to give the user an idea of everything that this page covers (which is a lot), I think a introduction in words/bullets is better.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed we probably don't need this