RLMProperty

@interface RLMProperty : NSObject

This class models properties persisted to Realm in an RLMObjectSchema.

When using Realm, RLMProperty objects allow performing migrations and introspecting the database’s schema.

These properties map to columns in the core database.

Properties

  • Property name.

    Declaration

    Objective‑C

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

    Swift

    var name: String { get }
    Show on GitHub

  • Property type.

    See

    RLMPropertyType

    Declaration

    Objective‑C

    @property (readonly, nonatomic) RLMPropertyType type;

    Swift

    var type: LAPropertyType { get }
    Show on GitHub

  • Indicates if this property is indexed.

    See

    RLMObject

    Declaration

    Objective‑C

    @property (readonly, nonatomic) BOOL indexed;

    Swift

    var indexed: Bool { get }
    Show on GitHub

  • Object class name - specify object types for RLMObject and RLMArray properties.

    Declaration

    Objective‑C

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

    Swift

    var objectClassName: String? { get }
    Show on GitHub

  • Property name of the origin of a link. Specified for linking objects properties.

    Declaration

    Objective‑C

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

    Swift

    var linkOriginPropertyName: String? { get }
    Show on GitHub

  • Whether this property is optional.

    Declaration

    Objective‑C

    @property (readonly, nonatomic) BOOL optional;

    Swift

    var optional: Bool { get }
    Show on GitHub

Methods

  • Returns YES if property objects are equal.

    Declaration

    Objective‑C

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

    Swift

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