RealmCollection

public protocol RealmCollection : RealmCollectionBase

A homogenous collection of Objects which can be retrieved, filtered, sorted, and operated upon.

Show on GitHub

Properties

  • The Realm which manages the collection, or nil for unmanaged collections.

    Declaration

    Swift

    var realm: Realm? { get }
    Show on GitHub

  • Indicates if the collection can no longer be accessed.

    The collection can no longer be accessed if invalidate() is called on the Realm that manages the collection.

    Declaration

    Swift

    var isInvalidated: Bool { get }
    Show on GitHub

  • The number of objects in the collection.

    Declaration

    Swift

    var count: Int { get }
    Show on GitHub

  • A human-readable description of the objects contained in the collection.

    Declaration

    Swift

    var description: String { get }
    Show on GitHub

Index Retrieval

  • Returns the index of an object in the collection, or nil if the object is not present.

    Declaration

    Swift

    func index(of object: Element) -> Int?

    Parameters

    object

    An object.
    Show on GitHub

  • Returns the index of the first object matching the predicate, or nil if no objects match.

    Declaration

    Swift

    func index(matching predicate: NSPredicate) -> Int?

    Parameters

    predicate

    The predicate to use to filter the objects.
    Show on GitHub
  • index(matching:_:) Default implementation

    Returns the index of the first object matching the predicate, or nil if no objects match.

    Default Implementation

    Returns the index of the first object matching the given predicate, or nil if no objects match.

    Declaration

    Swift

    func index(matching predicateFormat: String, _ args: Any...) -> Int?

    Parameters

    predicateFormat

    A predicate format string, optionally followed by a variable number of arguments.
    Show on GitHub

Filtering

  • filter(_:_:) Default implementation

    Returns a Results containing all objects matching the given predicate in the collection.

    Default Implementation

    Returns a Results containing all objects matching the given predicate in the collection.

    Declaration

    Swift

    func filter(_ predicateFormat: String, _ args: Any...) -> Results<Element>

    Parameters

    predicateFormat

    A predicate format string, optionally followed by a variable number of arguments.
    Show on GitHub

  • Returns a Results containing all objects matching the given predicate in the collection.

    Declaration

    Swift

    func filter(_ predicate: NSPredicate) -> Results<Element>

    Parameters

    predicate

    The predicate to use to filter the objects.
    Show on GitHub

Sorting

  • Returns a Results containing the objects in the collection, but sorted.

    Objects are sorted based on the values of the given key path. For example, to sort a collection of Students from youngest to oldest based on their age property, you might call students.sorted(byKeyPath: "age", ascending: true).

    Warning

    Collections may only be sorted by properties of boolean, Date, NSDate, single and double-precision floating point, integer, and string types.

    Declaration

    Swift

    func sorted(byKeyPath keyPath: String, ascending: Bool) -> Results<Element>

    Parameters

    keyPath

    The key path to sort by.
    ascending

    The direction to sort in.
    Show on GitHub

  • Returns a Results containing the objects in the collection, but sorted.

    Warning

    Collections may only be sorted by properties of boolean, Date, NSDate, single and double-precision floating point, integer, and string types.

    See

    sorted(byKeyPath:ascending:)

    Declaration

    Swift

    func sorted<S>(by sortDescriptors: S) -> Results<Element> where S : Sequence, S.Element == SortDescriptor

    Parameters

    sortDescriptors

    A sequence of SortDescriptors to sort by.
    Show on GitHub

Aggregate Operations

  • Returns the minimum (lowest) value of the given property among all the objects in the collection, or nil if the collection is empty.

    Warning

    Only a property whose type conforms to the MinMaxType protocol can be specified.

    Declaration

    Swift

    func min<T>(ofProperty property: String) -> T? where T : MinMaxType

    Parameters

    property

    The name of a property whose minimum value is desired.
    Show on GitHub

  • Returns the maximum (highest) value of the given property among all the objects in the collection, or nil if the collection is empty.

    Warning

    Only a property whose type conforms to the MinMaxType protocol can be specified.

    Declaration

    Swift

    func max<T>(ofProperty property: String) -> T? where T : MinMaxType

    Parameters

    property

    The name of a property whose minimum value is desired.
    Show on GitHub

  • Returns the sum of the given property for objects in the collection, or nil if the collection is empty.

    Warning

    Only names of properties of a type conforming to the AddableType protocol can be used.

    Declaration

    Swift

    func sum<T>(ofProperty property: String) -> T where T : AddableType

    Parameters

    property

    The name of a property conforming to AddableType to calculate sum on.
    Show on GitHub

  • Returns the average value of a given property over all the objects in the collection, or nil if the collection is empty.

    Warning

    Only a property whose type conforms to the AddableType protocol can be specified.

    Declaration

    Swift

    func average<T>(ofProperty property: String) -> T? where T : AddableType

    Parameters

    property

    The name of a property whose values should be summed.
    Show on GitHub

Key-Value Coding

  • Returns an Array containing the results of invoking valueForKey(_:) with key on each of the collection’s objects.

    Declaration

    Swift

    func value(forKey key: String) -> Any?

    Parameters

    key

    The name of the property whose values are desired.
    Show on GitHub

  • Returns an Array containing the results of invoking valueForKeyPath(_:) with keyPath on each of the collection’s objects.

    Declaration

    Swift

    func value(forKeyPath keyPath: String) -> Any?

    Parameters

    keyPath

    The key path to the property whose values are desired.
    Show on GitHub

  • Invokes setValue(_:forKey:) on each of the collection’s objects using the specified value and key.

    Warning

    This method may only be called during a write transaction.

    Declaration

    Swift

    func setValue(_ value: Any?, forKey key: String)

    Parameters

    value

    The object value.
    key

    The name of the property whose value should be set on each object.
    Show on GitHub

Notifications

  • Registers a block to be called each time the collection changes.

    The block will be asynchronously called with the initial results, and then called again after each write transaction which changes either any of the objects in the collection, or which objects are in the collection.

    The change parameter that is passed to the block reports, in the form of indices within the collection, which of the objects were added, removed, or modified during each write transaction. See the RealmCollectionChange documentation for more information on the change information supplied and an example of how to use it to update a UITableView.

    At the time when the block is called, the collection will be fully evaluated and up-to-date, and as long as you do not perform a write transaction on the same thread or explicitly call realm.refresh(), accessing it will never perform blocking work.

    If no queue is given, notifications are delivered via the standard run loop, and so can’t be delivered while the run loop is blocked by other activity. If a queue is given, notifications are delivered to that queue instead. When notifications can’t be delivered instantly, multiple notifications may be coalesced into a single notification. This can include the notification with the initial collection.

    For example, the following code performs a write transaction immediately after adding the notification block, so there is no opportunity for the initial notification to be delivered first. As a result, the initial notification will reflect the state of the Realm after the write transaction.

    let results = realm.objects(Dog.self)
print("dogs.count: \(dogs?.count)") // => 0
let token = dogs.observe { changes in
switch changes {
    case .initial(let dogs):
        // Will print "dogs.count: 1"
        print("dogs.count: \(dogs.count)")
        break
    case .update:
        // Will not be hit in this example
        break
    case .error:
        break
    }
}
try! realm.write {
    let dog = Dog()
    dog.name = "Rex"
    person.dogs.append(dog)
}
// end of run loop execution context

    You must retain the returned token for as long as you want updates to be sent to the block. To stop receiving updates, call invalidate() on the token.

    Warning

    This method cannot be called during a write transaction, or when the containing Realm is read-only.

    Declaration

    Swift

    func observe(on queue: DispatchQueue?, _ block: @escaping (RealmCollectionChange<Self>) -> Void) -> NotificationToken

    Parameters

    queue

    The serial dispatch queue to receive notification on. If nil, notifications are delivered to the current thread.
    block

    The block to be called whenever a change occurs.

    Return Value

    A token which must be held for as long as you want updates to be delivered.

    Show on GitHub

Frozen Objects

  • Returns if this collection is frozen

    Declaration

    Swift

    var isFrozen: Bool { get }
    Show on GitHub

  • Returns a frozen (immutable) snapshot of this collection.

    The frozen copy is an immutable collection which contains the same data as this collection currently contains, but will not update when writes are made to the containing Realm. Unlike live collections, frozen collections can be accessed from any thread.

    Warning

    This method cannot be called during a write transaction, or when the containing Realm is read-only.

    Warning

    Holding onto a frozen collection for an extended period while performing write transaction on the Realm may result in the Realm file growing to large sizes. See Realm.Configuration.maximumNumberOfActiveVersions for more information.

    Declaration

    Swift

    func freeze() -> Self
    Show on GitHub

  • Returns a live (mutable) version of this frozen collection.

    This method resolves a reference to a live copy of the same frozen collection. If called on a live collection, will return itself.

    Declaration

    Swift

    func thaw() -> Self?
    Show on GitHub

Available where Self: RealmSubscribable

  • objectWillChange Extension method

    A publisher that emits Void each time the collection changes.

    Despite the name, this actually emits after the collection has changed.

    Declaration

    Swift

    public var objectWillChange: RealmPublishers.WillChange<Self> { get }
    Show on GitHub
  • collectionPublisher Extension method

    A publisher that emits the collection each time the collection changes.

    Declaration

    Swift

    public var collectionPublisher: RealmPublishers.Value<Self> { get }
    Show on GitHub
  • changesetPublisher Extension method

    A publisher that emits a collection changeset each time the collection changes.

    Declaration

    Swift

    public var changesetPublisher: RealmPublishers.CollectionChangeset<Self> { get }
    Show on GitHub

Available where Element: MinMaxType

  • min() Extension method

    Returns the minimum (lowest) value of the collection, or nil if the collection is empty.

    Declaration

    Swift

    func min() -> Element?
    Show on GitHub
  • max() Extension method

    Returns the maximum (highest) value of the collection, or nil if the collection is empty.

    Declaration

    Swift

    func max() -> Element?
    Show on GitHub

Available where Element: OptionalProtocol, Element.Wrapped: MinMaxType

  • min() Extension method

    Returns the minimum (lowest) value of the collection, or nil if the collection is empty.

    Declaration

    Swift

    func min() -> Element.Wrapped?
    Show on GitHub
  • max() Extension method

    Returns the maximum (highest) value of the collection, or nil if the collection is empty.

    Declaration

    Swift

    func max() -> Element.Wrapped?
    Show on GitHub

Available where Element: AddableType

  • sum() Extension method

    Returns the sum of the values in the collection, or nil if the collection is empty.

    Declaration

    Swift

    func sum() -> Element
    Show on GitHub
  • average() Extension method

    Returns the average of all of the values in the collection.

    Declaration

    Swift

    func average<T>() -> T? where T : AddableType
    Show on GitHub

Available where Element: OptionalProtocol, Element.Wrapped: AddableType

  • sum() Extension method

    Returns the sum of the values in the collection, or nil if the collection is empty.

    Declaration

    Swift

    func sum() -> Element.Wrapped
    Show on GitHub
  • average() Extension method

    Returns the average of all of the values in the collection.

    Declaration

    Swift

    func average<T>() -> T? where T : AddableType
    Show on GitHub

Available where Element: Comparable

  • sorted(ascending:) Extension method

    Returns a Results containing the objects in the collection, but sorted.

    Objects are sorted based on their values. For example, to sort a collection of Dates from neweset to oldest based, you might call dates.sorted(ascending: true).

    Declaration

    Swift

    func sorted(ascending: Bool = true) -> Results<Element>

    Parameters

    ascending

    The direction to sort in.
    Show on GitHub

Available where Element: OptionalProtocol, Element.Wrapped: Comparable

  • sorted(ascending:) Extension method

    Returns a Results containing the objects in the collection, but sorted.

    Objects are sorted based on their values. For example, to sort a collection of Dates from neweset to oldest based, you might call dates.sorted(ascending: true).

    Declaration

    Swift

    func sorted(ascending: Bool = true) -> Results<Element>

    Parameters

    ascending

    The direction to sort in.
    Show on GitHub