ObjectBox Swift Database Docs

Welcome to the official documentation for the ObjectBox Swift SDK. To get started right away go to:

Your opinion matters to us! To make ObjectBox better for our users, we have set up an Anonymous Feedback Form. Please do fill this in (it only takes 2 minutes). Every response is highly appreciated. To rate this documentation, you can use the "Was this page helpful?" smiley at the end of each page.

Otherwise, feel free to open an issue on GitHub or send us your comments to contact[at]objectbox.io - Thank you! - and if you like what you see, we also appreciate a shout-out :)

ObjectBox Swift Changelog

For the latest changes in the objectbox-swift repository.

Old releases

1.9.2 - 2023-11-14

• Built with Xcode 15.0.1 and Swift 5.9.

• Update to .

• Include debug symbols for the ObjectBox Swift library.

1.9.1 - 2023-11-21

• Built with Xcode 15.0.1 and Swift 5.9.

• Fix incorrect flags getting generated in the model JSON for to-one properties.

• setup.rb: Changed configured build phase for ObjectBox generator to always run to remove warning due to no build phase inputs being configured (as the script can not know which source code files contain entities).

1.9.0 - 2023-09-19

• Built with Xcode 14.3.1 and Swift 5.8.1 (Xcode 14.3.1 or higher recommended)

• Update to

  • Queries: all expected results are now returned when using a less-than or less-or-equal condition for a String property with index type VALUE

1.8.1 - 2023-01-30

Highly recommended bugfix release; please update.

• Build with Xcode 14.2 and Swift 5.7.2 (Xcode 14.2 or higher recommended)

• Fixes "Could not put (-30786)", which may occur in some corner cases on some OSes (ARM based).

1.8.0 - 2022-12-13

• Build with Xcode 14.1 and Swift 5.7.1 (Xcode 14.1 or higher recommended)

• Many internal improvements (see versions 0.16 to 0.18)

• Note: the targeted macOS version was increased from 10.10 to 10.13. Alternatively, you can use version 1.8.1-rc for a podspec targeting 10.11 (still linked for 10.13).

1.7.0 - 2022-02-22

• Unique properties can now be annotated to replace objects "on conflict" (e.g. useful for a secondary key).

• Attaching to previously opened stores (using just the directory path)

• DateNano type (a date stored with nanosecond precision; default is milliseconds)

1.6.0 - 2021-05-13

• Experimental Swift Package Manager (SPM) support; added 2021-06-02

• Build with Xcode 12.5 and Swift 5.4

• Updated Sync protocol to V3

1.5.0 - 2021-05-03

• Added support for Apple Silicon (e.g. M1 ARM64-based CPU)

• Switched packaging to XCFramework (note: this will help us with SwiftPM in the future, but currently breaks Carthage consumers)

• Several updates to the Sync API

1.4.1 - 2020-11-10

• Several internal improvements under the hood; an indirect consequence is that Foundation is not implicitly imported anymore (you may have to add Foundation imports after upgrading)

• New sync annotation

• Build target for macOS set to 10.10 (was undefined before)

1.4.0 - 2020-09-08

See also:

• ToMany improvements

  • applyToDb() now puts new objects automatically; you do not have to put them individually anymore

  • New properties to probe the state: resolved

1.3.1 - 2020-06-29

• Fixes for ToMany

• Several internal improvements, e.g. query links are resolved faster

1.3.0 - 2020-05-11

• Built with and for Swift 5.2

• Fix sporadic "errno 12" while opening a DB on iOS devices

• Lower deployment target to iOS 9.3 (seems to be still used by older iPads)

1.2.0 - 2019-12-17

• Added support for optional unsigned property types

• Better type support for queries; e.g. unsigned and optional properties, Bool properties

• Property queries compute sums and averages more precisely (improved algorithms and wider types)

1.1.1 - 2019-11-23

Fix for the 1.1 "realpath" error during build on machines without Homebrew coreutils.

1.1 - 2019-11-18

• Experimental Carthage support (in addition to CocoaPods)

• If a convert annotation on an enum has no explicit database type given, its RawType is used.

• Various performance optimizations

1.0.1 - 2019-10-01

• Fix bug that prevented code generator from working in projects that use SwiftPM

1.0 - 2019-09-24

• Relations in queries

• Observer callbacks for data changes

• Many-to-many relations

0.9.1 - 2019-08-13

iOS hotfix

• Fixed "Storage error code 78" for iOS

0.9.0 - 2019-07-22

Open Source Release

• Source code for the Swift binding is now available

• Reduced write/update time by about 25%

• Rewrote the remaining Objective-C classes in Swift

0.8.0 - 2019-05-14

Struct Support and Performance Improvements

• Immutable , you are no longer restricted to classes

• We no longer throw NSError-based errors, they're all enum ObjectBoxError cases now

• Strings that were created as

0.7.0 - 2019-04-02

Swift 5 and Build Improvements

• Binaries: Swift 5 ABI only

• ObjectBox setup script can now also be

• ObjectBox can now be

0.6.0 - 2018-12-19

Model Migration

• Your data model is now when you make changes

• Properties can be

• You can require property fields to be

0.5.5 - 2018-11-29

Alpha 6

• Remove code-generator limitations regarding order of properties vs. relations

• Support sandboxed macOS applications ()

• Add "transient" annotation for skipping properties

0.5.4 - 2018-11-27

Alpha 5

• Code generation fixes for optionals

• Expanded example app to demo optionals

• Fixes for Date-decoding into entities

0.5.3 - 2018-11-26

Cleanup

• Just small things. Also an elephant.

0.5.2 - 2018-11-22

iOS Sandboxing.

• Fixed issues that could occur when deploying to device.

• Added auto-registration of your entities

0.5.1 - 2018-11-19

Alpha 2

• Fix an issue related to "duplicate index ID" error message.

0.5.0 - 2018-11-16

Alpha 1

• Initial public release for comment.