タイプ エイリアス baseConfiguration

基本構成: {
    deleteRealmIfMigrationMoneded?: ブール値;
    disableFormatアップグレード?: ブール値;
    encryptionKey?: Arrayバッファ | Arrayバッファビュー | Int8Array;
    fifoFilesFallbackPath?: string;
    インメモリ?: ブール値;
    migrationOptions?: MigrationOptions;
    onFirstOpen?: ((realm) => void);
    onMigration?: MigrationCallback;
    path?: string;
    readOnly?: ブール値;
    スキーマ?: (RealmObjectConstructor<AnyRealmObject> | ObjectSchema)[];
    schemaVersion?: 数値;
    ShouldCompact?: ((totalBytes usedBytes ) => ブール値 )
: 同期
}

Realmインスタンスの作成に使用されるオプション。

型宣言

  • Optional 移行が必要な場合は Realm を削除?: ブール値

    移行が必要な場合にこの Realm を削除するかどうかを指定します。 オプションはオプションsyncと互換性がありません。 @default: false

    以来

    1.13.0

  • Optional 形式のアップグレードを無効にする?: ブール値

    この Realm のファイル形式が、古いバージョンの Realm ライブラリで作成された場合に、自動的にアップグレードするかどうかを指定します。 trueに設定されており、ファイル形式のアップグレードが必要な場合は、代わりにエラーがスローされます。

    default

    false
    

    以来

    2.1.0

  • Optional 暗号化のキー?: Arrayバッファ | Arrayバッファビュー | Int8Array

    Realm 内のすべてのデータを暗号化および復号化するために使用される 512 ビット(64 バイト)の暗号化キー。

    以来

    0.11.1

  • Optional find ファイルのフォールバック パス?: string

    Realm を起動すると、スレッドやプロセス全体で Realm へのアクセスを調整するために、多数の FIFO 特殊ファイルが作成されます。 Realm ファイルが FIFO 特殊ファイルの作成を許可していないロケーション(例: FAT32 ファイル システム)の場合は、Realm を開くことができません。 その場合、Realm はこれらのファイルを保存するために別の場所が必要であり、このプロパティはその場所を定義します。 FIFO 特殊ファイルは非常に軽量で、メインの Realm ファイルは引き続きpathプロパティで定義された場所に保存されます。 pathで定義されたディレクトリで FIFO 特殊ファイルが許可されている場合、このプロパティは無視されます。

    以来

    2.23.0

  • Optional メモリ内?: ブール値

    この Realm をメモリ内で開くかどうかを指定します。 これには、Realm を識別するためのパス(デフォルト パスにすることもできます)が必要であり、他のプロセスが同じ Realm を開くことができます。 Realm がメモリに収まる範囲よりも大きくなった場合、ファイルはスワップ領域としても使用されますが、永続的ではなく、最後のインスタンスが閉じられると削除されます。 このオプションはオプションsyncと互換性がありません。

    default

    false
    

    以来

    0.10.0

  • Optional 移行オプション?: MigrationOptions
  • Optional 最初のオープンでの?: ((realm) => void)

    Realm を初めて開くときに呼び出される関数。 この関数は、Realm を開く前にRealm にデータを入力できます。 コールバックを呼び出すと、Realm は書込みトランザクション (write transaction) になります。

    Param: realm

    新しく作成された Realm。

    以来

    10.14.0

      • (realm): void
      • Realm を初めて開くときに呼び出される関数。 この関数は、Realm を開く前にRealm にデータを入力できます。 コールバックを呼び出すと、Realm は書込みトランザクション (write transaction) になります。

        パラメーター

        • realm: Realm

          新しく作成された Realm。

        Returns void

        以来

        10.14.0

  • Optional 移行について?: MigrationCallback

    移行が必要な場合に実行する関数。

    この関数は、以前のスキーマから新しいスキーマにデータモデルを変換するためのすべてのロジックを提供します。 このオプションはオプションsyncと互換性がありません。

    この関数は 2 つの引数を取ります。

    • oldRealm - 移行が実行される前の Realm。
    • newRealm - 最新のschemaを使用する Realm。必要に応じて変更する必要があります。

    以来

    0.12.0

  • Optional path?: string

    Realm データベースを保存するファイルへのパス。 同期された Realm では、他のアプリやユーザーとの衝突を避けるために、相対パスがAppConfigurationUser.idとともに使用されます。 絶対パスは変更されず、一部のプラットフォーム(iOS および Android)では、アプリにファイルを作成または開く権限がない場合があります。権限は検証されません。 相対パスが指定されている場合は、AppConfiguration.baseFilePath を基準にしています。

    以来

    0.10.0

  • Optional 読み取り専用?: ブール値

    この Realm を読み取り専用として開くかどうかを指定します。

    default

    false
    

    以来

    0.10.0

  • Optional スキーマ?: (RealmObjectConstructor<AnyRealmObject> | ObjectSchema)[]

    この Realm 内のすべてのオブジェクトタイプを指定します。 このpathで Realm を初めて作成するときに必要です。 省略した場合、スキーマは既存の Realm ファイルから読み取られます。

    以来

    0.10.0

  • Optional スキーマのバージョン?: 数値

    schemaを変更する場合は、このフィールドは必須であり、増加させる必要があります。 これは、ローカル Realm にのみ適用されます。

    以来

    0.11.0

  • Optional を圧縮する必要があります?: ((totalBytesusedBytes ) =>ブール値)

    この関数は、プロセスの有効期間中に初めて Realm を開き、ユーザーに返される前に圧縮する必要があるかどうかを判断するときに呼び出されます。

    ファイルを圧縮する試行を行う必要があることを示すtrueが返されます。 圧縮は、別のプロセスがアクセスしている場合はスキップされます。

    パラメーター: totalBytes

    合計ファイルサイズ(データ + 空き領域)。

    パラメーター: usedBytes

    ファイル内のデータによって使用される合計バイト数。

    戻り値

    true Realm ファイルを開く前に圧縮する必要がある場合は、。

    以来

    2.9.0

    // compact large files (>100 MB) with more than half is free space
    shouldCompact: (totalBytes, usedBytes) => {
    const oneHundredMB = 100 * 1024 * 1024; // 100 MB
    return totalBytes > oneHundredMB && usedBytes / totalBytes < 0.5;
    }
      • (totalBytesusedBytes ) :ブール値
      • この関数は、プロセスの有効期間中に初めて Realm を開き、ユーザーに返される前に圧縮する必要があるかどうかを判断するときに呼び出されます。

        ファイルを圧縮する試行を行う必要があることを示すtrueが返されます。 圧縮は、別のプロセスがアクセスしている場合はスキップされます。

        パラメーター

        • totalBytes :数値

          合計ファイルサイズ(データ + 空き領域)。

        • usedBytes :数値

          ファイル内のデータによって使用される合計バイト数。

        ブール値を返します

        true Realm ファイルを開く前に圧縮する必要がある場合は、。

        以来

        2.9.0

        // compact large files (>100 MB) with more than half is free space
        shouldCompact: (totalBytes, usedBytes) => {
        const oneHundredMB = 100 * 1024 * 1024; // 100 MB
        return totalBytes > oneHundredMB && usedBytes / totalBytes < 0.5;
        }
  • Optional 同期?: SyncConfiguration

TypeDocを使用して生成