powersync-swift

KO | EN

gitlite — search

#hacktoberfest #react #golang #machine-learning #rust #deep-learning #linux #java #awesome #kubernetes #awesome-list #ios #openai #open-source

powersync-swift

(★ 60)

SDK that enables local-first and real-time reactive apps with embedded SQLite for Swift clients

File Explorer

Download Latest Version (.zip)

- - build_and_test.yaml
  - docs.yaml
  - zizmor.yaml
- dependabot.yml
- zizmor.yaml
- - README.md
- - README.md
- - README.md
- - README.md
- LocalBuild.md
- Release.md
- - CurrentVersion.swift
  - Logger.swift
  - PowerSyncCredentials.swift
  - PowerSyncDatabase.swift
  - resolvePowerSyncLoadableExtensionPath.swift
- - empty.c
  - module.modulemap
- - Errors.swift
  - GRDBPowerSyncDatabase.swift
- - BasicTest.swift
- - AttachmentTests.swift
  - ConnectTests.swift
  - CrudTests.swift
  - EncryptionTests.swift
  - JsonParamTests.swift
  - SyncTests.swift
.gitignore
CHANGELOG.md
LICENSE
Package.resolved
Package.swift
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

_[PowerSync](https://www.powersync.com) keeps a client-side SQLite database in sync with your backend database. Changes appear across users and devices in real-time, user interactions feel instant and your app continues to work even when offline. Supports Postgres, MongoDB, MySQL, and SQL Server. Client SDKs are available for a wide range of environments including web, mobile, desktop, headless and embedded._

# PowerSync Swift

This is the PowerSync SDK for Swift clients. The SDK reference is available [here](https://docs.powersync.com/client-sdk-references/swift), API references are [documented here](https://powersync-ja.github.io/powersync-swift/documentation/powersync/).

## Available Products

The SDK provides two main products:

- **PowerSync**: Core SDK with SQLite support for data synchronization.
- **PowerSyncDynamic**: Forced dynamically linked version of `PowerSync` - useful for XCode previews.
- **PowerSyncGRDB [ALPHA]**: GRDB integration allowing PowerSync to work with GRDB databases. This product is currently in an alpha release.

## Demo Apps / Example Projects

The easiest way to test the PowerSync Swift SDK is to run our demo application.

- [Demos/PowerSyncExample](./Demos/PowerSyncExample/README.md): A simple to-do list application demonstrating the use of the PowerSync Swift SDK using a Supabase connector.

- [Demos/GRDBDemo](./Demos/GRDBDemo/README.md): A simple to-do list application demonstrating the use of the PowerSync Swift SDK using a Supabase connector and GRDB connections.

- [Demos/SwiftEncryptionDemo](./Demos/SwiftEncryptionDemo/README.md): A simple app opening an encrypted local PowerSync database.

- [Demos/CustomCheckpointDemo](./Demos/CustomCheckpointDemo/README.md): A basic SwiftPM executable demonstrating custom write checkpoint requests against a Node.js backend.

## Installation

Add

```swift
    dependencies: [
        ...
        .package(url: "https://github.com/powersync-ja/powersync-swift", from: "1.0.0")
    ],
    targets: [
        .target(
            name: "YourTargetName",
            dependencies: [
                ...
                .product(
                    name: "PowerSync",
                    package: "powersync-swift"
                ),
                // Optional: Add if using GRDB
                .product(
                    name: "PowerSyncGRDB",
                    package: "powersync-swift"
                )
            ]
        )
    ]
```

to your `Package.swift` file.

## Usage

### Basic PowerSync Setup

```swift
import PowerSync

let mySchema = Schema(
    tables: [
        Table(
            name: "users",
            columns: [
                .text("count"),
                .integer("is_active"),
                .real("weight"),
                .text("description")
            ]
        )
    ]
)

let powerSync = PowerSyncDatabase(
    schema: mySchema,
    logger: DefaultLogger(minSeverity: .debug)
)
```

### GRDB Integration

If you're using [GRDB.swift](https://github.com/groue/GRDB.swift) by [Gwendal Roué](https://github.com/groue), you can integrate PowerSync with your existing database. Special thanks to Gwendal for their help in developing this integration.

**⚠️ Note:** The GRDB integration is currently in **alpha** release and the API may change significantly. While functional, it should be used with caution in production environments.

```swift
import PowerSync
import PowerSyncGRDB
import GRDB

// Configure GRDB with PowerSync support
var config = Configuration()
try config.configurePowerSync(schema: mySchema)

// Create database with PowerSync enabled
let dbPool = try DatabasePool(
    path: dbPath,
    configuration: config
)

let powerSync = try openPowerSyncWithGRDB(
    pool: dbPool,
    schema: mySchema,
    identifier: "app-db.sqlite"
)
```

Feel free to use the `DatabasePool` for view logic and the `PowerSyncDatabase` for PowerSync operations.

#### Limitations

- Updating the PowerSync schema, with `updateSchema`, is not currently fully supported with GRDB connections.
- This integration currently requires statically linking PowerSync and GRDB.
- This implementation requires defining the PowerSync Schema and GRDB data types. This results in some duplication.

## Attachments

See the attachments [README](./Sources/PowerSync/attachments/README.md) for more information.

## XCode Previews

XCode previews currently fail to load in a reasonable time after adding PowerSync to an XCode project. XCode requires dynamic linking for previews. This is enabled by enabling `ENABLE_DEBUG_DYLIB` in the XCode project. It seems like the previews fail to load due to PowerSync providing a `binaryTarget` which is linked statically by default.

XCode previews can be enabled by either:

Enabling `Editor -> Canvas -> Use Legacy Previews Execution` in XCode.

Or adding the `PowerSyncDynamic` product when adding PowerSync to your project. This product will assert that PowerSync should be dynamically linked, which restores XCode previews.

powersync-swift

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

powersync-swift

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README