Class RealmConfiguration

Atlas Device SDKs are deprecated. Refer to the deprecation page for details.

io.realm

java.lang.Object

io.realm.RealmConfiguration

A RealmConfiguration is used to setup a specific Realm instance.Instances of a RealmConfiguration can only created by using the io.realm.RealmConfiguration.Builder and calling its io.realm.RealmConfiguration.Builder.build() method.

A commonly used RealmConfiguration can easily be accessed by first saving it as Realm.setDefaultConfiguration(RealmConfiguration) and then using io.realm.Realm.getDefaultInstance() .

A minimal configuration can be created using:

RealmConfiguration config = new RealmConfiguration.Builder().build()

This will create a RealmConfiguration with the following properties.

Realm file is called "default.realm"
It is saved in Context.getFilesDir()
It has its schema version set to 0.

Nested Class Summary

Modifier and Type	Class and Description
`public static`	RealmConfiguration.Builder

Field Summary

Modifier and Type	Field and Description
public static final String	DEFAULT_REALM_NAME

Method Summary

Modifier and Type	Method and Description
protected static RealmProxyMediator	createSchemaMediator ( java.util.Set<java.lang.Object> modules, java.util.Set<java.lang.Class<? extends io.realm.RealmModel>> debugSchema, boolean excludeDebugSchema )
public boolean	equals ( Object obj )
protected static RealmConfiguration	forRecovery ( String canonicalPath, byte[] encryptionKey, RealmProxyMediator schemaMediator )
public String	getAssetFilePath () Returns the path to the Realm asset file.
public CompactOnLaunchCallback	getCompactOnLaunchCallback () Returns a callback to determine if the Realm file should be compacted before being returned to the user.
public OsRealmConfig.Durability	getDurability ()
public byte	getEncryptionKey ()
public FlowFactory	getFlowFactory () Returns the FlowFactory that is used to create Kotlin Flows from Realm objects.
protected Realm.Transaction	getInitialDataTransaction () Returns the transaction instance with initial data.
protected Realm	getInstance ( OsSharedRealm.VersionID version )
public long	getMaxNumberOfActiveVersions ()
public RealmMigration	getMigration ()
public String	getPath () Returns the absolute path to where the Realm file will be saved.
public File	getRealmDirectory ()
public String	getRealmFileName ()
public Set	getRealmObjectClasses () Returns the unmodifiable Set of model classes that make up the schema for this Realm.
public RxObservableFactory	getRxFactory () Returns the RxObservableFactory that is used to create Rx Observables from Realm objects.
protected RealmProxyMediator	getSchemaMediator () Returns the mediator instance of schema which is defined by this configuration.
public long	getSchemaVersion ()
public boolean	hasAssetFile () Indicates if an asset file has been configured for this configuration.
public int	hashCode ()
public boolean	isAllowQueriesOnUiThread () Returns whether a RealmQuery is allowed to be launched from the UI thread.
public boolean	isAllowWritesOnUiThread () Returns whether calls to Realm.executeTransaction can be done on the UI thread.
public boolean	isReadOnly () Returns whether this Realm is read-only or not.
public boolean	isRecoveryConfiguration ()
protected boolean	isSyncConfiguration ()
protected boolean	realmExists () Checks if the Realm file defined by this configuration already exists.
public boolean	shouldDeleteRealmIfMigrationNeeded ()
public String	toString ()

Inherited Methods

Methods inherited from class java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

Field Detail

`DEFAULT_REALM_NAME`

Method Detail

createSchemaMediator

protected static RealmProxyMediator createSchemaMediator ( java.util.Set<java.lang.Object> modules, java.util.Set<java.lang.Class<? extends io.realm.RealmModel>> debugSchema, boolean excludeDebugSchema )

equals

public boolean equals ( Object obj )
Overrides `equals` in class Object

forRecovery

protected static RealmConfiguration forRecovery ( String canonicalPath, byte[] encryptionKey, RealmProxyMediator schemaMediator )

getAssetFilePath

public String getAssetFilePath ()
Returns the path to the Realm asset file. Returns path to the asset file relative to the asset directory or `null` if not asset file was specified.

getCompactOnLaunchCallback

public CompactOnLaunchCallback getCompactOnLaunchCallback ()
Returns a callback to determine if the Realm file should be compacted before being returned to the user. Returns a callback called when opening a Realm for the first time during the life of a process to determine if it should be compacted before being returned to the user. It is passed the total file size (data + free space) and the total bytes used by data in the file.

getDurability

public OsRealmConfig.Durability getDurability ()

getEncryptionKey

public byte getEncryptionKey ()

getFlowFactory

public FlowFactory getFlowFactory ()
Returns the FlowFactory that is used to create Kotlin Flows from Realm objects. Returns the factory instance used to create Flows. Throws UnsupportedOperationException - if the required coroutines framework is not on the classpath.

getInitialDataTransaction

protected Realm.Transaction getInitialDataTransaction ()
Returns the transaction instance with initial data. Returns the initial data transaction.

getInstance

protected Realm getInstance ( OsSharedRealm.VersionID version )

getMaxNumberOfActiveVersions

public long getMaxNumberOfActiveVersions ()
Returns the maximum number of active versions allowed before an exception is thrown.

getMigration

public RealmMigration getMigration ()

getPath

public String getPath ()
Returns the absolute path to where the Realm file will be saved. Returns the absolute path to the Realm file defined by this configuration.

getRealmDirectory

public File getRealmDirectory ()

getRealmFileName

public String getRealmFileName ()

getRealmObjectClasses

public Set getRealmObjectClasses ()
Returns the unmodifiable Set of model classes that make up the schema for this Realm. Returns unmodifiable Set of model classes.

getRxFactory

public RxObservableFactory getRxFactory ()
Returns the RxObservableFactory that is used to create Rx Observables from Realm objects. Returns the factory instance used to create Rx Observables. Throws UnsupportedOperationException - if the required RxJava framework is not on the classpath.

getSchemaMediator

protected RealmProxyMediator getSchemaMediator ()
Returns the mediator instance of schema which is defined by this configuration. Returns the mediator of the schema.

getSchemaVersion

public long getSchemaVersion ()

hasAssetFile

public boolean hasAssetFile ()
Indicates if an asset file has been configured for this configuration. Returns `true` if there is asset file, `false` otherwise.

hashCode

public int hashCode ()
Overrides `hashCode` in class Object

isAllowQueriesOnUiThread

public boolean isAllowQueriesOnUiThread ()
Returns whether a RealmQuery is allowed to be launched from the UI thread. By default Realm allows queries on the main thread. To disallow this users have to explicitly opt in with Builder.allowQueriesOnUiThread(boolean) or its Realm Sync builder counterpart. Returns whether or not queries are allowed to be run from the UI thread.

isAllowWritesOnUiThread

public boolean isAllowWritesOnUiThread ()
Returns whether calls to Realm.executeTransaction can be done on the UI thread. Note: Realm does not allow blocking transactions to be run on the main thread unless users explicitly opt in with Builder.allowWritesOnUiThread(boolean) or its Realm Sync builder counterpart. Returns whether or not write operations are allowed to be run from the UI thread.

isReadOnly

public boolean isReadOnly ()
Returns whether this Realm is read-only or not. Read-only Realms cannot be modified and will throw an IllegalStateException if Realm.beginTransaction() is called on it. Returns `true` if this Realm is read only, `false` if not.

isRecoveryConfiguration

public boolean isRecoveryConfiguration ()
Returns `true` if this configuration is intended to open a backup Realm (as a result of a client reset). Tip See also: {@link ClientResetRequiredError}

isSyncConfiguration

protected boolean isSyncConfiguration ()

realmExists

protected boolean realmExists ()
Checks if the Realm file defined by this configuration already exists.WARNING: This method is just a point-in-time check. Unless protected by external synchronization another thread or process might have created or deleted the Realm file right after this method has returned. Returns `true` if the Realm file exists, `false` otherwise.

shouldDeleteRealmIfMigrationNeeded

public boolean shouldDeleteRealmIfMigrationNeeded ()

toString

public String toString ()
Overrides `toString` in class Object

Back

RealmCollection

RealmConfiguration.Builder