クラス RealmConfigurationBase

Realm の動作に影響を与える構成設定を指定するための基本クラス。
その主な役割は、絶対、相対サブディレクトリ、またはユーザーが指定したファイル名から標準パスを生成することです。

継承

オブジェクト

RealmConfigurationBase

InMemoryConfiguration

RealmConfiguration

SyncConfigurationBase

Namespace: Realms

組み立て: Realm.dll

構文

public abstract class RealmConfigurationBase

プロパティ

DatabasePath

この構成で開かれた Realm の完全なパスを取得します。 別の名前を渡すことで上書きできます。

宣言

public string DatabasePath { get; }

プロパティ値

タイプ	説明
string	Realm への絶対パス。

DefaultRealmName

プラットフォーム固有のドキュメント ディレクトリと結合するファイル名を取得します。

宣言

public static string DefaultRealmName { get; }

プロパティ値

タイプ	説明
string	ファイル名のみを表す string で、パスは含まれません。

フォールバックパイプパス

Realm で使用される名前付きパイプを配置できるパスを取得または設定します。

宣言

public string? FallbackPipePath { get; set; }

プロパティ値

タイプ	説明
string	名前付きパイプを作成できるパス。

コメント

ほとんどの場合、この値は null のままにする必要があります。 FAT32 を使用する Android の外部ストレージなど、名前付きパイプを作成できないファイルシステムで Realm を開く場合は、 を設定する必要があります。 この場合、パスは、パイプを作成できるファイルシステム上のロケーションを指す必要があります。

Is動的

Realm が 動的モードで開くかどうかを示す値を取得または設定します。 動的モードで開くと、ディスク上の ファイルからスキーマが読み取られます。

宣言

public bool IsDynamic { get; set; }

プロパティ値

タイプ	説明
ブール	true Realm が 動的モードで開かれる場合それ以外の場合は、 false 。

MaxNumberOfActiveVersions

例外がスローされる前に許可されるアクティブなバージョンの最大数を取得または設定します。

宣言

public ulong MaxNumberOfActiveVersions { get; set; }

プロパティ値

タイプ	説明
ulong

その他の参照

フリーズ（）

スキーマ

この構成で開かれた Realm のスキーマを取得または設定します。

宣言

public RealmSchema Schema { get; set; }

プロパティ値

タイプ	説明
RealmSchema	Realm で永続化できるタイプのスキーマ。

コメント

通常、null のままにすることで、デフォルトですべてのIRealmObjectとI embeddedObjectインスタンスをすべての 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),
    }
}

schemaVersion

スキーマのバージョンを示す数値を取得または設定します。 同じオブジェクトとプロパティを持つ場合でも、スキーマを任意に区別するために使用できます。

宣言

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)

パラメーター

タイプ	名前	説明
string	automaticPath	Realm へのパスは、現在のプラットフォームの有効な完全パス、相対サブディレクトリ、またはファイル名だけである必要があります。

戻り値

タイプ	説明
string	Realm ファイルの名前を含むフルパス。