유형 별칭 BaseConfiguration

기본 구성: {
    deleteRealmIFMigrationNeded?: 부울;
    disableFormatUpgrade?: 부울;
    encryptionKey?: 배열 버퍼 | 배열버퍼뷰 | Int8Array;
    FIFOFilesFallbackPath?: 문자열;
    inMemory?: 부울;
    migrationOptions?: MigrationOptions;
    onFirstOpen?: ((Realm) => void);
    onMigration?: MigrationCallback;
    경로?: 문자열;
    읽기 전용?: 부울;
    스키마?: (RealmObject 생성자<AnyRealmObject> | 객체 스키마)[];
    스키마 버전?: 숫자;
    shouldCompact?: ((totalBytes, usedBytes) => boolean);
    sync?: SyncConfiguration;
}

Realm 인스턴스를 만드는 데 사용되는 옵션입니다.

유형 선언

  • Optional 마이그레이션이필요한 경우 Realm 삭제?: 부울

    마이그레이션이 필요한 경우 이 Realm을 삭제할지 여부를 지정합니다. 이 옵션은 sync 옵션과 호환되지 않습니다. @default: false

    이후

    1.13.0

  • Optional 형식업그레이드 비활성화?: 부울

    이 Realm의 파일 형식이 이전 버전의 Realm 라이브러리로 생성된 경우 자동으로 업그레이드되는지 여부를 지정합니다. true 로 설정되어 있고 파일 형식 업그레이드가 필요한 경우 대신 오류가 발생합니다.

    기본값

    false

    이후

    2.1.0

  • Optional 암호화 키?: 배열 버퍼 | 배열버퍼뷰 | Int8Array

    Realm의 모든 데이터를 암호화하고 해독하는 데 사용되는 512비트(64바이트) 암호화 키입니다.

    이후

    0.11.1

  • Optional FIFO파일폴백경로?: 문자열

    Realm을 열면 스레드와 프로세스 전반에 걸쳐 Realm에 대한 액세스를 조정하기 위해 여러 개의 FIFO 특수 파일이 생성됩니다. Realm 파일이 FIFO 특수 파일 생성을 허용하지 않는 위치에 저장된 경우(예: FAT32 파일 시스템)인 경우 Realm을 열 수 없습니다. 이 경우 Realm은 이러한 파일을 저장하기 위해 다른 위치가 필요하며 이 속성이 해당 위치를 정의합니다. FIFO 특수 파일은 매우 가벼우며 기본 Realm 파일은 여전히 path 속성으로 정의된 위치에 저장됩니다. path 로 정의된 디렉토리가 FIFO 특수 파일을 허용하는 경우 이 속성은 무시됩니다.

    이후

    2.23.0

  • Optional in Memory?: 부울

    이 Realm을 인메모리에서 열어야 하는지 여부를 지정합니다. 이 경우에도 Realm을 식별하는 경로(기본 경로일 수 있음)가 필요하므로 다른 프로세스에서 동일한 Realm을 열 수 있습니다. Realm이 메모리에 들어가는 크기보다 커지면 파일도 스왑 공간으로 사용되지만, 영구적이지 않으며 마지막 인스턴스가 닫힐 때 제거됩니다. 이 옵션은 sync 옵션과 호환되지 않습니다.

    기본값

    false

    이후

    0.10.0

  • Optional 마이그레이션 옵션?: MigrationOptions
  • Optional 처음열 때?: ((Realm) => void)

    Realm을 처음 열 때 호출되는 함수입니다. 이 함수는 Realm을 열기 전에 Realm을 채울 수 있습니다. 콜백을 호출하면 Realm은 쓰기 트랜잭션(write transaction) 상태가 됩니다.

    매개 변수: Realm

    새로 생성된 Realm입니다.

    이후

    10.14.0

      • (Realm): void

      • Realm을 처음 열 때 호출되는 함수입니다. 이 함수는 Realm을 열기 전에 Realm을 채울 수 있습니다. 콜백을 호출하면 Realm은 쓰기 트랜잭션(write transaction) 상태가 됩니다.

        매개변수

        • realm : Realm

          새로 생성된 Realm입니다.

        반환 값 void

        이후

        10.14.0

  • Optional on마이그레이션?: MigrationCallback

    마이그레이션이 필요한 경우 실행할 함수입니다.

    이 함수는 Realm 데이터 모델을 이전 스키마의 새 스키마로 변환하기 위한 모든 로직을 제공해야 합니다. 이 옵션은 sync 옵션과 호환되지 않습니다.

    이 함수는 두 개의 인수를 사용합니다:

    • oldRealm - 마이그레이션이 수행되기 전의 Realm입니다.
    • newRealm - 최신 schema 을 사용하는 Realm으로, 필요에 따라 수정해야 합니다.

    이후

    0.12.0

  • Optional 경로?: 문자열

    Realm 데이터베이스를 저장해야 하는 파일의 경로입니다. 동기화된 Realms의 경우 다른 앱이나 사용자와의 충돌을 방지하기 위해 상대 경로가 AppConfiguration 및 User.id 와 함께 사용됩니다. 절대 경로는 그대로 유지되며 일부 플랫폼(iOS 및 Android)에서는 앱에 파일을 만들거나 열 수 있는 권한이 없을 수 있으며 - 권한의 유효성이 검사되지 않습니다. 상대 경로를 지정하면 AppConfiguration.baseFilePath를 기준으로 합니다.

    이후

    0.10.0

  • Optional 읽기전용?: 부울

    이 Realm을 읽기 전용으로 열어야 하는지 여부를 지정합니다.

    기본값

    false

    이후

    0.10.0

  • Optional 스키마?: (RealmObject 생성자<AnyRealmObject> | 객체 스키마)[]

    이 Realm의 모든 Realm 객체 유형을 지정합니다. 이 path 에서 Realm을 처음 생성할 때 필요 합니다. 생략하면 기존 Realm 파일에서 스키마를 읽습니다.

    이후

    0.10.0

  • Optional schema버전?: 숫자

    schema 을 변경하는 경우 이 필드는 필수 이며 증가해야 합니다. 이는 로컬 Realm에만 적용됩니다.

    이후

    0.11.0

  • Optional 압축해야함?: ((totalBytes, usedBytes) => boolean)

    사용자에게 반환되기 전에 압축해야 하는지 여부를 결정하기 위해 프로세스 수명 동안 처음으로 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;
    }
      • (totalBytes, usedBytes): 부울

      • 사용자에게 반환되기 전에 압축해야 하는지 여부를 결정하기 위해 프로세스 수명 동안 처음으로 Realm을 열 때 호출되는 함수입니다.

        true 을 반환하여 파일 압축을 시도해야 함을 나타냅니다. 다른 프로세스가 압축에 액세스하면 압축을 건너뜁니다.

        매개변수

        • totalBytes: number

          총 파일 크기(데이터 + 여유 공간)입니다.

        • 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을 사용하여 생성됨