RLMObjectSchema.h
2.13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
////////////////////////////////////////////////////////////////////////////
//
// Copyright 2014 Realm Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
////////////////////////////////////////////////////////////////////////////
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@class RLMProperty;
/**
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.
*/
@interface RLMObjectSchema : NSObject<NSCopying>
#pragma mark - Properties
/**
An array of `RLMProperty` instances representing the managed properties of a class described by the schema.
@see `RLMProperty`
*/
@property (nonatomic, readonly, copy) NSArray<RLMProperty *> *properties;
/**
The name of the class the schema describes.
*/
@property (nonatomic, readonly) NSString *className;
/**
The property which serves as the primary key for the class the schema describes, if any.
*/
@property (nonatomic, readonly, nullable) RLMProperty *primaryKeyProperty;
/**
Whether this object type is embedded.
*/
@property (nonatomic, readonly) BOOL isEmbedded;
#pragma mark - Methods
/**
Retrieves an `RLMProperty` object by the property name.
@param propertyName The property's name.
@return An `RLMProperty` object, or `nil` if there is no property with the given name.
*/
- (nullable RLMProperty *)objectForKeyedSubscript:(NSString *)propertyName;
/**
Returns whether two `RLMObjectSchema` instances are equal.
*/
- (BOOL)isEqualToObjectSchema:(RLMObjectSchema *)objectSchema;
@end
NS_ASSUME_NONNULL_END