Realm Class Reference

A Realm instance (also referred to as a realm) represents a Realm database. More...

Inherits IDisposable.

Public Member Functions
RealmResults< T >	All< T > ()
	Extract an iterable set of objects for direct use or further query. More...
Transaction	BeginWrite ()
	Factory for a write Transaction. Essential object to create scope for updates. More...
void	Close ()
	Closes the Realm if not already closed. Safe to call repeatedly. More...
T	CreateObject< T > ()
	Factory for a managed object in a realm. Only valid within a Write transaction. More...
void	Dispose ()
	Dispose automatically closes the Realm if not already closed. More...
override bool	Equals (Object rhs)
	Generic override determines whether the specified System.Object is equal to the current Realm. More...
bool	Equals (Realm rhs)
	Determines whether the specified Realm is equal to the current Realm. More...
override int	GetHashCode ()
	Serves as a hash function for a Realm based on the core instance. More...
bool	IsSameInstance (Realm rhs)
	Determines whether this instance is the same core instance as the specified rhs. More...
void	Manage< T > (T obj)
	This realm will start managing a RealmObject which has been created as a standalone object. More...
void	Remove (RealmObject obj)
	Removes a persistent object from this realm, effectively deleting it. More...

Static Public Member Functions
static void	DeleteRealm (RealmConfiguration configuration)
	Deletes all the files associated with a realm. Hides knowledge of the auxiliary filenames from the programmer. More...
static Realm	GetInstance (string databasePath)
	Factory for a Realm instance for this thread. More...
static Realm	GetInstance (RealmConfiguration config=null)
	Factory for a Realm instance for this thread. More...

Public Attributes
bool	IsClosed => _sharedRealmHandle.IsClosed
	Checks if database has been closed. More...

Properties
RealmConfiguration	Config [get]
	Configuration that controls the Realm path and other settings. More...

Detailed Description

A Realm instance (also referred to as a realm) represents a Realm database.

Warning: Realm instances are not thread safe and can not be shared across threads You must call GetInstance on each thread in which you want to interact with the realm.

Member Function Documentation

RealmResults<T> All< T >

(

)

Extract an iterable set of objects for direct use or further query.

Template Parameters

T	The Type T must not only be a RealmObject but also have been processd by the Fody weaver, so it has persistent properties.

Returns

A RealmResults that without further filtering, allows iterating all objects of class T, in this realm.

Type Constraints

T

:

RealmObject

Transaction BeginWrite

(

)

Factory for a write Transaction. Essential object to create scope for updates.

using (var trans = myrealm.BeginWrite()) { var rex = myrealm.CreateObject<Dog>(); rex.Name = "Rex"; trans.Commit(); }

Returns

A transaction in write mode, which is required for any creation or modification of objects persisted in a Realm.

void Close

(

)

Closes the Realm if not already closed. Safe to call repeatedly.

Referenced by Realm.Dispose().

T CreateObject< T >

(

)

Factory for a managed object in a realm. Only valid within a Write transaction.

Using CreateObject is more efficient than creating standalone objects, assigning their values, then using Manage because it avoids copying properties to the realm.

Template Parameters

T	The Type T must not only be a RealmObject but also have been processd by the Fody weaver, so it has persistent properties.

Returns

An object which is already managed.

Exceptions

RealmOutsideTransactionException

If you invoke this when there is no write Transaction active on the realm.

Type Constraints

T

:

RealmObject

static void DeleteRealm ( RealmConfiguration  configuration )

static

Deletes all the files associated with a realm. Hides knowledge of the auxiliary filenames from the programmer.

Parameters

configuration

A configuration which supplies the realm path.

References RealmConfiguration.DatabasePath.

Referenced by Realm.GetInstance().

void Dispose

(

)

Dispose automatically closes the Realm if not already closed.

References Realm.Close().

override bool Equals

(

Object

rhs

)

Generic override determines whether the specified System.Object is equal to the current Realm.

Parameters

rhs	The System.Object to compare with the current Realm.

Returns

true if the Realms are functionally equal.

bool Equals

(

Realm

rhs

)

Determines whether the specified Realm is equal to the current Realm.

Parameters

rhs	The Realm to compare with the current Realm.

Returns

true if the Realms are functionally equal.

References Realm.Config, RealmConfiguration.Equals(), and Realm.IsClosed.

override int GetHashCode

(

)

Serves as a hash function for a Realm based on the core instance.

Returns

A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.

static Realm GetInstance ( string  databasePath )

static

Factory for a Realm instance for this thread.

Parameters

databasePath

Path to the realm, must be a valid full path for the current platform, relative subdir, or just filename.

If you specify a relative path, sandboxing by the OS may cause failure if you specify anything other than a subdirectory.
Instances are cached for a given absolute path and thread, so you may get back the same instance.

Returns

A realm instance, possibly from cache.

Exceptions

RealmFileAccessErrorException

Throws error if the filesystem has an error preventing file creation.

References RealmConfiguration.ConfigWithPath(), and RealmConfiguration.DefaultConfiguration.

static Realm GetInstance ( RealmConfiguration  config = null )

static

Factory for a Realm instance for this thread.

Parameters

config

Optional configuration.

Returns

A realm instance.

Exceptions

RealmFileAccessErrorException

Throws error if the filesystem has an error preventing file creation.

References Realm.Config, RealmConfiguration.DefaultConfiguration, Realm.DeleteRealm(), and RealmConfiguration.SchemaVersion.

bool IsSameInstance

(

Realm

rhs

)

Determines whether this instance is the same core instance as the specified rhs.

You can, and should, have multiple instances open on different threads which have the same path and open the same Realm.

Returns

true if this instance is the same core instance the specified rhs; otherwise, false.

Parameters

rhs	The Realm to compare with the current Realm.

void Manage< T >

(

T

obj

)

This realm will start managing a RealmObject which has been created as a standalone object.

Template Parameters

T	The Type T must not only be a RealmObject but also have been processd by the Fody weaver, so it has persistent properties.

Parameters

obj	Must be a standalone object, null not allowed.

Exceptions

RealmOutsideTransactionException	If you invoke this when there is no write Transaction active on the realm.
RealmObjectAlreadyManagedByRealmException	You can't manage the same object twice. This exception is thrown, rather than silently detecting the mistake, to help you debug your code
RealmObjectManagedByAnotherRealmException	You can't manage an object with more than one realm

Type Constraints

T

:

RealmObject

void Remove

(

RealmObject

obj

)

Removes a persistent object from this realm, effectively deleting it.

Parameters

obj	Must be an object persisted in this realm.

Exceptions

RealmOutsideTransactionException	If you invoke this when there is no write Transaction active on the realm.
System.ArgumentNullException	If you invoke this with a standalone object.

Member Data Documentation

bool IsClosed => _sharedRealmHandle.IsClosed

Checks if database has been closed.

Returns

True if closed.

Referenced by Realm.Equals().

Property Documentation

RealmConfiguration Config

get

Configuration that controls the Realm path and other settings.

Referenced by Realm.Equals(), and Realm.GetInstance().