78 lines
2.3 KiB
Objective-C
78 lines
2.3 KiB
Objective-C
////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// 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 RLMObjectSchema;
|
|
|
|
/**
|
|
`RLMSchema` instances represent collections of model object schemas managed by a Realm.
|
|
|
|
When using Realm, `RLMSchema` instances 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 `RLMObjectSchema`s for all object types in the Realm.
|
|
|
|
This property is intended to be used during migrations for dynamic introspection.
|
|
|
|
@see `RLMObjectSchema`
|
|
*/
|
|
@property (nonatomic, readonly, copy) NSArray<RLMObjectSchema *> *objectSchema;
|
|
|
|
#pragma mark - Methods
|
|
|
|
/**
|
|
Returns an `RLMObjectSchema` for the given class name in the schema.
|
|
|
|
@param className The object class name.
|
|
@return An `RLMObjectSchema` for the given class in the schema.
|
|
|
|
@see `RLMObjectSchema`
|
|
*/
|
|
- (nullable RLMObjectSchema *)schemaForClassName:(NSString *)className;
|
|
|
|
/**
|
|
Looks up and returns an `RLMObjectSchema` for the given class name in the Realm.
|
|
|
|
If there is no object of type `className` in the schema, an exception will be thrown.
|
|
|
|
@param className The object class name.
|
|
@return An `RLMObjectSchema` for the given class in this Realm.
|
|
|
|
@see `RLMObjectSchema`
|
|
*/
|
|
- (RLMObjectSchema *)objectForKeyedSubscript:(NSString *)className;
|
|
|
|
/**
|
|
Returns whether two `RLMSchema` instances are equivalent.
|
|
*/
|
|
- (BOOL)isEqualToSchema:(RLMSchema *)schema;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|