类 RealmConfiguration
在此页面上
- io.realm
- 嵌套类摘要
- 字段摘要
- 方法摘要
- 继承方法
- 字段详细信息
DEFAULT_REALM_NAME
- 方法详细信息
- createSchemaMediator
- 等于
- forRecovery
- getAssetFilePath
- getCompactOnLaunchCallback
- getDurability
- getEncryptionKey
- getFlowFactory
- getInitialDataTransaction
- getInstance
- getMaxNumberOfActiveVersions
- getMigration
- getPath
- getRealmDirectory
- getRealmFileName
- getRealmObjectClasses
- getRxFactory
- getSchemaMediator
- getSchemaVersion
- hasAssetFile
- hashCode
- isAllowQueriesOnUiThread
- isAllowWritesOnUiThread
- isReadOnly
- isRecoveryConfiguration
- isSyncConfiguration
- realmExists
- shouldDeleteRealmIfMigrationNeeded
- toString
io.realm
RealmConfiguration 用于设置特定的 Realm 实例。 RealmConfiguration 的实例只能通过使用io.realm.RealmConfiguration.Builder并调用其io.realm.RealmConfiguration.Builder.build() 方法。
可以通过先将常用的 RealmConfiguration 保存为Realm.setDefaultConfiguration(RealmConfiguration)来轻松访问 然后使用io.realm.Realm.getDefaultInstance() 。
可以使用以下方法创建最小配置:
RealmConfiguration config = new RealmConfiguration.Builder().build()
这将创建一个具有以下属性的 RealmConfiguration。
Realm 文件名为“default.realm”
它保存在 Context.getFilesDir()
其模式版本设置为 0。
嵌套类摘要
修饰符和类型 | 类和描述 |
---|---|
public static |
字段摘要
修饰符和类型 | 字段和描述 |
---|---|
public static final String |
方法摘要
修饰符和类型 | 方法和说明 |
---|---|
protected static RealmProxyMediator | java.util.Set<java.lang.Object> modules, boolean excludeDebugSchema ) |
公共布尔值 | |
protected static RealmConfiguration | |
公共string | 返回 Realm 资产文件的路径。 |
返回回调,以确定在将 Realm 文件返回给用户之前是否应进行压缩。 | |
公共OsRealmConfig.Durability | |
公共字节 | |
返回用于从 Realm 对象创建 Kotlin 流的FlowFactory 。 | |
protected Realm.Transaction | 返回具有初始数据的事务实例。 |
protected Realm | |
公共长整型 | |
getMigration () | |
公共string | getPath () 返回 Realm 文件保存位置的绝对路径。 |
公共 文件 | |
公共string | |
公共 集合 | 返回不可修改的 Set 构成此 Realm 模式的模型类。 |
getRxFactory () 返回用于从 Realm 对象创建 Rx Observables 的RxObservableFactory 。 | |
protected RealmProxyMediator | 返回此配置定义的模式的中介实例。 |
公共长整型 | |
公共布尔值 | hasAssetFile () 指示是否已为此配置配置资产文件。 |
公共整型 | hashCode () |
公共布尔值 | 返回是否允许从用户界面线程启动RealmQuery 。 |
公共布尔值 | 返回是否可以在用户界面线程上调用Realm.executeTransaction 。 |
公共布尔值 | isReadOnly () 返回此 Realm 是否为只读。 |
公共布尔值 | |
受保护的布尔值 | |
受保护的布尔值 | realmExists () 检查此配置定义的 Realm 文件是否已存在。 |
公共布尔值 | |
公共string | toString () |
继承方法
从类 java.lang.Object 继承的方法 :
getClass
、hashCode
、equals
、clone
、toString
、notify
、notifyAll
、wait
、wait
、wait
、finalize
字段详细信息
DEFAULT_REALM_NAME
方法详细信息
createSchemaMediator
protected static RealmProxyMediator createSchemaMediator ( java.util.Set<java.lang.Object> modules, boolean excludeDebugSchema ) |
---|
等于
forRecovery
protected static RealmConfiguration forRecovery ( ) |
---|
getAssetFilePath
public String getAssetFilePath () |
---|
返回 Realm 资产文件的路径。 返回: 相对于资产目录的资产文件路径,如果未指定资产文件,则为 |
getCompactOnLaunchCallback
返回回调,以确定在将 Realm 文件返回给用户之前是否应进行压缩。 返回: 在进程生命周期中首次打开 Realm 时调用的回调,以确定在将其返回给用户之前是否应进行压缩。 系统会向其传递总文件大小(数据 + 可用空间)以及文件中数据使用的总字节数。 |
getDurability
public OsRealmConfig.Durability getDurability () |
---|
getEncryptionKey
public byte getEncryptionKey () |
---|
getFlowFactory
public FlowFactory getFlowFactory () |
---|
返回用于从 Realm 对象创建 Kotlin 流的FlowFactory 。 返回: 用于创建流的工厂实例。 抛出异常
|
getInitialDataTransaction
protected Realm.Transaction getInitialDataTransaction () |
---|
返回具有初始数据的事务实例。 返回: 初始数据事务。 |
getInstance
getMaxNumberOfActiveVersions
public long getMaxNumberOfActiveVersions () |
---|
返回: 抛出异常之前允许的最大活动版本数。 |
getMigration
public RealmMigration getMigration () |
---|
getPath
getRealmDirectory
public File getRealmDirectory () |
---|
getRealmFileName
public String getRealmFileName () |
---|
getRealmObjectClasses
public Set getRealmObjectClasses () |
---|
getRxFactory
public RxObservableFactory getRxFactory () |
---|
返回用于从 Realm 对象创建 Rx Observables 的RxObservableFactory 。 返回: 用于创建 Rx Observables 的工厂实例。 抛出异常
|
getSchemaMediator
protected RealmProxyMediator getSchemaMediator () |
---|
返回此配置定义的模式的中介实例。 返回: 模式的中介。 |
getSchemaVersion
public long getSchemaVersion () |
---|
hasAssetFile
public boolean hasAssetFile () |
---|
指示是否已为此配置配置资产文件。 返回:
|
hashCode
isAllowQueriesOnUiThread
public boolean isAllowQueriesOnUiThread () |
---|
返回是否允许从用户界面线程启动RealmQuery 。 默认情况下,Realm 允许在主线程上进行查询。 要禁止此行为,用户必须使用Builder.allowQueriesOnUiThread(boolean)或其 Realm Sync 构建器对应项显式选择加入。 返回: 是否允许从用户界面线程运行查询。 |
isAllowWritesOnUiThread
public boolean isAllowWritesOnUiThread () |
---|
返回是否可以在用户界面线程上调用Realm.executeTransaction 。 注意:除非用户使用Builder.allowWritesOnUiThread(boolean)或其 Realm Sync 构建器对应项明确选择加入,否则 Realm 不允许在主线程上运行阻塞事务。 返回: 是否允许从用户界面线程运行写入操作。 |
isReadOnly
public boolean isReadOnly () |
---|
返回此 Realm 是否为只读。 只读 Realm 无法修改,且会抛出 IllegalStateException 如果对其调用 Realm.beginTransaction() 。 返回:
|
isRecoveryConfiguration
public boolean isRecoveryConfiguration () |
---|
返回:
提示另请参阅:
|
isSyncConfiguration
protected boolean isSyncConfiguration () |
---|
realmExists
protected boolean realmExists () |
---|
检查此配置定义的 Realm 文件是否已存在。警告: 此方法仅用于时间点检查。 除非受外部同步保护,否则其他线程或进程可能会在此方法返回后立即创建或删除 Realm 文件。 返回:
|
shouldDeleteRealmIfMigrationNeeded
public boolean shouldDeleteRealmIfMigrationNeeded () |
---|