io.realm

Class Realm

java.lang.Object

io.realm.Realm

All Implemented Interfaces:

Closeable, AutoCloseable

public class Realm
extends Object

The Realm class is the storage and transactional manager of your object persistent store. It is in charge of creating instances of your RealmObjects. Objects within a Realm can be queried and read at any time. Creating, modifying, and deleting objects must be done while inside a transaction. See executeTransaction(Transaction)

The transactions ensure that multiple instances (on multiple threads) can access the same objects in a consistent state with full ACID guarantees.

It is important to remember to call the close() method when done with a Realm instance. Failing to do so can lead to OutOfMemoryError as the native resources cannot be freed.

Realm instances cannot be used across different threads. This means that you have to open an instance on each thread you want to use Realm. Realm instances are cached automatically per thread using reference counting, so as long as the reference count doesn't reach zero, calling getInstance(RealmConfiguration) will just return the cached Realm and should be considered a lightweight operation.

For the UI thread this means that opening and closing Realms should occur in either onCreate/onDestroy or onStart/onStop.

Realm instances coordinate their state across threads using the Handler mechanism. This also means that Realm instances on threads without a Looper cannot receive updates unless waitForChange() is manually called.

A standard pattern for working with Realm in Android activities can be seen below:

 public class RealmApplication extends Application {

     \@Override
     public void onCreate() {
         super.onCreate();

         // The Realm file will be located in package's "files" directory.
         RealmConfiguration realmConfig = new RealmConfiguration.Builder(this).build();
         Realm.setDefaultConfiguration(realmConfig);
     }
 }

 public class RealmActivity extends Activity {

   private Realm realm;

   \@Override
   protected void onCreate(Bundle savedInstanceState) {
     super.onCreate(savedInstanceState);
     setContentView(R.layout.layout_main);
     realm = Realm.getDefaultInstance();
   }

   \@Override
   protected void onDestroy() {
     super.onDestroy();
     realm.close();
   }
 }
 

Realm supports String and byte fields containing up to 16 MB.

See Also:

ACID, Examples using Realm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	io.realm.BaseRealm.RealmObjectContext
static interface	Realm.Transaction Encapsulates a Realm transaction.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_REALM_NAME
static io.realm.BaseRealm.ThreadLocalRealmObjectContext	objectContext

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(RealmChangeListener<Realm> listener) Adds a change listener to the Realm.
<any>	asObservable() Returns an RxJava Observable that monitors changes to this Realm.
void	beginTransaction() Starts a transaction which must be closed by BaseRealm.commitTransaction() or aborted by BaseRealm.cancelTransaction().
void	cancelTransaction() Reverts all writes (created, updated, or deleted objects) made in the current write transaction and end the transaction.
void	close() Closes the Realm instance and all its resources.
void	commitTransaction() All changes since BaseRealm.beginTransaction() are persisted to disk and the Realm reverts back to being read-only.
static boolean	compactRealm(RealmConfiguration configuration) Compacts a Realm file.
<E extends RealmModel> E	copyFromRealm(E realmObject) Makes an unmanaged in-memory copy of an already persisted RealmObject.
<E extends RealmModel> E	copyFromRealm(E realmObject, int maxDepth) Makes an unmanaged in-memory copy of an already persisted RealmObject.
<E extends RealmModel> List<E>	copyFromRealm(Iterable<E> realmObjects) Makes an unmanaged in-memory copy of already persisted RealmObjects.
<E extends RealmModel> List<E>	copyFromRealm(Iterable<E> realmObjects, int maxDepth) Makes an unmanaged in-memory copy of already persisted RealmObjects.
<E extends RealmModel> E	copyToRealm(E object) Copies a RealmObject to the Realm instance and returns the copy.
<E extends RealmModel> List<E>	copyToRealm(Iterable<E> objects) Copies a collection of RealmObjects to the Realm instance and returns their copy.
<E extends RealmModel> E	copyToRealmOrUpdate(E object) Updates an existing RealmObject that is identified by the same PrimaryKey or creates a new copy if no existing object could be found.
<E extends RealmModel> List<E>	copyToRealmOrUpdate(Iterable<E> objects) Updates a list of existing RealmObjects that is identified by their PrimaryKey or creates a new copy if no existing object could be found.
<E extends RealmModel> void	createAllFromJson(Class<E> clazz, InputStream inputStream) Creates a Realm object for each object in a JSON array.
<E extends RealmModel> void	createAllFromJson(Class<E> clazz, JSONArray json) Creates a Realm object for each object in a JSON array.
<E extends RealmModel> void	createAllFromJson(Class<E> clazz, String json) Creates a Realm object for each object in a JSON array.
<E extends RealmModel> E	createObject(Class<E> clazz) Instantiates and adds a new object to the Realm.
<E extends RealmModel> E	createObject(Class<E> clazz, Object primaryKeyValue) Instantiates and adds a new object to the Realm with the primary key value already set.
<E extends RealmModel> E	createObjectFromJson(Class<E> clazz, InputStream inputStream) Creates a Realm object pre-filled with data from a JSON object.
<E extends RealmModel> E	createObjectFromJson(Class<E> clazz, JSONObject json) Creates a Realm object pre-filled with data from a JSON object.
<E extends RealmModel> E	createObjectFromJson(Class<E> clazz, String json) Creates a Realm object pre-filled with data from a JSON object.
<E extends RealmModel> void	createOrUpdateAllFromJson(Class<E> clazz, InputStream in) Tries to update a list of existing objects identified by their primary key with new JSON data.
<E extends RealmModel> void	createOrUpdateAllFromJson(Class<E> clazz, JSONArray json) Tries to update a list of existing objects identified by their primary key with new JSON data.
<E extends RealmModel> void	createOrUpdateAllFromJson(Class<E> clazz, String json) Tries to update a list of existing objects identified by their primary key with new JSON data.
<E extends RealmModel> E	createOrUpdateObjectFromJson(Class<E> clazz, InputStream in) Tries to update an existing object defined by its primary key with new JSON data.
<E extends RealmModel> E	createOrUpdateObjectFromJson(Class<E> clazz, JSONObject json) Tries to update an existing object defined by its primary key with new JSON data.
<E extends RealmModel> E	createOrUpdateObjectFromJson(Class<E> clazz, String json) Tries to update an existing object defined by its primary key with new JSON data.
void	delete(Class<? extends RealmModel> clazz) Deletes all objects of the specified class from the Realm.
void	deleteAll() Deletes all objects from this Realm.
static boolean	deleteRealm(RealmConfiguration configuration) Deletes the Realm file specified by the given RealmConfiguration from the filesystem.
void	executeTransaction(Realm.Transaction transaction) Executes a given transaction on the Realm.
RealmAsyncTask	executeTransactionAsync(Realm.Transaction transaction) Similar to executeTransaction(Transaction) but runs asynchronously on a worker thread.
RealmAsyncTask	executeTransactionAsync(Realm.Transaction transaction, Realm.Transaction.OnError onError) Similar to executeTransactionAsync(Transaction), but also accepts an OnError callback.
RealmAsyncTask	executeTransactionAsync(Realm.Transaction transaction, Realm.Transaction.OnSuccess onSuccess) Similar to executeTransactionAsync(Transaction), but also accepts an OnSuccess callback.
RealmAsyncTask	executeTransactionAsync(Realm.Transaction transaction, Realm.Transaction.OnSuccess onSuccess, Realm.Transaction.OnError onError) Similar to executeTransactionAsync(Transaction), but also accepts an OnSuccess and OnError callbacks.
RealmConfiguration	getConfiguration() Returns the RealmConfiguration for this Realm.
static Realm	getDefaultInstance() Realm static constructor that returns the Realm instance defined by the RealmConfiguration set by setDefaultConfiguration(RealmConfiguration)
static Object	getDefaultModule() Returns the default Realm module.
static int	getGlobalInstanceCount(RealmConfiguration configuration) Returns the current number of open Realm instances across all threads that are using this configuration.
static Realm	getInstance(RealmConfiguration configuration) Realm static constructor that returns the Realm instance defined by provided RealmConfiguration
static int	getLocalInstanceCount(RealmConfiguration configuration) Returns the current number of open Realm instances on the thread calling this method.
String	getPath() Returns the canonical path to where this Realm is persisted on disk.
RealmSchema	getSchema() Returns the schema for this Realm.
long	getVersion() Returns the schema version for this Realm.
static void	init(Context context) Initializes the Realm library and creates a default configuration that is ready to use.
void	insert(Collection<? extends RealmModel> objects) Inserts a list of an unmanaged RealmObjects.
void	insert(RealmModel object) Inserts an unmanaged RealmObject.
void	insertOrUpdate(Collection<? extends RealmModel> objects) Inserts or updates a list of unmanaged RealmObjects.
void	insertOrUpdate(RealmModel object) Inserts or updates an unmanaged RealmObject.
boolean	isAutoRefresh() Retrieves the auto-refresh status of the Realm instance.
boolean	isClosed() Checks if the Realm instance has already been closed.
boolean	isEmpty() Checks if this Realm contains any objects.
boolean	isInTransaction() Checks if the Realm is currently in a transaction.
static void	migrateRealm(RealmConfiguration configuration) Manually triggers the migration associated with a given RealmConfiguration.
static void	migrateRealm(RealmConfiguration configuration, RealmMigration migration) Manually triggers a migration on a RealmMigration.
void	removeAllChangeListeners() Removes all user-defined change listeners.
void	removeChangeListener(RealmChangeListener<Realm> listener) Removes the specified change listener.
static void	removeDefaultConfiguration() Removes the current default configuration (if any).
void	setAutoRefresh(boolean autoRefresh) Sets the auto-refresh status of the Realm instance.
static void	setDefaultConfiguration(RealmConfiguration configuration) Sets the RealmConfiguration used when calling getDefaultInstance().
void	stopWaitForChange() Makes any current waitForChange() return false immediately.
boolean	waitForChange() Blocks the current thread until new changes to the Realm are available or stopWaitForChange() is called from another thread.
<E extends RealmModel> RealmQuery<E>	where(Class<E> clazz) Returns a typed RealmQuery, which can be used to query for specific objects of this type
void	writeCopyTo(File destination) Writes a compacted copy of the Realm to the given destination File.
void	writeEncryptedCopyTo(File destination, byte[] key) Writes a compacted and encrypted copy of the Realm to the given destination File.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_REALM_NAME

public static final String DEFAULT_REALM_NAME

See Also:

Constant Field Values

objectContext

public static final io.realm.BaseRealm.ThreadLocalRealmObjectContext objectContext

Method Detail

asObservable

public <any> asObservable()

Returns an RxJava Observable that monitors changes to this Realm. It will emit the current state when subscribed to. Items will continually be emitted as the Realm is updated - onComplete will never be called.

If you would like the asObservable() to stop emitting items, you can instruct RxJava to only emit only the first item by using the first() operator:

 
 realm.asObservable().first().subscribe( ... ) // You only get the results once
 
 

Returns:

RxJava Observable that only calls onNext. It will never call onComplete or OnError.

See Also:

RxJava and Realm

init

public static void init(Context context)

Initializes the Realm library and creates a default configuration that is ready to use. It is required to call this method before interacting with any other of the Realm API's.

A good place is in an Application subclass:

 
 public class MyApplication extends Application {
   \@Override
   public void onCreate() {
     super.onCreate();
     Realm.init(this);
   }
 }
 
 

Remember to register it in the AndroidManifest.xml file:

 
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="io.realm.example">
 <application android:name=".MyApplication">
   // ...
 </application>
 </manifest>
 
 

Parameters:

context - the Application Context.

Throws:

IllegalArgumentException - if a null context is provided.

IllegalStateException - if Context.getFilesDir() could not be found.

See Also:

getDefaultInstance()

getDefaultInstance

public static Realm getDefaultInstance()

Realm static constructor that returns the Realm instance defined by the RealmConfiguration set by setDefaultConfiguration(RealmConfiguration)

Returns:

an instance of the Realm class.

Throws:

NullPointerException - if no default configuration has been defined.

RealmMigrationNeededException - if no migration has been provided by the default configuration and the RealmObject classes or version has has changed so a migration is required.

RealmFileException - if an error happened when accessing the underlying Realm file.

getInstance

public static Realm getInstance(RealmConfiguration configuration)

Realm static constructor that returns the Realm instance defined by provided RealmConfiguration

Parameters:

configuration - RealmConfiguration used to open the Realm

Returns:

an instance of the Realm class

Throws:

RealmMigrationNeededException - if no migration has been provided by the configuration and the RealmObject classes or version has has changed so a migration is required.

RealmFileException - if an error happened when accessing the underlying Realm file.

IllegalArgumentException - if a null RealmConfiguration is provided.

See Also:

for details on how to configure a Realm.

setDefaultConfiguration

public static void setDefaultConfiguration(RealmConfiguration configuration)

Sets the RealmConfiguration used when calling getDefaultInstance().

Parameters:

configuration - the RealmConfiguration to use as the default configuration.

Throws:

IllegalArgumentException - if a null RealmConfiguration is provided.

See Also:

for details on how to configure a Realm.

removeDefaultConfiguration

public static void removeDefaultConfiguration()

Removes the current default configuration (if any). Any further calls to getDefaultInstance() will fail until a new default configuration has been set using setDefaultConfiguration(RealmConfiguration).

createAllFromJson

public <E extends RealmModel> void createAllFromJson(Class<E> clazz,
                                                     JSONArray json)

Creates a Realm object for each object in a JSON array. This must be done within a transaction.

JSON properties with unknown properties will be ignored. If a RealmObject field is not present in the JSON object the RealmObject field will be set to the default value for that type.

Parameters:

clazz - type of Realm objects to create.

json - an array where each JSONObject must map to the specified class.

Throws:

RealmException - if mapping from JSON fails.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

createOrUpdateAllFromJson

public <E extends RealmModel> void createOrUpdateAllFromJson(Class<E> clazz,
                                                             JSONArray json)

Tries to update a list of existing objects identified by their primary key with new JSON data. If an existing object could not be found in the Realm, a new object will be created. This must happen within a transaction. If updating a RealmObject and a field is not found in the JSON object, that field will not be updated. If a new RealmObject is created and a field is not found in the JSON object, that field will be assigned the default value for the field type.

Parameters:

clazz - type of RealmObject to create or update. It must have a primary key defined.

json - array with object data.

Throws:

IllegalArgumentException - if trying to update a class without a PrimaryKey.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

RealmException - if unable to map JSON.

See Also:

createAllFromJson(Class, org.json.JSONArray)

createAllFromJson

public <E extends RealmModel> void createAllFromJson(Class<E> clazz,
                                                     String json)

Creates a Realm object for each object in a JSON array. This must be done within a transaction. JSON properties with unknown properties will be ignored. If a RealmObject field is not present in the JSON object the RealmObject field will be set to the default value for that type.

Parameters:

clazz - type of Realm objects to create.

json - the JSON array as a String where each object can map to the specified class.

Throws:

RealmException - if mapping from JSON fails.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

createOrUpdateAllFromJson

public <E extends RealmModel> void createOrUpdateAllFromJson(Class<E> clazz,
                                                             String json)

Tries to update a list of existing objects identified by their primary key with new JSON data. If an existing object could not be found in the Realm, a new object will be created. This must happen within a transaction. If updating a RealmObject and a field is not found in the JSON object, that field will not be updated. If a new RealmObject is created and a field is not found in the JSON object, that field will be assigned the default value for the field type.

Parameters:

clazz - type of RealmObject to create or update. It must have a primary key defined.

json - string with an array of JSON objects.

Throws:

IllegalArgumentException - if trying to update a class without a PrimaryKey.

RealmException - if unable to create a JSON array from the json string.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

See Also:

createAllFromJson(Class, String)

createAllFromJson

public <E extends RealmModel> void createAllFromJson(Class<E> clazz,
                                                     InputStream inputStream)
                                              throws IOException

Creates a Realm object for each object in a JSON array. This must be done within a transaction. JSON properties with unknown properties will be ignored. If a RealmObject field is not present in the JSON object the RealmObject field will be set to the default value for that type.

This API is only available in API level 11 or later.

Parameters:

clazz - type of Realm objects created.

inputStream - the JSON array as a InputStream. All objects in the array must be of the specified class.

Throws:

RealmException - if mapping from JSON fails.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

IOException - if something was wrong with the input stream.

createOrUpdateAllFromJson

public <E extends RealmModel> void createOrUpdateAllFromJson(Class<E> clazz,
                                                             InputStream in)

Tries to update a list of existing objects identified by their primary key with new JSON data. If an existing object could not be found in the Realm, a new object will be created. This must happen within a transaction. If updating a RealmObject and a field is not found in the JSON object, that field will not be updated. If a new RealmObject is created and a field is not found in the JSON object, that field will be assigned the default value for the field type.

This API is only available in API level 11 or later.

Parameters:

clazz - type of RealmObject to create or update. It must have a primary key defined.

in - the InputStream with a list of object data in JSON format.

Throws:

IllegalArgumentException - if trying to update a class without a PrimaryKey.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

RealmException - if unable to read JSON.

See Also:

createOrUpdateAllFromJson(Class, java.io.InputStream)

createObjectFromJson

public <E extends RealmModel> E createObjectFromJson(Class<E> clazz,
                                                     JSONObject json)

Creates a Realm object pre-filled with data from a JSON object. This must be done inside a transaction. JSON properties with unknown properties will be ignored. If a RealmObject field is not present in the JSON object the RealmObject field will be set to the default value for that type.

Parameters:

clazz - type of Realm object to create.

json - the JSONObject with object data.

Returns:

created object or null if no JSON data was provided.

Throws:

RealmException - if the mapping from JSON fails.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

See Also:

createOrUpdateObjectFromJson(Class, org.json.JSONObject)

createOrUpdateObjectFromJson

public <E extends RealmModel> E createOrUpdateObjectFromJson(Class<E> clazz,
                                                             JSONObject json)

Tries to update an existing object defined by its primary key with new JSON data. If no existing object could be found a new object will be saved in the Realm. This must happen within a transaction. If updating a RealmObject and a field is not found in the JSON object, that field will not be updated. If a new RealmObject is created and a field is not found in the JSON object, that field will be assigned the default value for the field type.

Parameters:

clazz - Type of RealmObject to create or update. It must have a primary key defined.

json - JSONObject with object data.

Returns:

created or updated RealmObject.

Throws:

IllegalArgumentException - if trying to update a class without a PrimaryKey.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

RealmException - if JSON data cannot be mapped.

See Also:

createObjectFromJson(Class, org.json.JSONObject)

createObjectFromJson

public <E extends RealmModel> E createObjectFromJson(Class<E> clazz,
                                                     String json)

Creates a Realm object pre-filled with data from a JSON object. This must be done inside a transaction. JSON properties with unknown properties will be ignored. If a RealmObject field is not present in the JSON object the RealmObject field will be set to the default value for that type.

Parameters:

clazz - type of Realm object to create.

json - the JSON string with object data.

Returns:

created object or null if JSON string was empty or null.

Throws:

RealmException - if mapping to json failed.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

createOrUpdateObjectFromJson

public <E extends RealmModel> E createOrUpdateObjectFromJson(Class<E> clazz,
                                                             String json)

Tries to update an existing object defined by its primary key with new JSON data. If no existing object could be found a new object will be saved in the Realm. This must happen within a transaction. If updating a RealmObject and a field is not found in the JSON object, that field will not be updated. If a new RealmObject is created and a field is not found in the JSON object, that field will be assigned the default value for the field type.

Parameters:

clazz - type of RealmObject to create or update. It must have a primary key defined.

json - string with object data in JSON format.

Returns:

created or updated RealmObject.

Throws:

IllegalArgumentException - if trying to update a class without a PrimaryKey.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

RealmException - if JSON object cannot be mapped from the string parameter.

See Also:

createObjectFromJson(Class, String)

createObjectFromJson

public <E extends RealmModel> E createObjectFromJson(Class<E> clazz,
                                                     InputStream inputStream)
                                              throws IOException

Creates a Realm object pre-filled with data from a JSON object. This must be done inside a transaction. JSON properties with unknown properties will be ignored. If a RealmObject field is not present in the JSON object the RealmObject field will be set to the default value for that type.

This API is only available in API level 11 or later.

Parameters:

clazz - type of Realm object to create.

inputStream - the JSON object data as a InputStream.

Returns:

created object or null if JSON string was empty or null.

Throws:

RealmException - if the mapping from JSON failed.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

IOException - if something went wrong with the input stream.

createOrUpdateObjectFromJson

public <E extends RealmModel> E createOrUpdateObjectFromJson(Class<E> clazz,
                                                             InputStream in)

Tries to update an existing object defined by its primary key with new JSON data. If no existing object could be found a new object will be saved in the Realm. This must happen within a transaction. If updating a RealmObject and a field is not found in the JSON object, that field will not be updated. If a new RealmObject is created and a field is not found in the JSON object, that field will be assigned the default value for the field type.

This API is only available in API level 11 or later.

Parameters:

clazz - type of RealmObject to create or update. It must have a primary key defined.

in - the InputStream with object data in JSON format.

Returns:

created or updated RealmObject.

Throws:

IllegalArgumentException - if trying to update a class without a PrimaryKey.

IllegalArgumentException - if the JSON object doesn't have a primary key property but the corresponding RealmObjectSchema has a PrimaryKey defined.

RealmException - if failure to read JSON.

See Also:

createObjectFromJson(Class, java.io.InputStream)

createObject

public <E extends RealmModel> E createObject(Class<E> clazz)

Instantiates and adds a new object to the Realm.

This method is only available for model classes with no @PrimaryKey annotation. If you like to create an object that has a primary key, use createObject(Class, Object) or copyToRealm(RealmModel) instead.

Parameters:

clazz - the Class of the object to create.

Returns:

the new object.

Throws:

RealmException - if the primary key is defined in the model class or an object cannot be created.

See Also:

createObject(Class, Object)

createObject

public <E extends RealmModel> E createObject(Class<E> clazz,
                                             Object primaryKeyValue)

Instantiates and adds a new object to the Realm with the primary key value already set.

If the value violates the primary key constraint, no object will be added and a RealmException will be thrown. The default value for primary key provided by the model class will be ignored.

Parameters:

clazz - the Class of the object to create.

primaryKeyValue - value for the primary key field.

Returns:

the new object.

Throws:

RealmException - if object could not be created due to the primary key being invalid.

IllegalStateException - if the model class does not have an primary key defined.

IllegalArgumentException - if the primaryKeyValue doesn't have a value that can be converted to the expected value.

copyToRealm

public <E extends RealmModel> E copyToRealm(E object)

Copies a RealmObject to the Realm instance and returns the copy. Any further changes to the original RealmObject will not be reflected in the Realm copy. This is a deep copy, so all referenced objects will be copied. Objects already in this Realm will be ignored.

Please note, copying an object will copy all field values. Any unset field in this and child objects will be set to their default value if not provided.

Parameters:

object - the RealmObject to copy to the Realm.

Returns:

a managed RealmObject with its properties backed by the Realm.

Throws:

IllegalArgumentException - if the object is null or it belongs to a Realm instance in a different thread.

copyToRealmOrUpdate

public <E extends RealmModel> E copyToRealmOrUpdate(E object)

Updates an existing RealmObject that is identified by the same PrimaryKey or creates a new copy if no existing object could be found. This is a deep copy or update i.e., all referenced objects will be either copied or updated.

Please note, copying an object will copy all field values. Any unset field in the object and child objects will be set to their default value if not provided.

Parameters:

object - RealmObject to copy or update.

Returns:

the new or updated RealmObject with all its properties backed by the Realm.

Throws:

IllegalArgumentException - if the object is null or doesn't have a Primary key defined or it belongs to a Realm instance in a different thread.

See Also:

copyToRealm(RealmModel)

copyToRealm

public <E extends RealmModel> List<E> copyToRealm(Iterable<E> objects)

Copies a collection of RealmObjects to the Realm instance and returns their copy. Any further changes to the original RealmObjects will not be reflected in the Realm copies. This is a deep copy i.e., all referenced objects will be copied. Objects already in this Realm will be ignored.

Please note, copying an object will copy all field values. Any unset field in the objects and child objects will be set to their default value if not provided.

Parameters:

objects - the RealmObjects to copy to the Realm.

Returns:

a list of the the converted RealmObjects that all has their properties managed by the Realm.

Throws:

RealmException - if any of the objects has already been added to Realm.

IllegalArgumentException - if any of the elements in the input collection is null.

insert

public void insert(Collection<? extends RealmModel> objects)

Inserts a list of an unmanaged RealmObjects. This is generally faster than copyToRealm(Iterable) since it doesn't return the inserted elements, and performs minimum allocations and checks. After being inserted any changes to the original objects will not be persisted.

Please note:

• We don't check if the provided objects are already managed or not, so inserting a managed object might duplicate it. Duplication will only happen if the object doesn't have a primary key. Objects with primary keys will never get duplicated.
• We don't create (nor return) a managed RealmObject for each element
• Copying an object will copy all field values. Any unset field in the object and child objects will be set to their default value if not provided

If you want the managed RealmObject returned, use copyToRealm(Iterable), otherwise if you have a large number of object this method is generally faster.

Parameters:

objects - RealmObjects to insert.

Throws:

IllegalStateException - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction.

See Also:

copyToRealm(Iterable)

insert

public void insert(RealmModel object)

Inserts an unmanaged RealmObject. This is generally faster than copyToRealm(RealmModel) since it doesn't return the inserted elements, and performs minimum allocations and checks. After being inserted any changes to the original object will not be persisted.

Please note:

• We don't check if the provided objects are already managed or not, so inserting a managed object might duplicate it. Duplication will only happen if the object doesn't have a primary key. Objects with primary keys will never get duplicated.
• We don't create (nor return) a managed RealmObject for each element
• Copying an object will copy all field values. Any unset field in the object and child objects will be set to their default value if not provided

If you want the managed RealmObject returned, use copyToRealm(RealmModel), otherwise if you have a large number of object this method is generally faster.

Parameters:

object - RealmObjects to insert.

Throws:

IllegalStateException - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction.

RealmPrimaryKeyConstraintException - if two objects with the same primary key is inserted or if a primary key value already exists in the Realm.

See Also:

copyToRealm(RealmModel)

insertOrUpdate

public void insertOrUpdate(Collection<? extends RealmModel> objects)

Inserts or updates a list of unmanaged RealmObjects. This is generally faster than copyToRealmOrUpdate(Iterable) since it doesn't return the inserted elements, and performs minimum allocations and checks. After being inserted any changes to the original objects will not be persisted.

Please note:

• We don't check if the provided objects are already managed or not, so inserting a managed object might duplicate it. Duplication will only happen if the object doesn't have a primary key. Objects with primary keys will never get duplicated.
• We don't create (nor return) a managed RealmObject for each element
• Copying an object will copy all field values. Any unset field in the object and child objects will be set to their default value if not provided

If you want the managed RealmObject returned, use copyToRealm(Iterable), otherwise if you have a large number of object this method is generally faster.

Parameters:

objects - RealmObjects to insert.

Throws:

IllegalStateException - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction.

RealmPrimaryKeyConstraintException - if two objects with the same primary key is inserted or if a primary key value already exists in the Realm.

See Also:

copyToRealmOrUpdate(Iterable)

insertOrUpdate

public void insertOrUpdate(RealmModel object)

Inserts or updates an unmanaged RealmObject. This is generally faster than copyToRealmOrUpdate(RealmModel) since it doesn't return the inserted elements, and performs minimum allocations and checks. After being inserted any changes to the original object will not be persisted.

Please note:

• We don't check if the provided objects are already managed or not, so inserting a managed object might duplicate it. Duplication will only happen if the object doesn't have a primary key. Objects with primary keys will never get duplicated.
• We don't create (nor return) a managed RealmObject for each element
• Copying an object will copy all field values. Any unset field in the object and child objects will be set to their default value if not provided

If you want the managed RealmObject returned, use copyToRealm(RealmModel), otherwise if you have a large number of object this method is generally faster.

Parameters:

object - RealmObjects to insert.

Throws:

IllegalStateException - if the corresponding Realm is closed, called from an incorrect thread or not in a transaction.

See Also:

copyToRealmOrUpdate(RealmModel)

copyToRealmOrUpdate

public <E extends RealmModel> List<E> copyToRealmOrUpdate(Iterable<E> objects)

Updates a list of existing RealmObjects that is identified by their PrimaryKey or creates a new copy if no existing object could be found. This is a deep copy or update i.e., all referenced objects will be either copied or updated.

Please note, copying an object will copy all field values. Any unset field in the objects and child objects will be set to their default value if not provided.

Parameters:

objects - a list of objects to update or copy into Realm.

Returns:

a list of all the new or updated RealmObjects.

Throws:

IllegalArgumentException - if RealmObject is null or doesn't have a Primary key defined.

See Also:

copyToRealm(Iterable)

copyFromRealm

public <E extends RealmModel> List<E> copyFromRealm(Iterable<E> realmObjects)

Makes an unmanaged in-memory copy of already persisted RealmObjects. This is a deep copy that will copy all referenced objects.

The copied objects are all detached from Realm and they will no longer be automatically updated. This means that the copied objects might contain data that are no longer consistent with other managed Realm objects.

*WARNING*: Any changes to copied objects can be merged back into Realm using copyToRealmOrUpdate(RealmModel), but all fields will be overridden, not just those that were changed. This includes references to other objects, and can potentially override changes made by other threads.

Type Parameters:

E - type of object.

Parameters:

realmObjects - RealmObjects to copy.

Returns:

an in-memory detached copy of managed RealmObjects.

Throws:

IllegalArgumentException - if the RealmObject is no longer accessible or it is a DynamicRealmObject.

See Also:

copyToRealmOrUpdate(Iterable)

copyFromRealm

public <E extends RealmModel> List<E> copyFromRealm(Iterable<E> realmObjects,
                                                    int maxDepth)

Makes an unmanaged in-memory copy of already persisted RealmObjects. This is a deep copy that will copy all referenced objects up to the defined depth.

The copied objects are all detached from Realm and they will no longer be automatically updated. This means that the copied objects might contain data that are no longer consistent with other managed Realm objects.

*WARNING*: Any changes to copied objects can be merged back into Realm using copyToRealmOrUpdate(Iterable), but all fields will be overridden, not just those that were changed. This includes references to other objects even though they might be null due to maxDepth being reached. This can also potentially override changes made by other threads.

Type Parameters:

E - type of object.

Parameters:

realmObjects - RealmObjects to copy.

maxDepth - limit of the deep copy. All references after this depth will be null. Starting depth is 0.

Returns:

an in-memory detached copy of the RealmObjects.

Throws:

IllegalArgumentException - if maxDepth < 0, the RealmObject is no longer accessible or it is a DynamicRealmObject.

See Also:

copyToRealmOrUpdate(Iterable)

copyFromRealm

public <E extends RealmModel> E copyFromRealm(E realmObject)

Makes an unmanaged in-memory copy of an already persisted RealmObject. This is a deep copy that will copy all referenced objects.

The copied object(s) are all detached from Realm and they will no longer be automatically updated. This means that the copied objects might contain data that are no longer consistent with other managed Realm objects.

*WARNING*: Any changes to copied objects can be merged back into Realm using copyToRealmOrUpdate(RealmModel), but all fields will be overridden, not just those that were changed. This includes references to other objects, and can potentially override changes made by other threads.

Type Parameters:

E - type of object.

Parameters:

realmObject - RealmObject to copy.

Returns:

an in-memory detached copy of the managed RealmObject.

Throws:

IllegalArgumentException - if the RealmObject is no longer accessible or it is a DynamicRealmObject.

See Also:

copyToRealmOrUpdate(RealmModel)

copyFromRealm

public <E extends RealmModel> E copyFromRealm(E realmObject,
                                              int maxDepth)

Makes an unmanaged in-memory copy of an already persisted RealmObject. This is a deep copy that will copy all referenced objects up to the defined depth.

The copied object(s) are all detached from Realm and they will no longer be automatically updated. This means that the copied objects might contain data that are no longer consistent with other managed Realm objects.

*WARNING*: Any changes to copied objects can be merged back into Realm using copyToRealmOrUpdate(RealmModel), but all fields will be overridden, not just those that were changed. This includes references to other objects even though they might be null due to maxDepth being reached. This can also potentially override changes made by other threads.

Type Parameters:

E - type of object.

Parameters:

realmObject - RealmObject to copy.

maxDepth - limit of the deep copy. All references after this depth will be null. Starting depth is 0.

Returns:

an in-memory detached copy of the managed RealmObject.

Throws:

IllegalArgumentException - if maxDepth < 0, the RealmObject is no longer accessible or it is a DynamicRealmObject.

See Also:

copyToRealmOrUpdate(RealmModel)

where

public <E extends RealmModel> RealmQuery<E> where(Class<E> clazz)

Returns a typed RealmQuery, which can be used to query for specific objects of this type

Parameters:

clazz - the class of the object which is to be queried for.

Returns:

a typed RealmQuery, which can be used to query for specific objects of this type.

See Also:

RealmQuery

addChangeListener

public void addChangeListener(RealmChangeListener<Realm> listener)

Adds a change listener to the Realm.

The listeners will be executed when changes are committed by this or another thread.

Realm instances are per thread singletons and cached, so listeners should be removed manually even if calling close(). Otherwise there is a risk of memory leaks.

Parameters:

listener - the change listener.

Throws:

IllegalArgumentException - if the change listener is null.

IllegalStateException - if you try to register a listener from a non-Looper or IntentService thread.

See Also:

RealmChangeListener, removeChangeListener(RealmChangeListener), removeAllChangeListeners()

removeChangeListener

public void removeChangeListener(RealmChangeListener<Realm> listener)

Removes the specified change listener.

Parameters:

listener - the change listener to be removed.

Throws:

IllegalArgumentException - if the change listener is null.

IllegalStateException - if you try to remove a listener from a non-Looper Thread.

See Also:

RealmChangeListener

removeAllChangeListeners

public void removeAllChangeListeners()

Removes all user-defined change listeners.

Throws:

IllegalStateException - if you try to remove listeners from a non-Looper Thread.

See Also:

RealmChangeListener

executeTransaction

public void executeTransaction(Realm.Transaction transaction)

Executes a given transaction on the Realm. beginTransaction() and commitTransaction() will be called automatically. If any exception is thrown during the transaction cancelTransaction() will be called instead of commitTransaction().

Parameters:

transaction - the Realm.Transaction to execute.

Throws:

IllegalArgumentException - if the transaction is null.

RealmMigrationNeededException - if the latest version contains incompatible schema changes.

executeTransactionAsync

public RealmAsyncTask executeTransactionAsync(Realm.Transaction transaction)

Similar to executeTransaction(Transaction) but runs asynchronously on a worker thread.

Parameters:

transaction - Realm.Transaction to execute.

Returns:

a RealmAsyncTask representing a cancellable task.

Throws:

IllegalArgumentException - if the transaction is null, or if the Realm is opened from another thread.

executeTransactionAsync

public RealmAsyncTask executeTransactionAsync(Realm.Transaction transaction,
                                              Realm.Transaction.OnSuccess onSuccess)

Similar to executeTransactionAsync(Transaction), but also accepts an OnSuccess callback.

Parameters:

transaction - Realm.Transaction to execute.

onSuccess - callback invoked when the transaction succeeds.

Returns:

a RealmAsyncTask representing a cancellable task.

Throws:

IllegalArgumentException - if the transaction is null, or if the realm is opened from another thread.

executeTransactionAsync

public RealmAsyncTask executeTransactionAsync(Realm.Transaction transaction,
                                              Realm.Transaction.OnError onError)

Similar to executeTransactionAsync(Transaction), but also accepts an OnError callback.

Parameters:

transaction - Realm.Transaction to execute.

onError - callback invoked when the transaction fails.

Returns:

a RealmAsyncTask representing a cancellable task.

Throws:

IllegalArgumentException - if the transaction is null, or if the realm is opened from another thread.

executeTransactionAsync

public RealmAsyncTask executeTransactionAsync(Realm.Transaction transaction,
                                              Realm.Transaction.OnSuccess onSuccess,
                                              Realm.Transaction.OnError onError)

Similar to executeTransactionAsync(Transaction), but also accepts an OnSuccess and OnError callbacks.

Parameters:

transaction - Realm.Transaction to execute.

onSuccess - callback invoked when the transaction succeeds.

onError - callback invoked when the transaction fails.

Returns:

a RealmAsyncTask representing a cancellable task.

Throws:

IllegalArgumentException - if the transaction is null, or if the realm is opened from another thread.

delete

public void delete(Class<? extends RealmModel> clazz)

Deletes all objects of the specified class from the Realm.

Parameters:

clazz - the class which objects should be removed.

Throws:

IllegalStateException - if the corresponding Realm is closed or called from an incorrect thread.

migrateRealm

public static void migrateRealm(RealmConfiguration configuration)
                         throws FileNotFoundException

Manually triggers the migration associated with a given RealmConfiguration. If Realm is already at the latest version, nothing will happen.

Parameters:

configuration - RealmConfiguration

Throws:

FileNotFoundException - if the Realm file doesn't exist.

migrateRealm

public static void migrateRealm(RealmConfiguration configuration,
                                RealmMigration migration)
                         throws FileNotFoundException

Manually triggers a migration on a RealmMigration.

Parameters:

configuration - theRealmConfiguration.

migration - the RealmMigration to run on the Realm. This will override any migration set on the configuration.

Throws:

FileNotFoundException - if the Realm file doesn't exist.

deleteRealm

public static boolean deleteRealm(RealmConfiguration configuration)

Deletes the Realm file specified by the given RealmConfiguration from the filesystem. All Realm instances must be closed before calling this method.

Parameters:

configuration - a RealmConfiguration.

Returns:

false if a file could not be deleted. The failing file will be logged.

Throws:

IllegalStateException - if not all realm instances are closed.

compactRealm

public static boolean compactRealm(RealmConfiguration configuration)

Compacts a Realm file. A Realm file usually contain free/unused space. This method removes this free space and the file size is thereby reduced. Objects within the Realm files are untouched.

The file must be closed before this method is called, otherwise false will be returned.
The file system should have free space for at least a copy of the Realm file.
The Realm file is left untouched if any file operation fails.

Parameters:

configuration - a RealmConfiguration pointing to a Realm file.

Returns:

true if successful, false if any file operation failed.

Throws:

UnsupportedOperationException - if Realm is synchronized.

getDefaultModule

public static Object getDefaultModule()

Returns the default Realm module. This module contains all Realm classes in the current project, but not those from library or project dependencies. Realm classes in these should be exposed using their own module.

Returns:

the default Realm module or null if no default module exists.

Throws:

RealmException - if unable to create an instance of the module.

See Also:

RealmConfiguration.Builder.modules(Object, Object...)

getGlobalInstanceCount

public static int getGlobalInstanceCount(RealmConfiguration configuration)

Returns the current number of open Realm instances across all threads that are using this configuration. This includes both dynamic and normal Realms.

Parameters:

configuration - the RealmConfiguration for the Realm.

Returns:

number of open Realm instances across all threads.

getLocalInstanceCount

public static int getLocalInstanceCount(RealmConfiguration configuration)

Returns the current number of open Realm instances on the thread calling this method. This include both dynamic and normal Realms.

Parameters:

configuration - the RealmConfiguration for the Realm.

Returns:

number of open Realm instances across all threads.

setAutoRefresh

public void setAutoRefresh(boolean autoRefresh)

Sets the auto-refresh status of the Realm instance.

Auto-refresh is a feature that enables automatic update of the current Realm instance and all its derived objects (RealmResults and RealmObject instances) when a commit is performed on a Realm acting on the same file in another thread. This feature is only available if the Realm instance lives on a Looper enabled thread.

Parameters:

autoRefresh - true will turn auto-refresh on, false will turn it off.

Throws:

IllegalStateException - if called from a non-Looper thread.

isAutoRefresh

public boolean isAutoRefresh()

Retrieves the auto-refresh status of the Realm instance.

Returns:

the auto-refresh status.

isInTransaction

public boolean isInTransaction()

Checks if the Realm is currently in a transaction.

Returns:

true if inside a transaction, false otherwise.

writeCopyTo

public void writeCopyTo(File destination)

Writes a compacted copy of the Realm to the given destination File.

The destination file cannot already exist.

Note that if this is called from within a transaction it writes the current data, and not the data as it was when the last transaction was committed.

Parameters:

destination - file to save the Realm to.

Throws:

RealmFileException - if an error happened when accessing the underlying Realm file or writing to the destination file.

writeEncryptedCopyTo

public void writeEncryptedCopyTo(File destination,
                                 byte[] key)

Writes a compacted and encrypted copy of the Realm to the given destination File.

The destination file cannot already exist.

Note that if this is called from within a transaction it writes the current data, and not the data as it was when the last transaction was committed.

Parameters:

destination - file to save the Realm to.

key - a 64-byte encryption key.

Throws:

IllegalArgumentException - if destination argument is null.

RealmFileException - if an error happened when accessing the underlying Realm file or writing to the destination file.

waitForChange

public boolean waitForChange()

Blocks the current thread until new changes to the Realm are available or stopWaitForChange() is called from another thread. Once stopWaitForChange is called, all future calls to this method will return false immediately.

Returns:

true if the Realm was updated to the latest version, false if it was cancelled by calling stopWaitForChange.

Throws:

IllegalStateException - if calling this from within a transaction or from a Looper thread.

RealmMigrationNeededException - on typed Realm if the latest version contains incompatible schema changes.

stopWaitForChange

public void stopWaitForChange()

Makes any current waitForChange() return false immediately. Once this is called, all future calls to waitForChange will immediately return false.

This method is thread-safe and should _only_ be called from another thread than the one that called waitForChange.

Throws:

IllegalStateException - if the Realm instance has already been closed.

beginTransaction

public void beginTransaction()

Starts a transaction which must be closed by BaseRealm.commitTransaction() or aborted by BaseRealm.cancelTransaction(). Transactions are used to atomically create, update and delete objects within a Realm.

Before beginning a transaction, the Realm instance is updated to the latest version in order to include all changes from other threads. This update does not trigger any registered RealmChangeListener.

It is therefore recommended to query for the items that should be modified from inside the transaction. Otherwise there is a risk that some of the results have been deleted or modified when the transaction begins.

 
 // Don't do this
 RealmResults<Person> persons = realm.where(Person.class).findAll();
 realm.beginTransaction();
 persons.first().setName("John");
 realm.commitTransaction();

 // Do this instead
 realm.beginTransaction();
 RealmResults<Person> persons = realm.where(Person.class).findAll();
 persons.first().setName("John");
 realm.commitTransaction();
 
 

Notice: it is not possible to nest transactions. If you start a transaction within a transaction an exception is thrown.

Throws:

RealmMigrationNeededException - on typed Realm if the latest version contains incompatible schema changes.

commitTransaction

public void commitTransaction()

All changes since BaseRealm.beginTransaction() are persisted to disk and the Realm reverts back to being read-only. An event is sent to notify all other Realm instances that a change has occurred. When the event is received, the other Realms will update their objects and RealmResults to reflect the changes from this commit.

cancelTransaction

public void cancelTransaction()

Reverts all writes (created, updated, or deleted objects) made in the current write transaction and end the transaction.

The Realm reverts back to read-only.

Calling this when not in a transaction will throw an exception.

getPath

public String getPath()

Returns the canonical path to where this Realm is persisted on disk.

Returns:

the canonical path to the Realm file.

See Also:

File.getCanonicalPath()

getConfiguration

public RealmConfiguration getConfiguration()

Returns the RealmConfiguration for this Realm.

Returns:

the RealmConfiguration for this Realm.

getVersion

public long getVersion()

Returns the schema version for this Realm.

Returns:

the schema version for the Realm file backing this Realm.

close

public void close()

Closes the Realm instance and all its resources.

It's important to always remember to close Realm instances when you're done with it in order not to leak memory, file descriptors or grow the size of Realm file out of measure.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IllegalStateException - if attempting to close from another thread.

isClosed

public boolean isClosed()

Checks if the Realm instance has already been closed.

Returns:

true if closed, false otherwise.

Throws:

IllegalStateException - if attempting to close from another thread.

isEmpty

public boolean isEmpty()

Checks if this Realm contains any objects.

Returns:

true if empty, @{code false} otherwise.

getSchema

public RealmSchema getSchema()

Returns the schema for this Realm.

Returns:

The RealmSchema for this Realm.

deleteAll

public void deleteAll()

Deletes all objects from this Realm.

Throws:

IllegalStateException - if the corresponding Realm is closed or called from an incorrect thread.