RLMProperty

@interface RLMProperty : NSObject

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.

Properties

  • The name of the property.

    Declaration

    Objective‑C

    @property (readonly, nonatomic) NSString *_Nonnull name;

    Swift

    var name: String { get }
    Show on GitHub

  • The type of the property.

    See

    RLMPropertyType

    Declaration

    Objective‑C

    @property (readonly, nonatomic) RLMPropertyType type;

    Swift

    var type: LAPropertyType { get }
    Show on GitHub

  • Indicates whether this property is indexed.

    See

    RLMObject

    Declaration

    Objective‑C

    @property (readonly, nonatomic) BOOL indexed;

    Swift

    var indexed: Bool { get }
    Show on GitHub

  • For RLMObject and RLMArray properties, the name of the class of object stored in the property.

    Declaration

    Objective‑C

    @property (readonly, copy, nonatomic, nullable) NSString *objectClassName;

    Swift

    var objectClassName: String? { get }
    Show on GitHub

  • For linking objects properties, the property name of the property the linking objects property is linked to.

    Declaration

    Objective‑C

    @property (readonly, copy, nonatomic, nullable) NSString *linkOriginPropertyName;

    Swift

    var linkOriginPropertyName: String? { get }
    Show on GitHub

  • Indicates whether this property is optional.

    Declaration

    Objective‑C

    @property (readonly, nonatomic) BOOL optional;

    Swift

    var optional: Bool { get }
    Show on GitHub

Methods

  • Returns whether a given property object is equal to the receiver.

    Declaration

    Objective‑C

    - (BOOL)isEqualToProperty:(nonnull RLMProperty *)property;

    Swift

    func isEqual(to property: RLMProperty) -> Bool
    Show on GitHub