Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions client-sdks/orms/kotlin/room.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ When adopting the Room integration for PowerSync:

## Installation

<Warning>
Version 1.14.1 and later of `com.powersync:integration-room` requires [Room 3.0](https://developer.android.com/jetpack/androidx/releases/room3). If your app still uses Room 2.x, upgrade your Room dependency to 3.0 before updating the integration.
</Warning>

PowerSync acts as an addon to your existing Room database, which means that (unlike with most other PowerSync SDKs)
you are still responsible for schema management.
Room requires [raw tables](/client-sdks/advanced/raw-tables), as the views managed by PowerSync are incompatible with
Expand Down
13 changes: 13 additions & 0 deletions client-sdks/reference/kotlin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ import LocalOnly from '/snippets/local-only-escape.mdx';
**Supported platforms**
* PowerSync supports Android, JVM and Apple (iOS, macOS, tvOS, watchOS) targets through Kotlin Multiplatform.
* On the JVM, the following platforms are supported: Linux AArch64, Linux X64, MacOS AArch64, MacOS X64, Windows X64.
* Web (JS and WebAssembly) targets have experimental support. See [Experimental Web Support](#experimental-web-support).
</Note>

## Getting Started
Expand Down Expand Up @@ -374,6 +375,18 @@ The PowerSync SDK for Kotlin can be used with the SQLDelight and Room libraries,
run SQL queries.
For details, see the [SQL Library Support](/client-sdks/orms/kotlin/overview) page.

## Experimental Web Support

Version 1.14.1 of the SDK adds initial support for web targets (JS and WebAssembly). Use `WebConnectionFactory` to open a PowerSync database on the web.

<Warning>
Web support is experimental and incomplete. We are sharing it for early testing and prototyping purposes, and it is not ready for production use. The main limitation is that multi-tab support is not functional in this version: tabs don't coordinate sync connections or share update notifications, so use the database from a single tab only.

If you try web support, please test it thoroughly and report any issues you run into on [GitHub](https://github.com/powersync-ja/powersync-kotlin/issues). Follow the [tracking issue](https://github.com/powersync-ja/powersync-kotlin/issues/362) for progress on stabilizing web support.
</Warning>

For a working example, see the web target of the [Supabase To-Do List demo](https://github.com/powersync-ja/powersync-kotlin/tree/main/demos/supabase-todolist).

## Troubleshooting
Comment thread
benitav marked this conversation as resolved.

See [Troubleshooting](/debugging/troubleshooting) for pointers to debug common issues.
Expand Down
4 changes: 2 additions & 2 deletions resources/supported-platforms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
| --- | --- |
| <Icon icon="android" /> Android | SDK 24 (Android 7.0) |
| <Icon icon="apple" /> iOS | 15.0 |
| <Icon icon="apple" /> macOS | 14.0 (Sonoma) |

Check warning on line 14 in resources/supported-platforms.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

resources/supported-platforms.mdx#L14

Did you really mean 'Sonoma'?
| <Icon icon="windows" /> Windows | 10 |
| <Icon icon="linux" /> Linux | glibc 2.34+ |

Check warning on line 16 in resources/supported-platforms.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

resources/supported-platforms.mdx#L16

Did you really mean 'glibc'?
| <Icon icon="js" /> Web | See [Web Compatibility](#web-compatibility). |

Note that some client SDKs may support lower versions than the ones listed here.
Expand All @@ -30,7 +30,7 @@
| 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+ | |

Check warning on line 33 in resources/supported-platforms.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

resources/supported-platforms.mdx#L33

Did you really mean 'glibc'?
| 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 | – | |
Expand Down Expand Up @@ -97,7 +97,7 @@
| Platform / Feature | Supported? | Platform Version | Notes |
| --- | --- | --- | --- |
| macOS | Yes | 14.0 | |
| Linux | Yes | glibc 2.34+ | |

Check warning on line 100 in resources/supported-platforms.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

resources/supported-platforms.mdx#L100

Did you really mean 'glibc'?
| Windows | Yes | 10 | |
| HTTP connection method | Yes | – | |
| WebSocket connection method | Yes | – | |
Expand All @@ -119,8 +119,8 @@
| macOS (JVM) | Yes (x86-64, aarch64) | | |
| Linux (native) | No | – | Maybe soon |
| Windows (native) | No | – | Maybe soon |
| JS | No | – | |
| WebAssembly | No | – | |
| JS | Experimental | – | Added in SDK v1.14.1. Unstable and not ready for production — see [Experimental Web Support](/client-sdks/reference/kotlin#experimental-web-support). |
| WebAssembly | Experimental | – | Added in SDK v1.14.1. Unstable and not ready for production — see [Experimental Web Support](/client-sdks/reference/kotlin#experimental-web-support). |
| HTTP connection method | Yes | – | |
| WebSocket connection method | Yes | – | Note: Only as an automated fallback for clients without backpressure support. |

Expand Down Expand Up @@ -170,7 +170,7 @@

| Database | Version | Notes |
| --- | --- | --- |
| <Icon icon="elephant" iconType="solid" /> PostgreSQL | 11+ | |

Check warning on line 173 in resources/supported-platforms.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

resources/supported-platforms.mdx#L173

Use 'Postgres' instead of 'PostgreSQL'.
| <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. |
Expand Down