RLMSchema.h
2.24 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
////////////////////////////////////////////////////////////////////////////
//
// 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>
#import <Realm/RLMDefines.h>
RLM_ASSUME_NONNULL_BEGIN
@class RLMObjectSchema;
/**
This class represents the collection of model object schemas persisted to Realm.
When using Realm, RLMSchema objects allow performing migrations and
introspecting the database's schema.
Schemas map to collections of tables in the core database.
*/
@interface RLMSchema : NSObject<NSCopying>
#pragma mark - Properties
/**
An NSArray containing RLMObjectSchemas for all object types in this Realm. Meant
to be used during migrations for dynamic introspection.
@see RLMObjectSchema
*/
@property (nonatomic, readonly, copy) NSArray RLM_GENERIC(RLMObjectSchema *) *objectSchema;
#pragma mark - Methods
/**
Returns an RLMObjectSchema for the given class name in this RLMSchema.
@param className The object class name.
@return RLMObjectSchema for the given class in this RLMSchema.
@see RLMObjectSchema
*/
- (nullable RLMObjectSchema *)schemaForClassName:(NSString *)className;
/**
Look up an RLMObjectSchema for the given class name in this Realm. Throws
an exception if there is no object of type className in this RLMSchema instance.
@param className The object class name.
@return RLMObjectSchema for the given class in this Realm.
@see RLMObjectSchema
*/
- (RLMObjectSchema *)objectForKeyedSubscript:(id <NSCopying>)className;
/**
Returns YES if equal to schema
*/
- (BOOL)isEqualToSchema:(RLMSchema *)schema;
@end
RLM_ASSUME_NONNULL_END