类 RealmConfigurationBase

用于指定影响 Realm 行为的配置设置的基类。
其主要角色是从用户提供的任何绝对、相对子目录或文件名生成规范路径。

继承

对象

RealmConfigurationBase

InMemoryConfiguration

RealmConfiguration

SyncConfigurationBase

命名空间： Realms

程序集：Realm.dll

语法

public abstract class RealmConfigurationBase

属性

DatabasePath

获取使用此配置打开的 Realm 的完整路径。 可以通过传入单独的名称来覆盖。

声明

public string DatabasePath { get; }

属性值

类型	说明
字符串	Realm 的绝对路径。

DefaultRealmName

获取要与特定于平台的文档目录合并的文件名。

声明

public static string DefaultRealmName { get; }

属性值

类型	说明
字符串	仅表示文件名，不表示路径的字符串。

FallbackPipePath

获取或设置 Realm 使用的命名管道的放置路径。

声明

public string? FallbackPipePath { get; set; }

属性值

类型	说明
字符串	可以在其中创建命名管的路径。

备注

在绝大多数情况下，该值应留空。 如果在无法创建命名管的文件系统（例如 Android 上使用 FAT32 的外部存储）上打开 Realm，则需要设置该值。在这种情况下，该点应管文件系统上可以创建管的位置。

IsDynamic

获取或设置一个值，该值指示 Realm 是否以动态模式打开。 如果以动态模式打开，将从磁盘上的文件读取模式。

声明

public bool IsDynamic { get; set; }

属性值

类型	说明
bool	true 是否以动态模式打开 Realm；否则false 。

MaxNumberOfActiveVersions

获取或设置引发异常之前允许的最大活动版本数。

声明

public ulong MaxNumberOfActiveVersions { get; set; }

属性值

类型	说明
ulong

另请参阅

冻结()

架构

获取或设置使用此配置打开的 Realm 的模式。

声明

public RealmSchema Schema { get; set; }

属性值

类型	说明
Realm 模式	可在 Realm 中持久化的类型的模式。

备注

通常留空，因此默认情况下，所有IRealmObject和IEmbeddedObject实例都能够存储在所有 Realm 中。
如果显式指定模式，则可以使用从Type[]到RealmSchema的隐式转换操作符，或使用RealmSchema.Builder API 进行构造。

示例

config.Schema = new Type[]
{
    typeof(CommonClass),
    typeof(RareClass)
};

// Alternatively
config.Schema = new RealmSchema.Builder
{
    new ObjectSchema.Builder("Person")
    {
        Property.Primitive("Name", RealmValueType.String, isPrimaryKey: true),
        Property.Primitive("Birthday", RealmValueType.Date, isNullable: true),
        Property.ObjectList("Addresses", objectType: "Address")
    },
    new ObjectSchema.Builder("Address")
    {
        Property.Primitive("City", RealmValueType.String),
        Property.Primitive("Street", RealmValueType.String),
    }
}

模式版本

获取或设置一个数字，表示模式的版本。 可用于任意区分模式，即使它们具有相同的对象和属性。

声明

public ulong SchemaVersion { get; set; }

属性值

类型	说明
ulong	从 0 开始的值最初设置为零，因此所有用户设置的值都将更大。

ShouldCompactOnLaunch

获取或设置启动时压缩回调。

声明

public RealmConfigurationBase.ShouldCompactDelegate? ShouldCompactOnLaunch { get; set; }

属性值

类型	说明
RealmConfigurationBase 。 ShouldCompactDelegate	RealmConfigurationBase.ShouldCompactDelegate在首次打开Realm时被调用，以确定在将其返回给用户之前是否应进行压缩。

方法

GetPathToRealm(string?)

用于构建在其中创建 Realm 的路径的实用程序，以便可以一致地使用文件名和相对路径。

声明

public static string GetPathToRealm(string? optionalPath = null)

参数

类型	名称	说明
字符串	可选路径	Realm 的路径必须是当前平台的有效完整路径、相对子目录或只是文件名。

返回：

类型	说明
字符串	包括 Realm 文件名称的完整路径。