Skip to content

Commit

Permalink
[RLMRealm] Document migrateRealm:
Browse files Browse the repository at this point in the history
  • Loading branch information
segiddins committed Aug 12, 2015
1 parent 838f0d2 commit 9e39b06
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions Realm/RLMRealm.h
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,18 @@ typedef void (^RLMMigrationBlock)(RLMMigration *migration, uint64_t oldSchemaVer
*/
+ (uint64_t)schemaVersionAtPath:(NSString *)realmPath encryptionKey:(nullable NSData *)key error:(NSError **)error;

/**
Performs the given Realm configuration's migration block on a Realm at the given path.
This method is called automatically when opening a Realm for the first time and does
not need to be called explicitly. You can choose to call this method to control
exactly when and how migrations are performed.
@param configuration The Realm configuration used to open and migrate the Realm.
@return The error that occurred while applying the migration, if any.
@see RLMMigration
*/
+ (NSError *)migrateRealm:(RLMRealmConfiguration *)configuration;

/**
Expand Down

0 comments on commit 9e39b06

Please sign in to comment.