Source Code

Refer to the powersync-swift repo on GitHub.

API Reference (Coming soon)

A full API Reference for this SDK is not yet available. This is planned for the stable release.

Example Projects

Gallery of example projects/demo apps built with PowerSync and Swift.

The PowerSync Swift SDK is currently in a beta release. It is suitable for production use at this stage given you’ve tested your use cases extensively. Breaking changes are unlikely to occur.

​
Kotlin Multiplatform -> Native Swift SDK

The PowerSync Swift SDK currently makes use of the PowerSync Kotlin Multiplatform SDK with the API tool SKIE and KMMBridge under the hood to help generate and publish a Swift package. We will move to an entirely Swift native SDK in v1 and do not expect there to be any breaking changes.

Demo App

We recommend the Supabase Todo List Demo app as a starting point for using the Swift SDK. See the README for details to run it.

​
SDK Features

  • Provides real-time streaming of database changes.

  • Offers direct access to the SQLite database, enabling the use of SQL on both client and server sides.

  • Operations are asynchronous by default, ensuring the user interface remains unblocked.

  • Supports concurrent database operations, allowing one write and multiple reads simultaneously.

  • Enables subscription to queries for receiving live updates.

  • Eliminates the need for client-side database migrations as these are managed automatically.

​
Installation

  1. Using Package.swift:
let package = Package(
    ...
    dependencies: [
        ...
        .package(
            url: "https://github.com/powersync-ja/powersync-swift",
            // Exact version required while still in beta
            exact: "<version>"
        ),
    ],
    targets: [
        .target(
            name: "YourTargetName",
            dependencies: [
                .product(
                    name: "PowerSync",
                    package: "powersync-swift"
                ),
            ]
        )
    ]
)

  1. Using Xcode:

    1. Follow this guide to add a package to your project.
    2. When searching for the package use https://github.com/powersync-ja/powersync-swift.git as the URL and include the exact version e.g. 1.0.0-Beta.x as shown below:

​
Migrating from the Alpha to the Beta SDK

The beta version of this SDK introduces a Swift-native wrapper around the package generated from the Kotlin Multiplatform SDK, bringing a more Swift-native interface for developers. This results in several API updates from the more Kotlin-based alpha version. The main changes are:

  • The PowerSyncDatabase no longer needs a driver argument and it must be removed.
  • The interface for PowerSyncDatabase now uses PowerSyncDatabaseProtocol which may require some changes to databases uses.
  • If you were using __uploadData and __fetchCredentials in your PowerSyncBackendConnector you must remove the __ and update the methods to uploadData and fetchCredentials.
  • @MainThread usage is no longer required and should be removed.
  • Implementing SuspendTaskWrapper for database transactions is no longer required and should be removed.

See the Todo List Demo app as a reference.

​
Getting Started

Before implementing the PowerSync SDK in your project, make sure you have completed these steps:

​
1. Define the Schema

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:

import Foundation
import PowerSync

let LISTS_TABLE = "lists"
let TODOS_TABLE = "todos"

let lists = Table(
    name: LISTS_TABLE,
    columns: [
        // ID column is automatically included
        .text("name"),
        .text("created_at"),
        .text("owner_id")
    ]
)

let todos = Table(
    name: TODOS_TABLE,
    // ID column is automatically included
    columns: [
        .text("list_id"),
        .text("photo_id"),
        .text("description"),
        // 0 or 1 to represent false or true
        .integer("completed"),
        .text("created_at"),
        .text("completed_at"),
        .text("created_by"),
        .text("completed_by")
    ],
    indexes: [
        Index(
            name: "list_id",
            columns: [
                IndexedColumn.ascending("list_id")
            ]
        )
    ]
)

let AppSchema = Schema(lists, todos)

Note: No need to declare a primary key id column, as PowerSync will automatically create this.

​
2. Instantiate the PowerSync Database

Next, you need to instantiate the PowerSync database — this is the core managed database.

Its primary function is 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:

// Comes from the AppSchema defined above
let schema = AppSchema
let db = PowerSyncDatabase(
    schema: schema,
    dbFilename: "powersync-swift.sqlite"
)

​
3. Integrate with your Backend

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:

  1. Retrieve an auth token to connect to the PowerSync instance.

  2. Apply local changes on your backend application server (and from there, to Postgres)

Accordingly, the connector must implement two methods:

  1. PowerSyncBackendConnector.fetchCredentials - This is called every couple of minutes and is used to obtain credentials for your app’s backend API. -> See Authentication Setup for instructions on how the credentials should be generated.

  2. 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:

import PowerSync

@Observable
class MyConnector: PowerSyncBackendConnector {
    override func fetchCredentials() async throws -> PowerSyncCredentials? {
    // implement fetchCredentials to obtain the necessary credentials to connect to your backend
    // See an example implementation in https://github.com/powersync-ja/powersync-swift/blob/main/Demo/PowerSyncExample/PowerSync/SupabaseConnector.swift

        return {
            endpoint: '[Your PowerSync instance URL or self-hosted endpoint]',
            // Use a development token (see Authentication Setup https://docs.powersync.com/installation/authentication-setup/development-tokens)
            // to get up and running quickly) to get up and running quickly
            token: 'An authentication token'
        }
    }

    override func uploadData(database: PowerSyncDatabaseProtocol) async throws {
        // Implement uploadData to send local changes to your backend service
        // You can omit this method if you only want to sync data from the server to the client
        // See an example implementation under Usage Examples (sub-page)
        // See https://docs.powersync.com/installation/app-backend-setup/writing-client-changes for considerations.
    }
}

​
Using PowerSync: CRUD functions

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:

​
Fetching a Single Item ( PowerSync.get / PowerSync.getOptional)

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).

// Find a list item by ID
func getList(_ id: String) async throws {
    try await self.db.getAll(
        sql: "SELECT * FROM \(LISTS_TABLE) WHERE id = ?",
        parameters: [id],
        mapper: { cursor in
            ListContent(
                id: cursor.getString(index: 0)!,
                name: cursor.getString(index: 1)!,
                createdAt: cursor.getString(index: 2)!,
                ownerId: cursor.getString(index: 3)!
            )
        }
    )
}

​
Querying Items (PowerSync.getAll)

The getAll method executes a read-only (SELECT) query and returns a set of rows.

// Get all lists
func getLists() async throws {
    try await self.db.getAll(
        sql: "SELECT * FROM \(LISTS_TABLE)",
        parameters: [],
        mapper: { cursor in
            ListContent(
                id: cursor.getString(index: 0)!,
                name: cursor.getString(index: 1)!,
                createdAt: cursor.getString(index: 2)!,
                ownerId: cursor.getString(index: 3)!
            )
        }
    )
}

​
Watching Queries (PowerSync.watch)

The watch method executes a read query whenever a change to a dependent table is made.

// You can watch any SQL query
func watchLists(_ callback: @escaping (_ lists: [ListContent]) -> Void ) async {
    for await lists in self.db.watch(
        sql: "SELECT * FROM \(LISTS_TABLE)",
        parameters: [],
        mapper: { cursor in
            ListContent(
                id: cursor.getString(index: 0)!,
                name: cursor.getString(index: 1)!,
                createdAt: cursor.getString(index: 2)!,
                ownerId: cursor.getString(index: 3)!
            )
        }
    ) {
        callback(lists)
    }
}

​
Mutations (PowerSync.execute)

The execute method executes a write query (INSERT, UPDATE, DELETE) and returns the results (if any).

func insertTodo(_ todo: NewTodo, _ listId: String) async throws {
    try await db.execute(
        sql: "INSERT INTO \(TODOS_TABLE) (id, created_at, created_by, description, list_id, completed) VALUES (uuid(), datetime(), ?, ?, ?, ?)",
        parameters: [connector.currentUserID, todo.description, listId, todo.isComplete]
    )
}

func updateTodo(_ todo: Todo) async throws {
    try await db.execute(
        sql: "UPDATE \(TODOS_TABLE) SET description = ?, completed = ?, completed_at = datetime(), completed_by = ? WHERE id = ?",
        parameters: [todo.description, todo.isComplete, connector.currentUserID, todo.id]
    )
}

func deleteTodo(id: String) async throws {
    try await db.writeTransaction(callback: { transaction in
        _ = try await transaction.execute(
                sql: "DELETE FROM \(TODOS_TABLE) WHERE id = ?",
                parameters: [id]
            )
        return
    })
}

Was this page helpful?

Usage Examples