arrow-left Back to Announcements
DATE:
AUTHOR:
PowerSync Product Team
Swift SDK

PowerSync Swift SDK: v1.6.0

DATE:
AUTHOR: PowerSync Product Team

We are excited to announce the Version 1.6.0 release of the PowerSync Swift client SDK

Visit the full SDK reference to get started, for implementation details, and code snippets.

See the full changelog below.

Have any questions or feedback? Chat with us and the PowerSync community on Discord.

Changelog

1.6.0

  • [ADDED] The getCrudTransactions() API to upload multiple transactions in a batch. (PR #245)

  • [IMPROVED] [Attachment Helpers] Makes the attachment system recover from cases where re-installing the app changes absolute paths on iOS simulators. (PR #80)

  • [IMPROVED] Updated the powersync-sqlite-core extension to v0.4.6. (changelog)

  • [IMPROVED] Additional compatibility with new Swift 6.2 / XCode 26 concurrency checks.

  • [IMPROVED] Updates the Kotlin SDK build to 1.6.0 which establishes a foundation on which we can add libraries such as SQLCipher for encryption in the future. (PR #230)

1.5.1

  • [IMPROVED] Additional Swift 6 Strict Concurrency Checking declarations added for remaining protocols. (PR #71)

  • [FIXED] An issue in the legacy sync client where local writes made offline could have their upload delayed until a keep-alive event was received. This could also cause downloaded updates to be delayed even further until all uploads were completed. (PR #255)

  • [IMPROVED] Updated the powersync-sqlite-core extension to v0.4.5. (changelog)

1.5.0

  • [ADDED] Support for strict concurrency checking for Swift 6. (PR #70)

    • Accepted query parameter types have been updated from [Any] to [Sendable]. This should cover all supported query parameter types.

    • Query and lock methods' return Result generic types now should extend Sendable.

    • Deprecated default open class PowerSyncBackendConnector. Developers should preferably implement the PowerSyncBackendConnectorProtocol.

    • [BREAKING CHANGE FOR ATTACHMENTS] Attachment helpers have also been updated to better support strict concurrency checking. If you currently customize or extend AttachmentQueue you will need to update your implementation to extend AttachmentQueueProtocol instead. The default instantiation of AttachmentQueue remains unchanged. See the README for details.

  • [IMPROVED] Lock error handling and reporting by adding some additional helpers to the PowerSyncKotlin module. (PR #69)

  • [FIXED] null values in CRUD entries being reported as "null" strings. (PR #69)

  • [FIXED] XCode preview functionality is now restored. (PR #71)

  • [INTERNAL] Updated the Kotlin Kermit logger instantiation to be performed directly in the Swift Adapter. (PR #67)

1.4.0

  • [ADDED] Support for configuring the Ktor networking client. (PR #63)

  • [IMPROVED] Updated the powersync-sqlite-core extension to v0.4.4. This fixes a regression in 0.4.3. (PR #65)

1.3.1

  • [ADDED] Support receiving binary sync lines over HTTP when the Rust client is enabled. (PR #232)

  • [IMPROVED] Updated SQLite to 3.50.3.

  • [IMPROVED] Remove the experimental WebSocket transport mode which proved unstable. (PR #232)

1.3.0

  • [ADDED] Support for raw tables, which are custom tables managed by the user instead of JSON-based views managed by the SDK.

  • [IMPROVED]Updated the powersync-sqlite-core extension to v0.4.2, which improves the reliability of the new Rust sync client implementation.

  • [FIXED] Attachments never downloading again when the sandbox path of the app (e.g. on the simulator) changes.

1.2.1

  • [ADDED] Initial watchOS support. Currently this has not been tested on actual devices, we encourage this and feedback from the community!

  • [IMPROVED] Updated the powersync-sqlite-core extension to v0.4.1, which fixes an issue with the new Rust-based sync client implementation.

  • [FIXED] CRUD uploads when WebSockets are used as a connection method.

1.2.0

  • [ADDED] A new sync client implementation written in Rust instead of Kotlin/Swift. While this client is still
    experimental, we intend to make it the default in the future. The main benefit of this client is
    faster sync performance, but upcoming features will also require this client. We encourage
    interested users to try it out by opting in to experimental APIs and passing options when
    connecting:

    @_spi(PowerSyncExperimental) import PowerSync

try await db.connect(connector: connector, options: ConnectOptions(
    newClientImplementation: true,
))

    Switching between the clients can be done at any time without compatibility issues. If you run
    into issues with the new client, please reach out to us!

  • [IMPROVED] CrudBatch and CrudTransaction complete function extensions. Developers no longer need to specify nil as an argument for writeCheckpoint when calling CrudBatch.complete. The base complete functions still accept an optional writeCheckpoint argument if developers use custom write checkpoints.

guard let finalBatch = try await powersync.getCrudBatch(limit: 100) else {
  return nil
}
- try await batch.complete(writeCheckpoint: nil)
+ try await batch.complete()

  • [IMPROVED] Updated the powersync-sqlite-core extension to v0.4.0, which improves sync performance.

  • [IMPROVED] In addition to HTTP streams, the Swift SDK also supports fetching sync instructions from the
    PowerSync service in a binary format. This requires the new sync client, and can then be enabled
    on the sync options:

    @_spi(PowerSyncExperimental) import PowerSync

try await db.connect(connector: connector, options: ConnectOptions(
    newClientImplementation: true,
    connectionMethod: .webSocket,
))

  • [FIXED] Reported progress around compactions / defrags on the sync service.

1.1.0

  • [ADDED] Report real-time progress information about downloads through SyncStatus.downloadProgress.

  • [ADDED] Exposed new table options allowing for more granular control over update tracking and metadata.

    • trackPreviousValues: Populates CrudEntry.previousValues, so you can see both the old and new values during an update.

    • trackMetadata: Adds a _metadata column to the table. Use this to store any custom metadata for uploads—accessible via CrudEntry.metadata.

    • ignoreEmptyUpdates: Skips generating CRUD entries when no data actually changes—reduces noise in uploadData.

1.0.0

  • This SDK is now in a stable V1 release

  • [BREAKING CHANGES]

    • Completing CRUD transactions or CRUD batches, in the PowerSyncBackendConnector uploadData handler, now has a simpler invocation.

    • index based SqlCursor getters now throw if the query result column value is nil. This is now consistent with the behaviour of named column getter operations. New getXxxxxOptional(index: index) methods are available if the query result value could be nil.

    • SqlCursor getters now directly return Swift types. getLong has been replaced with getInt64.

    • Client parameters now need to be specified with strictly typed JsonValue enums.

    • SyncStatus values now use Swift primitives for status attributes. lastSyncedAt now is of Date type.

    • crudThrottleMs and retryDelayMs in the connect method have been updated to crudThrottle and retryDelay which are now of type TimeInterval. Previously the parameters were specified in milliseconds, the TimeInterval typing now requires values to be specified in seconds.

    • throttleMs in the watched query WatchOptions has been updated to throttle which is now of type TimeInterval. Previously the parameters were specified in milliseconds, the TimeInterval typing now requires values to be specified in seconds.

    • See code snippets here for all of the above.

  • [IMPROVED] Improved the stability of watched queries. Watched queries were previously susceptible to runtime crashes if an exception was thrown in the update stream. Errors are now gracefully handled.

  • [IMPROVED] Deprecated PowerSyncCredentials userId field. This value is not used by the PowerSync service.

  • [IMPROVED] Removed references to the PowerSync Kotlin SDK from all public API protocols. Dedicated Swift protocols are now defined. These protocols align better with Swift primitives. See the BREAKING CHANGES section above for more details, and see here for the complete list of updated protocols.

  • [IMPROVED] Database and transaction/lock level query execute methods now have @discardableResult annotation.

  • [IMPROVED] Query methods' parameters typing has been updated to [Any?] from [Any]. This makes passing nil or optional values to queries easier.

  • [IMPROVED] AttachmentContext, AttachmentQueue, AttachmentService and SyncingService are are now explicitly declared as open classes, allowing them to be subclassed outside the defining module.

  • [ADDED] Added readLock and writeLock APIs. These methods allow obtaining a SQLite connection context without starting a transaction.

1.0.0-Beta.12

  • [ADDED] Introduced attachment sync helpers and a demo to showcase these. Learn how to get started here.

  • [FIXED] Cancellations in watched queries are now handled correctly.

1.0.0-Beta.11

  • [FIXED] Deadlock issue when connect() is called immediately after opening a database (introduced in 1.0.0-Beta.10).

1.0.0-Beta.10

  • [ADDED] The ability to enable custom logging. See docs here.

  • [ADDED] .close() method on PowerSyncDatabaseProtocol to close a database connection.

  • [FIXED] Updated the powersync-kotlin dependency to version 1.0.0-BETA29, which fixes these issues:

    • Fixed a potential race condition between jobs in connect() and disconnect().

    • Fixed a race condition causing data received during uploads not to be applied.

    • Fixed an issue where automatic driver migrations would fail with the error: Sqlite operation failure database is locked attempted to run migration and failed. closing connection

1.0.0-Beta.9

  • [ADDED] Enabled Full Text Search on iOS platforms. An example implementation is not yet available, however our JavaScript implementations can be used as a guide in the mean time, or reach out to us on Discord. (PR #145)

  • [ADDED] For advanced use cases: The ability to update the schema for existing PowerSync clients using updateSchema(). (PR #154)

  • [IMPROVED] Unified concurrency model across platforms by introducing a pool of read connections and a single write connection, simplifying driver implementation and enabling concurrent reads. This also brings the architecture in line with other PowerSync SDKs. (PR #145)

  • [IMPROVED] Added queuing protection and warnings when connecting multiple PowerSync clients to the same database file, avoiding inconsistent state issues and improving the reliability of watched queries. (PR #146)

  • [IMPROVED] Switched to statically linking SQLite on native platforms since dynamic extension loading is disabled on Apple platforms. (PR #147)

  • [FIXED] A bug where local only, insert only and view name overrides were not applied for schema tables. (PR #154)

  • [FIXED] Updated powersync-sqlite-core to v0.3.12, which fixes powersync_last_synced_at() returning stale information. 

1.0.0-Beta.8

  • [ADDED] Support for sync bucket priorities to sync critical data first. Learn more.

  • [ADDED] The ability to throttle watched queries via the optional throttleMs parameter. This will prevent these queries from re-running within the specified duration and therefore reduce the load for frequently updating tables.

  • [IMPROVED] Internally improved the query logic for watch() queries, by optimizing table update handling, enhancing thread safety, and simplifying the implementation (see the PR).

  • [FIXED] The uploading and downloading Sync Status indicators not correctly emitting status events.

1.0.0-Beta.7

  • [FIXED] An issue where throwing exceptions in the query mapper could cause a runtime crash.

  • [IMPROVED] Internally improved type casting.

  • [IMPROVED] Internals of the watch() query.

1.0.0-Beta.6

  • [BREAKING CHANGE]: watch queries are now throwable and therefore will need to be accompanied by a try e.g.

try database.watch()

  • [BREAKING CHANGE]: transaction functions are now throwable and therefore will need to be accompanied by a try e.g.

try await database.writeTransaction { transaction in
  try transaction.execute(...)
}

  • [IMPROVED] Allow execute errors to be handled

  • [IMPROVED]userId is now set to nil by default and therefore it is no longer required to be set to nil when instantiating PowerSyncCredentials and can therefore be left out.

1.0.0-Beta.5

  • [IMPROVED] Error handling for errors originating in the Kotlin SDK.

  • [IMPROVED] __fetchCredentials to log the error but not cause an app crash on error.

1.0.0-Beta.4

  • [IMPROVED] Ability to use the column name to get the pertaining value when using the cursor instead of having to use the index number. The following functions now accept a column name parameter: getBoolean,getBooleanOptional,getString,getStringOptional, getLong,getLongOptional, getDouble,getDoubleOptional.

  • BREAKING CHANGE: This should not affect anyone, but we made KotlinPowerSyncCredentials, KotlinPowerSyncDatabase and KotlinPowerSyncBackendConnector private as these should never have been public.

1.0.0-Beta.3

  • BREAKING CHANGE: Updates the underlying powersync-kotlin package to BETA18.0 which requires transactions to become synchronous as opposed to asynchronous.

    • Previously:

      try await database.writeTransaction { transaction in
  try await transaction.execute(
    sql: "INSERT INTO users (id, name, email) VALUES (?, ?, ?)",
    parameters: ["1", "Test User", "test@example.com"]
  )
}

      Now:

      try await database.writeTransaction { transaction in
  transaction.execute( // <- This has become synchronous
    sql: "INSERT INTO users (id, name, email) VALUES (?, ?, ?)",
    parameters: ["1", "Test User", "test@example.com"]
  )
}

1.0.0-Beta.2

  • [FIXED] Updated powersync-sqlite-core to v0.3.8, which fixes a view migration issue (see details).

  • [IMPROVED] Increase maximum amount of columns from 63 to 1999.

1.0.0-Beta.1

Powered by LaunchNotes