ObjectBox Swift
objectbox.ioBlogTwitterGitHub
  • ObjectBox Swift Database Docs
  • Install ObjectBox Swift
  • Get Started with ObjectBox Swift
  • Entity Annotations in ObjectBox
  • Queries
  • Relations
  • Transactions
  • ObjectBox Swift FAQ
  • Swift API Docs
  • Advanced
    • The Sandbox on macOS
    • Enums and Custom Types
    • Data Model Updates
    • Meta Model, IDs and UIDs
    • Manual Installation
    • The setup.rb Script
    • Customizing Code Generation
  • Data Sync
  • Android Database
  • Flutter Database
Powered by GitBook
On this page
  • Download
  • Add the Framework to your Project
  • Setup Script
  • Done

Was this helpful?

Export as PDF
  1. Advanced

Manual Installation

If you aren't using CocoaPods, ObjectBox can easily be installed manually. Just download, add the framework to your project, and run our setup script.

PreviousMeta Model, IDs and UIDsNextThe setup.rb Script

Last updated 4 days ago

Was this helpful?

Download

You can get the newest ObjectBox-xcframework-<version>.zip from page:

Unpack the ZIP-archive and put the entire folder somewhere in your project's folder (for example, if your project is in /Users/vivien/RecordsDatabase/RecordsDatabase.xcodeproj, you could put ObjectBox at /Users/vivien/RecordsDatabase/ObjectBox ).

Add the Framework to your Project

Like with any embedded framework, you link to it and copy it into your application:

  • Find the ObjectBox.framework for the platform of your application from the ObjectBox.xcframework folder.

  • Open your project's target settings by clicking the little blue project icon at the top of the Project Navigator in Xcode.

  • Select the General tab for your target and find the Frameworks, Libraries and Embedded Content section.

  • Drag the ObjectBox.framework into the list and choose "Embed & Sign" from the popup at its right.

  • macOS and Xcode 10 and earlier only:

    • Go to the Build Phases tab and add a Copy Files build phase.

    • Select Frameworks as the Destination from the popup.

    • Drag the ObjectBox.framework into it.

You're done, your project is linking to ObjectBox.

Setup Script

Then open Terminal and run

gem install xcodeproj /path/to/ObjectBox/setup.rb /path/to/MyProject.xcodeproj

where /path/to/ is again where your project is, like /Users/vivien/RecordsDatabase/ above.

The xcodeproj gem is only needed by the installation script to do its work. It's not required to build your application.

Done

You can now open your project and .

follow the rest of this tutorial
our GitHub Releases
Latest ObjectBox Swift GitHub release with XCFramework download highlighted