RealmSwift 10.54.1 Docs (100% documented)

GitHub View on GitHub

Dash Install in Dash

RealmSwift Structures ObjectSchema Structure Reference

ObjectSchema

@frozen
public struct ObjectSchema : CustomStringConvertible

extension ObjectSchema: Equatable

This class represents Realm model object schemas.

When using Realm, ObjectSchema instances allow performing migrations and introspecting the database’s schema.

Object schemas map to tables in the core database.

Show on GitHub

Properties

properties
An array of Property instances representing the managed properties of a class described by the schema.

See
Property
Declaration
Swift

public var properties: [Property] { get }
Show on GitHub
className
The name of the class the schema describes.
Declaration
Swift

public var className: String { get }
Show on GitHub
objectClass
The object class the schema describes.
Declaration
Swift

public var objectClass: AnyClass { get }
Show on GitHub
isEmbedded
Whether this object is embedded.
Declaration
Swift

public var isEmbedded: Bool { get }
Show on GitHub
isAsymmetric
Whether this object is asymmetric.
Declaration
Swift

public var isAsymmetric: Bool { get }
Show on GitHub
primaryKeyProperty
The property which serves as the primary key for the class the schema describes, if any.
Declaration
Swift

public var primaryKeyProperty: Property? { get }
Show on GitHub
description
A human-readable description of the properties contained in the object schema.
Declaration
Swift

public var description: String { get }
Show on GitHub

Property Retrieval

subscript(_:)
Returns the property with the given name, if it exists.
Declaration
Swift

public subscript(propertyName: String) -> Property? { get }
Show on GitHub

Equatable

==(_:_:)
Returns whether the two object schemas are equal.
Declaration
Swift

public static func == (lhs: ObjectSchema, rhs: ObjectSchema) -> Bool
Show on GitHub