PowerSync is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres, MongoDB, MySQL or SQL Server on the server-side.

This is the PowerSync client SDK for Kotlin. This SDK currently supports the following Kotlin targets:

• Android
• JVM
• iOS
• macOS
• watchOS
• tvOS

If you need support for additional targets, please reach out!

See a summary of features here and API documentation here.

• core

  • This is the Kotlin Multiplatform SDK implementation, built by depending on common and linking SQLite.

• common

  • This is the Kotlin Multiplatform SDK implementation without a dependency on a fixed SQLite bundle. This allows the SDK to be used with custom SQLite installations (like e.g. SQLCipher).

• integrations

  • room: Allows using the Room database library with PowerSync, making it easier to run typed queries on the database.
  • sqldelight: Allows using SQLDelight with PowerSync, also enabling typed statements on the database.
  • SupabaseConnector.kt An example connector implementation for Supabase (Postgres). The backend connector provides the connection between your application backend and the PowerSync managed database. It is used to:
    1. Retrieve a token to connect to the PowerSync service.
    2. Apply local changes on your backend application server (and from there, to your backend database).

• sqlite3multipleciphers

  • A SQLite driver implementation based on SQLite3MultipleCiphers.

The easiest way to test the PowerSync KMP SDK is to run one of our demo applications.

Demo applications are located in the demos/ directory. See their respective README's for testing instructions:

• demos/supabase-todolist: A simple to-do list application demonstrating the use of the PowerSync Kotlin Multiplatform SDK and the Supabase connector.
• demos/android-supabase-todolist: A simple to-do list application demonstrating the use of the PowerSync Kotlin Multiplatform SDK and the Supabase connector in an Android application.

Add the PowerSync Kotlin Multiplatform SDK to your project by adding the following to your build.gradle.kts file:

kotlin {
    //...
    sourceSets {
        commonMain.dependencies {
            api("com.powersync:core:$powersyncVersion")
        }
        //...
    }
}

If want to use the Supabase Connector, also add the following to commonMain.dependencies:

    implementation("com.powersync:connector-supabase:$powersyncVersion")

When building iOS, macOS, tvOS or watchOS apps with Kotlin Multiplatform and Kotlin/Native, you also need to install the PowerSync SQLite extension with your app.

To do that, open the target project in XCode and add a package dependency on https://github.com/powersync-ja/powersync-sqlite-core-swift.git. You can also open the demo project (demos/supabase-todolist/iosApp) in XCode as an example.

For Android and JVM targets, the extension is bundled with the Kotlin SDK and no further setup is necessary.

This repo uses ktlint to handle formatting and linting. If you would like the IDE to automatically format your code and show linting errors install the ktlint plugin. Then in Settings go to Tools -> Ktlint -> Select Distract free (recommended) mode. It will automatically use the rules set in the .editorconfig file.

Our full SDK reference contains everything you need to know to get started implementing PowerSync in your project.

For example projects built with PowerSync and Kotlin Multiplatform, see our Demo Apps / Example Projects gallery. Most of these projects can also be found in the demos/ directory.