The PowerSync KMP SDK is distributed via Maven Central [External link].
Refer to the powersync-kotlin repo on GitHub.
Full API reference for the PowerSync SDK [External link].
Gallery of example projects/demo apps built with Kotlin Multiplatform and PowerSync.
Supported targets: Android, iOS and Desktop.
Add the PowerSync SDK to your project by adding the following to your build.gradle.kts
file:
CocoaPods configuration (recommended for iOS)
Add the following to the cocoapods
config in your build.gradle.kts
:
The linkOnly = true
attribute and isStatic = true
framework setting ensure that the powersync-sqlite-core
binaries are statically linked.
JVM compatibility for Desktop
Before implementing the PowerSync SDK in your project, make sure you have completed these steps:
The first step is defining the schema for the local SQLite database, which is provided to the PowerSyncDatabase
constructor via the schema
parameter. This schema represents a “view” of the downloaded data. No migrations are required — the schema is applied directly when the PowerSync database is constructed.
The types available are text
, integer
and real
. These should map directly to the values produced by the Sync Rules. If a value doesn’t match, it is cast automatically.
Example:
Note: No need to declare a primary key id
column, as PowerSync will automatically create this.
Next, you need to instantiate the PowerSync database — this is the core managed database.
Its primary functions are to record all changes in the local database, whether online or offline. In addition, it automatically uploads changes to your app backend when connected.
Example:
a. Create platform specific DatabaseDriverFactory
to be used by the PowerSyncBuilder
to create the SQLite database driver.
b. Build a PowerSyncDatabase
instance using the PowerSyncBuilder
and the DatabaseDriverFactory
. The schema you created in a previous step is provided as a parameter:
c. Connect the PowerSyncDatabase
to the backend connector:
Special case: Compose Multiplatform
The artifact com.powersync:powersync-compose
provides a simpler API:
Create a connector to integrate with your backend. The PowerSync backend connector provides the connection between your application backend and the PowerSync managed database.
It is used to:
Accordingly, the connector must implement two methods:
PowerSyncBackendConnector.fetchCredentials
- This is called every couple of minutes and is used to obtain credentials for your app backend API. -> See Authentication Setup for instructions on how the credentials should be generated.PowerSyncBackendConnector.uploadData
- Use this to upload client-side changes to your app backend.
-> See Writing Client Changes for considerations on the app backend implementation.Example:
Note: If you are using Supabase, you can use SupabaseConnector.kt as a starting point.
Once the PowerSync instance is configured you can start using the SQLite DB functions.
The most commonly used CRUD functions to interact with your SQLite data are:
The get
method executes a read-only (SELECT) query and returns a single result. It throws an exception if no result is found. Use getOptional
to return a single optional result (returns null
if no result is found).
The getAll
method executes a read-only (SELECT) query and returns a set of rows.
The watch
method executes a read query whenever a change to a dependent table is made.
The execute
method executes a write query (INSERT, UPDATE, DELETE) and returns the results (if any).
You can include your own Logger that must conform to the Kermit Logger as shown here.
If you don’t supply a Logger then a default Kermit Logger is created with settings to only show Warnings
in release and Verbose
in debug as follows:
You are able to use the Logger anywhere in your code as follows to debug:
See Usage Examples for further examples of the SDK.
ORM support is not yet available, we are still investigating options. Please let us know what your needs around ORMs are.
See Troubleshooting for pointers to debug common issues.
The PowerSync KMP SDK is distributed via Maven Central [External link].
Refer to the powersync-kotlin repo on GitHub.
Full API reference for the PowerSync SDK [External link].
Gallery of example projects/demo apps built with Kotlin Multiplatform and PowerSync.
Supported targets: Android, iOS and Desktop.
Add the PowerSync SDK to your project by adding the following to your build.gradle.kts
file:
CocoaPods configuration (recommended for iOS)
Add the following to the cocoapods
config in your build.gradle.kts
:
The linkOnly = true
attribute and isStatic = true
framework setting ensure that the powersync-sqlite-core
binaries are statically linked.
JVM compatibility for Desktop
Before implementing the PowerSync SDK in your project, make sure you have completed these steps:
The first step is defining the schema for the local SQLite database, which is provided to the PowerSyncDatabase
constructor via the schema
parameter. This schema represents a “view” of the downloaded data. No migrations are required — the schema is applied directly when the PowerSync database is constructed.
The types available are text
, integer
and real
. These should map directly to the values produced by the Sync Rules. If a value doesn’t match, it is cast automatically.
Example:
Note: No need to declare a primary key id
column, as PowerSync will automatically create this.
Next, you need to instantiate the PowerSync database — this is the core managed database.
Its primary functions are to record all changes in the local database, whether online or offline. In addition, it automatically uploads changes to your app backend when connected.
Example:
a. Create platform specific DatabaseDriverFactory
to be used by the PowerSyncBuilder
to create the SQLite database driver.
b. Build a PowerSyncDatabase
instance using the PowerSyncBuilder
and the DatabaseDriverFactory
. The schema you created in a previous step is provided as a parameter:
c. Connect the PowerSyncDatabase
to the backend connector:
Special case: Compose Multiplatform
The artifact com.powersync:powersync-compose
provides a simpler API:
Create a connector to integrate with your backend. The PowerSync backend connector provides the connection between your application backend and the PowerSync managed database.
It is used to:
Accordingly, the connector must implement two methods:
PowerSyncBackendConnector.fetchCredentials
- This is called every couple of minutes and is used to obtain credentials for your app backend API. -> See Authentication Setup for instructions on how the credentials should be generated.PowerSyncBackendConnector.uploadData
- Use this to upload client-side changes to your app backend.
-> See Writing Client Changes for considerations on the app backend implementation.Example:
Note: If you are using Supabase, you can use SupabaseConnector.kt as a starting point.
Once the PowerSync instance is configured you can start using the SQLite DB functions.
The most commonly used CRUD functions to interact with your SQLite data are:
The get
method executes a read-only (SELECT) query and returns a single result. It throws an exception if no result is found. Use getOptional
to return a single optional result (returns null
if no result is found).
The getAll
method executes a read-only (SELECT) query and returns a set of rows.
The watch
method executes a read query whenever a change to a dependent table is made.
The execute
method executes a write query (INSERT, UPDATE, DELETE) and returns the results (if any).
You can include your own Logger that must conform to the Kermit Logger as shown here.
If you don’t supply a Logger then a default Kermit Logger is created with settings to only show Warnings
in release and Verbose
in debug as follows:
You are able to use the Logger anywhere in your code as follows to debug:
See Usage Examples for further examples of the SDK.
ORM support is not yet available, we are still investigating options. Please let us know what your needs around ORMs are.
See Troubleshooting for pointers to debug common issues.