ObjectBox Reference

<!DOCTYPE html> <html lang="en"> <head> <title>ObjectBox Reference</title> <link rel="stylesheet" type="text/css" href="css/jazzy.css" /> <link rel="stylesheet" type="text/css" href="css/highlight.css" /> <meta charset='utf-8'> <script src="js/jquery.min.js" defer></script> <script src="js/jazzy.js" defer></script> </head> <body> <a title="ObjectBox Reference"></a> <header> <div class="content-wrapper"> <p><a href="index.html">ObjectBox Docs</a> (81% documented)</p> <p class="header-right"><a href="https://github.com/objectbox/objectbox-swift"><img src="img/gh.png"/>View on GitHub</a></p> <p class="header-right"><a href="dash-feed://https%3A%2F%2Fobjectbox.io%2Fdocfiles%2Fswift%2Fcurrent%2Fdocsets%2FObjectBox.xml"><img src="img/dash.png"/>Install in Dash</a></p> </div> </header> <div class="content-wrapper"> <p id="breadcrumbs"> <a href="index.html">ObjectBox Reference</a> <img id="carat" src="img/carat.png" /> ObjectBox Reference </p> </div> <div class="content-wrapper"> <nav class="sidebar"> <ul class="nav-groups"> <li class="nav-group-name"> <a href="Core.html">Core</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Classes/Store.html">Store</a> </li> <li class="nav-group-task"> <a href="Classes/Box.html">Box</a> </li> <li class="nav-group-task"> <a href="Core.html#/s:9ObjectBox6EntityP">Entity</a> </li> <li class="nav-group-task"> <a href="Core.html#/s:9ObjectBox2Ida">Id</a> </li> <li class="nav-group-task"> <a href="Structs/Property.html">Property</a> </li> </ul> </li> <li class="nav-group-name"> <a href="Relations.html">Relations</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Classes/ToOne.html">ToOne</a> </li> <li class="nav-group-task"> <a href="Classes/ToMany.html">ToMany</a> </li> </ul> </li> <li class="nav-group-name"> <a href="Query.html">Query</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="query-syntax.html">Query Syntax</a> </li> <li class="nav-group-task"> <a href="Classes/Query.html">Query</a> </li> <li class="nav-group-task"> <a href="Classes/PropertyQuery.html">PropertyQuery</a> </li> <li class="nav-group-task"> <a href="Classes/PropertyQueryCondition.html">PropertyQueryCondition</a> </li> <li class="nav-group-task"> <a href="Classes/QueryCondition.html">QueryCondition</a> </li> <li class="nav-group-task"> <a href="Classes/PropertyAlias.html">PropertyAlias</a> </li> </ul> </li> <li class="nav-group-name"> <a href="Sync.html">Sync</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Classes/Sync.html">Sync</a> </li> <li class="nav-group-task"> <a href="Protocols/SyncClient.html">SyncClient</a> </li> <li class="nav-group-task"> <a href="Classes/SyncCredentials.html">SyncCredentials</a> </li> </ul> </li> <li class="nav-group-name"> <a href="Other%20Classes.html">Other Classes</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Classes/AsyncBox.html">AsyncBox</a> </li> <li class="nav-group-task"> <a href="Classes/BoxPublisher.html">BoxPublisher</a> </li> <li class="nav-group-task"> <a href="Classes/EntityBuilder.html">EntityBuilder</a> </li> <li class="nav-group-task"> <a href="Classes/EntityInfo.html">EntityInfo</a> </li> <li class="nav-group-task"> <a href="Classes/FlatBufferBuilder.html">FlatBufferBuilder</a> </li> <li class="nav-group-task"> <a href="Classes/IdWithScore.html">IdWithScore</a> </li> <li class="nav-group-task"> <a href="Classes/ModelBuilder.html">ModelBuilder</a> </li> <li class="nav-group-task"> <a href="Classes/ObjectWithScore.html">ObjectWithScore</a> </li> <li class="nav-group-task"> <a href="Classes/Observer.html">Observer</a> </li> <li class="nav-group-task"> <a href="Classes/Observer/Flags.html">– Flags</a> </li> <li class="nav-group-task"> <a href="Classes/PropertyBuilder.html">PropertyBuilder</a> </li> <li class="nav-group-task"> <a href="Classes/QueryBuilder.html">QueryBuilder</a> </li> <li class="nav-group-task"> <a href="Classes/QueryPublisher.html">QueryPublisher</a> </li> </ul> </li> <li class="nav-group-name"> <a href="Other%20Enums.html">Other Enumerations</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Enums/DebugFlags.html">DebugFlags</a> </li> <li class="nav-group-task"> <a href="Enums/EntityFlags.html">EntityFlags</a> </li> <li class="nav-group-task"> <a href="Enums/HnswDistanceType.html">HnswDistanceType</a> </li> <li class="nav-group-task"> <a href="Enums/HnswFlags.html">HnswFlags</a> </li> <li class="nav-group-task"> <a href="Enums/ObjectBoxError.html">ObjectBoxError</a> </li> <li class="nav-group-task"> <a href="Enums/OrderFlags.html">OrderFlags</a> </li> <li class="nav-group-task"> <a href="Enums/PropertyFlags.html">PropertyFlags</a> </li> <li class="nav-group-task"> <a href="Enums/PropertyType.html">PropertyType</a> </li> <li class="nav-group-task"> <a href="Enums/PutMode.html">PutMode</a> </li> <li class="nav-group-task"> <a href="Enums/PutPaddingMode.html">PutPaddingMode</a> </li> <li class="nav-group-task"> <a href="Enums/RequestUpdatesMode.html">RequestUpdatesMode</a> </li> <li class="nav-group-task"> <a href="Enums/SuccessTimeOut.html">SuccessTimeOut</a> </li> <li class="nav-group-task"> <a href="Enums/SyncCode.html">SyncCode</a> </li> <li class="nav-group-task"> <a href="Enums/SyncCredentialsType.html">SyncCredentialsType</a> </li> <li class="nav-group-task"> <a href="Enums/SyncState.html">SyncState</a> </li> <li class="nav-group-task"> <a href="Enums/ValidateOnOpenMode.html">ValidateOnOpenMode</a> </li> </ul> </li> <li class="nav-group-name"> <a href="Other%20Extensions.html">Other Extensions</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Other%20Extensions.html#/s:9ObjectBox2Ida">Id</a> </li> <li class="nav-group-task"> <a href="Other%20Extensions.html#/s:s5Int64V">Int64</a> </li> </ul> </li> <li class="nav-group-name"> <a href="Other%20Functions.html">Other Functions</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Other%20Functions.html#/s:9ObjectBox2zeoiyAA13PropertyAliasCyxq_GSS_AA0D14QueryConditionCyxq_GtAA17EntityInspectableRzAA02__H9RelatableRz0H11BindingTypeAaIP_0hL0QZRszAA0hdL11ConvertibleR_r0_lF">.=(_:_:)</a> </li> <li class="nav-group-task"> <a href="Other%20Functions.html#/s:9ObjectBox003jJgoiyAA22PropertyQueryConditionCyxq_GAA0C0Vyxq_SgytG_Sayq_GtAA17EntityInspectableRzAA02__F9RelatableRz0F11BindingTypeAaKP_0fJ0QZRszAA0fcJ11ConvertibleR_s17FixedWidthIntegerR_r0_lF">∈(_:_:)</a> </li> <li class="nav-group-task"> <a href="Other%20Functions.html#/s:9ObjectBox003jJgoiyAA22PropertyQueryConditionCyxq_GAA0C0Vyxq_ytG_Sayq_GtAA17EntityInspectableRzAA02__F9RelatableRz0F11BindingTypeAaJP_0fJ0QZRszAA0fcJ11ConvertibleR_s17FixedWidthIntegerR_r0_lF">∈(_:_:)</a> </li> </ul> </li> <li class="nav-group-name"> <a href="Other%20Protocols.html">Other Protocols</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Protocols/EntityBinding.html">EntityBinding</a> </li> <li class="nav-group-task"> <a href="Protocols/EntityInspectable.html">EntityInspectable</a> </li> <li class="nav-group-task"> <a href="Protocols/IdBase.html">IdBase</a> </li> <li class="nav-group-task"> <a href="Other%20Protocols.html#/s:9ObjectBox18SyncChangeListenerP">SyncChangeListener</a> </li> <li class="nav-group-task"> <a href="Protocols/SyncCompletedListener.html">SyncCompletedListener</a> </li> <li class="nav-group-task"> <a href="Protocols/SyncConnectionListener.html">SyncConnectionListener</a> </li> <li class="nav-group-task"> <a href="Other%20Protocols.html#/s:9ObjectBox12SyncListenerP">SyncListener</a> </li> <li class="nav-group-task"> <a href="Protocols/SyncLoginListener.html">SyncLoginListener</a> </li> <li class="nav-group-task"> <a href="Other%20Protocols.html#/s:9ObjectBox13UntypedIdBaseP">UntypedIdBase</a> </li> </ul> </li> <li class="nav-group-name"> <a href="Other%20Structs.html">Other Structures</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Structs/EntityId.html">EntityId</a> </li> <li class="nav-group-task"> <a href="Structs/FlatBufferReader.html">FlatBufferReader</a> </li> <li class="nav-group-task"> <a href="Other%20Structs.html#/s:9ObjectBox10SyncChangeV">SyncChange</a> </li> <li class="nav-group-task"> <a href="Structs/ToManyProperty.html">ToManyProperty</a> </li> <li class="nav-group-task"> <a href="Structs/ToManyProperty/ToManyId.html">– ToManyId</a> </li> </ul> </li> <li class="nav-group-name"> <a href="Other%20Typealiases.html">Other Type Aliases</a> <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="Other%20Typealiases.html#/s:9ObjectBox13ValuePropertya">ValueProperty</a> </li> </ul> </li> <li class="nav-group-name"> Links <ul class="nav-group-tasks"> <li class="nav-group-task"> <a href="https://objectbox.io">objectbox.io</a> </li> <li class="nav-group-task"> <a href="https://swift.objectbox.io">Guides</a> </li> <li class="nav-group-task"> <a href="https://github.com/objectbox/objectbox-swift">ObjectBox Github</a> </li> </ul> </li> </ul> </nav> <article class="main-content"> <section> <section class="section">  <div class="objectboxlogo-container"> <a href="https://objectbox.io/"><img id="objectboxlogo" src="img/logo.png" alt="ObjectBox Logo" title="" /></a> </div> <p><a href="https://github.com/objectbox/objectbox-swift">ObjectBox Swift</a> is a superfast, light-weight object persistence framework for iOS and macOS.</p> <p>This is the ObjectBox Swift <strong>API reference</strong>. Check <strong><a href="https://swift.objectbox.io/">the documentation</a></strong> on how to install and use ObjectBox Swift.</p> <p>This documents API version: 4.0.0</p> <h2 id='most-important-types' class='heading'>Most Important Types</h2> <ul> <li><code><a href="Classes/Store.html">Store</a></code>: database entry point and source of <code><a href="Classes/Box.html">Box</a></code>es.</li> <li><code><a href="Classes/Box.html">Box</a></code>: main interface to persist objects and create <code><a href="Classes/Query.html">Query</a></code>s.</li> <li><code><a href="Core.html#/s:9ObjectBox6EntityP">Entity</a></code>: protocol to mark your type as persistable by ObjectBox.</li> <li><code><a href="Core.html#/s:9ObjectBox2Ida">Id</a></code>: identifies object instances in the database.</li> <li><code><a href="Classes/Query.html">Query</a></code>: conditional fetching of objects of a certain type.</li> </ul> <h2 id='please-let-us-know-your-feedback' class='heading'>Please let us know your feedback</h2> <p>We want ObjectBox to be not only the fastest, but also the most Swift-friendly persistence solution.</p> <p>To do that, we want your feedback: what do you love? What’s amiss? Where do you struggle in everyday app development?</p> <p>We’re looking forward to receiving your comments and requests:</p> <ul> <li>Take this <a href="https://docs.google.com/forms/d/e/1FAIpQLSd0neiviD0Yal0Tn7921w-XWI2d0ONpLm7TfVKp7OvwW2Tu2A/viewform?usp=sf_link">short questionaire</a> (takes only 1 or 2 minutes)</li> <li>Add <a href="https://github.com/objectbox/objectbox-swift/issues">GitHub issues</a> and</li> <li>Upvote issues you find important by hitting the 👍/+1 reaction button!</li> </ul> <p>Thank you!</p> <h2 id='keep-in-touch' class='heading'>Keep in touch</h2> <p>For general news on ObjectBox, <a href="https://objectbox.io/blog">check our blog</a> or follow <a href="https://twitter.com/ObjectBox_io/">@ObjectBox_io</a> on Twitter.</p> </section> </section> <section id="footer"> <p>© 2024 <a class="link" href="https://objectbox.io" target="_blank" rel="external noopener">ObjectBox</a>. All rights reserved. (Last updated: 2024-07-30)</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.15.1</a>.</p> </section> </article> </div> </body> </div> </html>

CINXE.COM

ObjectBox Reference