Classes
The following classes are available globally.
-
Provider client for user API keys.
See moreDeclaration
Objective-C
@interface RLMAPIKeyAuth : RLMProviderClient
Swift
class RLMAPIKeyAuth : RLMProviderClient
-
Properties representing the configuration of a client that communicate with a particular Realm application.
See moreDeclaration
Objective-C
@interface RLMAppConfiguration : NSObject
Swift
class RLMAppConfiguration : NSObject
-
The
RLMApp
has the fundamental set of methods for communicating with a Realm application backend.This interface provides access to login and authentication.
See moreDeclaration
Objective-C
@interface RLMApp : NSObject
Swift
class RLMApp : NSObject
-
RLMArray
is the container type in Realm used to define to-many relationships.Unlike an
NSArray
,RLMArray
s hold a single type, specified by theobjectClassName
property. This is referred to in these docs as the “type” of the array.When declaring an
RLMArray
property, the type must be marked as conforming to a protocol by the same name as the objects it should contain (see theRLM_ARRAY_TYPE
macro). In addition, the property can be declared using Objective-C generics for better compile-time type safety.RLM_ARRAY_TYPE(ObjectType) ... @property RLMArray<ObjectType *><ObjectType> *arrayOfObjectTypes;
RLMArray
s can be queried with the same predicates asRLMObject
andRLMResult
s.RLMArray
s cannot be created directly.RLMArray
properties onRLMObject
s are lazily created when accessed, or can be obtained by querying a Realm.Key-Value Observing
RLMArray
supports array key-value observing onRLMArray
properties onRLMObject
subclasses, and theinvalidated
property onRLMArray
instances themselves is key-value observing compliant when theRLMArray
is attached to a managedRLMObject
(RLMArray
s on unmanagedRLMObject
s will never become invalidated).Because
See moreRLMArray
s are attached to the object which they are a property of, they do not require using the mutable collection proxy objects from-mutableArrayValueForKey:
or KVC-compatible mutation methods on the containing object. Instead, you can call the mutation methods on theRLMArray
directly.Declaration
Objective-C
@interface RLMArray<RLMObjectType> : NSObject <RLMCollection, NSFastEnumeration>
Swift
class RLMArray<RLMObjectType> : NSObject, RLMCollection, NSFastEnumeration where RLMObjectType : AnyObject
-
MaxKey will always be the greatest value when comparing to other BSON types
Declaration
Objective-C
@interface RLMMaxKey : NSObject
Swift
class RLMMaxKey : NSObject
-
MinKey will always be the smallest value when comparing to other BSON types
Declaration
Objective-C
@interface RLMMinKey : NSObject
Swift
class RLMMinKey : NSObject
-
An
RLMSortDescriptor
stores a property name and a sort order for use withsortedResultsUsingDescriptors:
. It is similar toNSSortDescriptor
, but supports only the subset of functionality which can be efficiently run by Realm’s query engine.
See moreRLMSortDescriptor
instances are immutable.Declaration
Objective-C
@interface RLMSortDescriptor : NSObject
Swift
class RLMSortDescriptor : NSObject
-
A
RLMCollectionChange
object encapsulates information about changes to collections that are reported by Realm notifications.RLMCollectionChange
is passed to the notification blocks registered with-addNotificationBlock
onRLMArray
andRLMResults
, and reports what rows in the collection changed since the last time the notification block was called.The change information is available in two formats: a simple array of row indices in the collection for each type of change, and an array of index paths in a requested section suitable for passing directly to
UITableView
‘s batch update methods. A complete example of updating aUITableView
namedtv
:[tv beginUpdates]; [tv deleteRowsAtIndexPaths:[changes deletionsInSection:0] withRowAnimation:UITableViewRowAnimationAutomatic]; [tv insertRowsAtIndexPaths:[changes insertionsInSection:0] withRowAnimation:UITableViewRowAnimationAutomatic]; [tv reloadRowsAtIndexPaths:[changes modificationsInSection:0] withRowAnimation:UITableViewRowAnimationAutomatic]; [tv endUpdates];
All of the arrays in an
See moreRLMCollectionChange
are always sorted in ascending order.Declaration
Objective-C
@interface RLMCollectionChange : NSObject
Swift
class RLMCollectionChange : NSObject
-
Opaque credentials representing a specific Realm App user.
See moreDeclaration
Objective-C
@interface RLMCredentials : NSObject
Swift
class RLMCredentials : NSObject
-
A 128-bit IEEE 754-2008 decimal floating point number.
This type is similar to Swift’s built-in Decimal type, but allocates bits differently, resulting in a different representable range. (NS)Decimal stores a significand of up to 38 digits long and an exponent from -128 to 127, while this type stores up to 34 digits of significand and an exponent from -6143 to 6144.
See moreDeclaration
Objective-C
@interface RLMDecimal128 : NSObject
Swift
class RLMDecimal128 : NSObject
-
A client for the email/password authentication provider which can be used to obtain a credential for logging in, and to perform requests specifically related to the email/password provider.
See moreDeclaration
Objective-C
@interface RLMEmailPasswordAuth : RLMProviderClient
Swift
class RLMEmailPasswordAuth : RLMProviderClient
-
RLMEmbeddedObject
is a base class used to define Realm model objects.Embedded objects work similarly to normal objects, but are owned by a single parent Object (which itself may be embedded). Unlike normal top-level objects, embedded objects cannot be directly created in or added to a Realm. Instead, they can only be created as part of a parent object, or by assigning an unmanaged object to a parent object’s property. Embedded objects are automatically deleted when the parent object is deleted or when the parent is modified to no longer point at the embedded object, either by reassigning an RLMObject property or by removing the embedded object from the array containing it.
Embedded objects can only ever have a single parent object which links to them, and attempting to link to an existing managed embedded object will throw an exception.
The property types supported on
RLMEmbeddedObject
are the same as forRLMObject
, except for that embedded objects cannot link to top-level objects, soRLMObject
andRLMArray<RLMObject>
properties are not supported (RLMEmbeddedObject
andRLMArray<RLMEmbeddedObject>
are).Embedded objects cannot have primary keys or indexed properties.
See moreDeclaration
Objective-C
@interface RLMEmbeddedObject : RLMObjectBase <RLMThreadConfined>
Swift
class RLMEmbeddedObject : RLMObjectBase, RLMThreadConfined
-
Options to use when executing a
See morefindOneAndUpdate
,findOneAndReplace
, orfindOneAndDelete
command on aRLMMongoCollection
.Declaration
Objective-C
@interface RLMFindOneAndModifyOptions : NSObject
Swift
class RLMFindOneAndModifyOptions : NSObject
-
Options to use when executing a
See morefind
command on aRLMMongoCollection
.Declaration
Objective-C
@interface RLMFindOptions : NSObject
Swift
class RLMFindOptions : NSObject
-
RLMMigration
instances encapsulate information intended to facilitate a schema migration.A
See moreRLMMigration
instance is passed into a user-definedRLMMigrationBlock
block when updating the version of a Realm. This instance provides access to the old and new database schemas, the objects in the Realm, and provides functionality for modifying the Realm during the migration.Declaration
Objective-C
@interface RLMMigration : NSObject
Swift
class RLMMigration : NSObject
-
The
RLMMongoClient
enables reading and writing on a MongoDB database via the Realm Cloud service.It provides access to instances of
RLMMongoDatabase
, which in turn provide access to specificRLMMongoCollection
s that hold your data.Note
Before you can read or write data, a user must log in.
See also
Declaration
Objective-C
@interface RLMMongoClient : NSObject
Swift
class RLMMongoClient : NSObject
-
Acts as a middleman and processes events with WatchStream
See moreDeclaration
Objective-C
@interface RLMChangeStream : NSObject <RLMEventDelegate>
Swift
class RLMChangeStream : NSObject, RLMEventDelegate
-
The
RLMMongoCollection
represents a MongoDB collection.You can get an instance from a
RLMMongoDatabase
.Create, read, update, and delete methods are available.
Operations against the Realm Cloud server are performed asynchronously.
Note
Before you can read or write data, a user must log in.Usage: RLMMongoClient *client = [self.app mongoClient:@“mongodb1”]; RLMMongoDatabase *database = [client databaseWithName:@“test_data”]; RLMMongoCollection *collection = [database collectionWithName:@“Dog”]; [collection insertOneDocument:@{@“name”: @“fido”, @“breed”: @“cane corso”} completion:…];
See also
Declaration
Objective-C
@interface RLMMongoCollection : NSObject
Swift
class RLMMongoCollection : NSObject
-
The
RLMMongoDatabase
represents a MongoDB database, which holds a group of collections that contain your data.It can be retrieved from the
RLMMongoClient
.Use it to get
RLMMongoCollection
s for reading and writing data.Note
Before you can read or write data, a user must log in`.
See also
Declaration
Objective-C
@interface RLMMongoDatabase : NSObject
Swift
class RLMMongoDatabase : NSObject
-
An HTTP request that can be made to an arbitrary server.
See moreDeclaration
Objective-C
@interface RLMRequest : NSObject
Swift
class RLMRequest : NSObject
-
The contents of an HTTP response.
See moreDeclaration
Objective-C
@interface RLMResponse : NSObject
Swift
class RLMResponse : NSObject
-
Transporting protocol for foreign interfaces. Allows for custom request/response handling.
See moreDeclaration
Objective-C
@interface RLMNetworkTransport : NSObject <RLMNetworkTransport>
Swift
class RLMNetworkTransport : NSObject, RLMNetworkTransportProtocol
-
RLMObject
is a base class for model objects representing data stored in Realms.Define your model classes by subclassing
RLMObject
and adding properties to be managed. Then instantiate and use your custom subclasses instead of using theRLMObject
class directly.// Dog.h @interface Dog : RLMObject @property NSString *name; @property BOOL adopted; @end // Dog.m @implementation Dog @end //none needed
Supported property types
NSString
NSInteger
,int
,long
,float
, anddouble
BOOL
orbool
NSDate
NSData
NSNumber<X>
, whereX
is one ofRLMInt
,RLMFloat
,RLMDouble
orRLMBool
, for optional number propertiesRLMObject
subclasses, to model many-to-one relationships.RLMArray<X>
, whereX
is anRLMObject
subclass, to model many-to-many relationships.
Querying
You can initiate queries directly via the class methods:
allObjects
,objectsWhere:
, andobjectsWithPredicate:
. These methods allow you to easily query a custom subclass for instances of that class in the default Realm.To search in a Realm other than the default Realm, use the
allObjectsInRealm:
,objectsInRealm:where:
, andobjectsInRealm:withPredicate:
class methods.See
RLMRealm
Relationships
See our Cocoa guide for more details.
Key-Value Observing
All
RLMObject
properties (including properties you create in subclasses) are Key-Value Observing compliant, except forrealm
andobjectSchema
.Keep the following tips in mind when observing Realm objects:
- Unlike
NSMutableArray
properties,RLMArray
properties do not require using the proxy object returned from-mutableArrayValueForKey:
, or defining KVC mutation methods on the containing class. You can simply call methods on theRLMArray
directly; any changes will be automatically observed by the containing object. - Unmanaged
RLMObject
instances cannot be added to a Realm while they have any observed properties. - Modifying managed
RLMObject
s within-observeValueForKeyPath:ofObject:change:context:
is not recommended. Properties may change even when the Realm is not in a write transaction (for example, when-[RLMRealm refresh]
is called after changes are made on a different thread), and notifications sent prior to the change being applied (whenNSKeyValueObservingOptionPrior
is used) may be sent at times when you cannot begin a write transaction.
Declaration
Objective-C
@interface RLMObject : RLMObjectBase <RLMThreadConfined>
Swift
class RLMObject : RLMObjectBase, RLMThreadConfined
-
Declaration
Objective-C
@interface RLMPropertyChange : NSObject
Swift
class RLMPropertyChange : NSObject
-
Object
is a class used to define Realm model objects.In Realm you define your model classes by subclassing
Object
and adding properties to be managed. You then instantiate and use your custom subclasses instead of using theObject
class directly.class Dog: Object { @objc dynamic var name: String = "" @objc dynamic var adopted: Bool = false let siblings = List<Dog>() }
Supported property types
String
,NSString
Int
Int8
,Int16
,Int32
,Int64
Float
Double
Bool
Date
,NSDate
Data
,NSData
Decimal128
ObjectId
@objc enum
which has been delcared as conforming toRealmEnum
.RealmOptional<Value>
for optional numeric propertiesObject
subclasses, to model many-to-one relationshipsEmbeddedObject
subclasses, to model owning one-to-one relationshipsList<Element>
, to model many-to-many relationships
String
,NSString
,Date
,NSDate
,Data
,NSData
,Decimal128
, andObjectId
properties can be declared as optional.Object
andEmbeddedObject
subclasses must be declared as optional.Int
,Int8
,Int16
,Int32
,Int64
,Float
,Double
,Bool
, enum, andList
properties cannot. To store an optional number, useRealmOptional<Int>
,RealmOptional<Float>
,RealmOptional<Double>
, orRealmOptional<Bool>
instead, which wraps an optional numeric value. Lists cannot be optional at all.All property types except for
List
andRealmOptional
must be declared as@objc dynamic var
.List
andRealmOptional
properties must be declared as non-dynamiclet
properties. Swiftlazy
properties are not allowed.Note that none of the restrictions listed above apply to properties that are configured to be ignored by Realm.
Querying
You can retrieve all objects of a given type from a Realm by calling the
objects(_:)
instance method.Relationships
See our Cocoa guide for more details.
Declaration
Objective-C
@interface RealmSwiftObject : RLMObjectBase
Swift
class RealmSwiftObject : RLMObjectBase
-
EmbeddedObject
is a base class used to define embedded Realm model objects.Embedded objects work similarly to normal objects, but are owned by a single parent Object (which itself may be embedded). Unlike normal top-level objects, embedded objects cannot be directly created in or added to a Realm. Instead, they can only be created as part of a parent object, or by assigning an unmanaged object to a parent object’s property. Embedded objects are automatically deleted when the parent object is deleted or when the parent is modified to no longer point at the embedded object, either by reassigning an Object property or by removing the embedded object from the List containing it.
Embedded objects can only ever have a single parent object which links to them, and attempting to link to an existing managed embedded object will throw an exception.
The property types supported on
EmbeddedObject
are the same as forObject
, except for that embedded objects cannot link to top-level objects, soObject
andList<Object>
properties are not supported (EmbeddedObject
andList<EmbeddedObject>
are).Embedded objects cannot have primary keys or indexed properties.
class Owner: Object { @objc dynamic var name: String = "" let dogs = List<Dog>() } class Dog: EmbeddedObject { @objc dynamic var name: String = "" @objc dynamic var adopted: Bool = false let owner = LinkingObjects(fromType: Owner.self, property: "dogs") }
Declaration
Objective-C
@interface RealmSwiftEmbeddedObject : RLMObjectBase
Swift
class RealmSwiftEmbeddedObject : RLMObjectBase
-
A 12-byte (probably) unique object identifier.
ObjectIds are similar to a GUID or a UUID, and can be used to uniquely identify objects without a centralized ID generator. An ObjectID consists of:
- A 4 byte timestamp measuring the creation time of the ObjectId in seconds since the Unix epoch.
- A 5 byte random value
- A 3 byte counter, initialized to a random value.
ObjectIds are intended to be fast to generate. Sorting by an ObjectId field will typically result in the objects being sorted in creation order.
See moreDeclaration
Objective-C
@interface RLMObjectId : NSObject
Swift
class RLMObjectId : NSObject
-
This class represents Realm model object schemas.
When using Realm,
RLMObjectSchema
instances allow performing migrations and introspecting the database’s schema.Object schemas map to tables in the core database.
See moreDeclaration
Objective-C
@interface RLMObjectSchema : NSObject <NSCopying>
Swift
class RLMObjectSchema : NSObject, NSCopying
-
RLMProperty
instances represent properties managed by a Realm in the context of an object schema. Such properties may be persisted to a Realm file or computed from other data from the Realm.When using Realm,
RLMProperty
instances allow performing migrations and introspecting the database’s schema.These property instances map to columns in the core database.
See moreDeclaration
Objective-C
@interface RLMProperty : NSObject
Swift
class RLMProperty : NSObject
-
An
See moreRLMPropertyDescriptor
instance represents a specific property on a given class.Declaration
Objective-C
@interface RLMPropertyDescriptor : NSObject
Swift
class RLMPropertyDescriptor : NSObject
-
Base provider client interface.
See moreDeclaration
Objective-C
@interface RLMProviderClient : NSObject
Swift
class RLMProviderClient : NSObject
-
A client which can be used to register devices with the server to receive push notificatons
See moreDeclaration
Objective-C
@interface RLMPushClient : NSObject
Swift
class RLMPushClient : NSObject
-
An
RLMRealm
instance (also referred to as “a Realm”) represents a Realm database.Realms can either be stored on disk (see
+[RLMRealm realmWithURL:]
) or in memory (seeRLMRealmConfiguration
).RLMRealm
instances are cached internally, and constructing equivalentRLMRealm
objects (for example, by using the same path or identifier) multiple times on a single thread within a single iteration of the run loop will normally return the sameRLMRealm
object.If you specifically want to ensure an
RLMRealm
instance is destroyed (for example, if you wish to open a Realm, check some property, and then possibly delete the Realm file and re-open it), place the code which uses the Realm within an@autoreleasepool {}
and ensure you have no other strong references to it.Warning
Non-frozenRLMRealm
instances are thread-confined and cannot be shared across threads or dispatch queues. Trying to do so will cause an exception to be thrown. You must call this method on each thread you want to interact with the Realm on. For dispatch queues, this means that you must call it in each block which is dispatched, as a queue is not guaranteed to run all of its blocks on the same thread.Declaration
Objective-C
@interface RLMRealm : NSObject
Swift
class RLMRealm : NSObject
-
A token which is returned from methods which subscribe to changes to a Realm.
Change subscriptions in Realm return an
See moreRLMNotificationToken
instance, which can be used to unsubscribe from the changes. You must store a strong reference to the token for as long as you want to continue to receive notifications. When you wish to stop, call the-invalidate
method. Notifications are also stopped if the token is deallocated.Declaration
Objective-C
@interface RLMNotificationToken : NSObject
Swift
class RLMNotificationToken : NSObject
-
An
RLMRealmConfiguration
instance describes the different options used to create an instance of a Realm.RLMRealmConfiguration
instances are just plainNSObject
s. UnlikeRLMRealm
s andRLMObject
s, they can be freely shared between threads as long as you do not mutate them.Creating configuration objects for class subsets (by setting the
See moreobjectClasses
property) can be expensive. Because of this, you will normally want to cache and reuse a single configuration object for each distinct configuration rather than creating a new object each time you open a Realm.Declaration
Objective-C
@interface RLMRealmConfiguration : NSObject <NSCopying>
Swift
class RLMRealmConfiguration : NSObject, NSCopying
-
RLMResults
is an auto-updating container type in Realm returned from object queries. It represents the results of the query in the form of a collection of objects.RLMResults
can be queried using the same predicates asRLMObject
andRLMArray
, and you can chain queries to further filter results.RLMResults
always reflect the current state of the Realm on the current thread, including during write transactions on the current thread. The one exception to this is when usingfor...in
fast enumeration, which will always enumerate over the objects which matched the query when the enumeration is begun, even if some of them are deleted or modified to be excluded by the filter during the enumeration.RLMResults
are lazily evaluated the first time they are accessed; they only run queries when the result of the query is requested. This means that chaining several temporaryRLMResults
to sort and filter your data does not perform any extra work processing the intermediate state.Once the results have been evaluated or a notification block has been added, the results are eagerly kept up-to-date, with the work done to keep them up-to-date done on a background thread whenever possible.
See moreRLMResults
cannot be directly instantiated.Declaration
Objective-C
@interface RLMResults<RLMObjectType> : NSObject <RLMCollection, NSFastEnumeration>
Swift
class RLMResults<RLMObjectType> : NSObject, RLMCollection, NSFastEnumeration where RLMObjectType : AnyObject
-
RLMLinkingObjects
is an auto-updating container type. It represents a collection of objects that link to its parent object.For more information, please see the “Inverse Relationships” section in the documentation.
Declaration
Objective-C
@interface RLMLinkingObjects<RLMObjectType : RLMObject *> : RLMResults
Swift
class RLMLinkingObjects<RLMObjectType> : RLMResults<AnyObject> where RLMObjectType : RLMObject
-
RLMSchema
instances represent collections of model object schemas managed by a Realm.When using Realm,
RLMSchema
instances allow performing migrations and introspecting the database’s schema.Schemas map to collections of tables in the core database.
See moreDeclaration
Objective-C
@interface RLMSchema : NSObject <NSCopying>
Swift
class RLMSchema : NSObject, NSCopying
-
A configuration object representing configuration state for a Realm which is intended to sync with a Realm Object Server.
See moreDeclaration
Objective-C
@interface RLMSyncConfiguration : NSObject
Swift
class RLMSyncConfiguration : NSObject
-
A singleton manager which serves as a central point for sync-related configuration.
See moreDeclaration
Objective-C
@interface RLMSyncManager : NSObject
Swift
class RLMSyncManager : NSObject
-
Options for configuring timeouts and intervals in the sync client.
See moreDeclaration
Objective-C
@interface RLMSyncTimeoutOptions : NSObject
Swift
class RLMSyncTimeoutOptions : NSObject
-
A token object corresponding to a progress notification block on a session object.
To stop notifications manually, call
-invalidate
on it. Notifications should be stopped before the token goes out of scope or is destroyed.Declaration
Objective-C
@interface RLMProgressNotificationToken : RLMNotificationToken
Swift
class RLMProgressNotificationToken : RLMNotificationToken
-
An object encapsulating a MongoDB Realm “session”. Sessions represent the communication between the client (and a local Realm file on disk), and the server (and a remote Realm with a given partition value stored on MongoDB Realm).
Sessions are always created by the SDK and vended out through various APIs. The lifespans of sessions associated with Realms are managed automatically. Session objects can be accessed from any thread.
See moreDeclaration
Objective-C
@interface RLMSyncSession : NSObject
Swift
class RLMSyncSession : NSObject
-
An opaque token returned as part of certain errors. It can be passed into certain APIs to perform certain actions.
See
RLMSyncErrorClientResetError
,RLMSyncErrorPermissionDeniedError
Declaration
Objective-C
@interface RLMSyncErrorActionToken : NSObject
Swift
class RLMSyncErrorActionToken : NSObject
-
A task object which can be used to observe or cancel an async open.
When a synchronized Realm is opened asynchronously, the latest state of the Realm is downloaded from the server before the completion callback is invoked. This task object can be used to observe the state of the download or to cancel it. This should be used instead of trying to observe the download via the sync session as the sync session itself is created asynchronously, and may not exist yet when -[RLMRealm asyncOpenWithConfiguration:completion:] returns.
See moreDeclaration
Objective-C
@interface RLMAsyncOpenTask : NSObject
Swift
class RLMAsyncOpenTask : NSObject
-
An object intended to be passed between threads containing a thread-safe reference to its thread-confined object.
To resolve a thread-safe reference on a target Realm on a different thread, pass to
-[RLMRealm resolveThreadSafeReference:]
.Warning
A
RLMThreadSafeReference
object must be resolved at most once. Failing to resolve aRLMThreadSafeReference
will result in the source version of the Realm being pinned until the reference is deallocated.Note
Prefer short-lived
RLMThreadSafeReference
s as the data for the version of the source Realm will be retained until all references have been resolved or deallocated.Declaration
Objective-C
@interface RLMThreadSafeReference<__covariant Confined : id <RLMThreadConfined>> : NSObject
Swift
class RLMThreadSafeReference<Confined> : NSObject where Confined : RLMThreadConfined
-
The result of an
See moreupdateOne
orupdateMany
operation aRLMMongoCollection
.Declaration
Objective-C
@interface RLMUpdateResult : NSObject
Swift
class RLMUpdateResult : NSObject
-
A
RLMUser
instance represents a single Realm App user account.A user may have one or more credentials associated with it. These credentials uniquely identify the user to the authentication provider, and are used to sign into a MongoDB Realm user account.
Note that user objects are only vended out via SDK APIs, and cannot be directly initialized. User objects can be accessed from any thread.
See moreDeclaration
Objective-C
@interface RLMUser : NSObject
Swift
class RLMUser : NSObject
-
An identity of a user. A user can have multiple identities, usually associated with multiple providers. Note this is different from a user’s unique identifier string. @seeAlso
See moreRLMUser.identifier
Declaration
Objective-C
@interface RLMUserIdentity : NSObject
Swift
class RLMUserIdentity : NSObject
-
UserAPIKey model for APIKeys recevied from the server.
See moreDeclaration
Objective-C
@interface RLMUserAPIKey : NSObject
Swift
class RLMUserAPIKey : NSObject