Optional exclua oEspecifica se este Realm deve ser excluído se uma migração for necessária. A opção é incompatível com a opção sync. @default: false
1.13.0
Optional desabilitar a atualização do formato?: booleanoEspecifica se o formato de arquivo desse Realm deve ser atualizado automaticamente se tiver sido criado com uma versão mais antiga da biblioteca do Realm. Se definido como true e uma atualização do formato de arquivo for necessária, será gerado um erro.
false
2.1.0
Optional A chave de criptografia de 512 bits (64 bytes) usada para criptografar e descriptografar todos os dados no Realm.
0.11.1
Optional caminho de contingência dos arquivos fifoA abertura de um Realm cria uma série de arquivos especiais FIFO para coordenar o acesso ao Realm entre threads e processos. Se o arquivo Realm estiver armazenado em um local que não permite a criação de arquivos especiais FIFO (por exemplo sistemas de arquivos FAT32), o Realm não poderá ser aberto. Nesse caso, o Realm precisa de um local diferente para armazenar esses arquivos e esta propriedade define esse local. Os arquivos especiais FIFO são muito leves e o arquivo Realm principal ainda será armazenado no local definido pela propriedade path . Esta propriedade será ignorada se o diretório definido por path permitir arquivos especiais FIFO.
2.23.0
Optional inMemoryEspecifica se este Realm deve ser aberto na memória. Isso ainda exige um caminho (pode ser o caminho padrão) para identificar o Realm, para que outros processos possam abrir o mesmo Realm. O arquivo também será usado como espaço de troca se o Realm ficar maior do que o que cabe na memória, mas não for persistente e será removido quando a última instância for fechada. Esta opção é incompatível com a opção sync.
false
0.10.0
Optional opções de migraçãoOptional naA função chamada ao abrir um Realm pela primeira vez. A função pode preencher o Realm antes de abri-lo. Ao chamar o retorno de chamada, o Realm estará em uma transação de escrita.
O Realm recém-criado.
10.14.0
A função chamada ao abrir um Realm pela primeira vez. A função pode preencher o Realm antes de abri-lo. Ao chamar o retorno de chamada, o Realm estará em uma transação de escrita.
O Realm recém-criado.
10.14.0
Optional naA função a ser executada se uma migração for necessária.
Essa função deve fornecer toda a lógica para converter modelos de dados de esquemas anteriores para o novo esquema. Esta opção é incompatível com a opção sync .
A função usa dois argumentos:
oldRealm - O Realm antes da migração ser realizada.newRealm - O Realm que usa o schema mais recente, que deve ser modificado conforme necessário.0.12.0
Optional caminho?: stringO caminho para o arquivo onde o banco de dados Realm deve ser armazenado. Para Realms sincronizados, um caminho relativo é usado junto com o AppConfiguration e o User.id para evitar colisões com outros aplicativos ou usuários. Um caminho absoluto é deixado intocado e, em algumas plataformas (iOS e Android), o aplicativo pode não ter permissões para criar ou abrir o arquivo - as permissões não são validadas. Se um caminho relativo for especificado, ele será relativo a AppConfiguration.baseFilePath.
0.10.0
Optional Especifica se este Realm deve ser aberto como somente leitura.
false
0.10.0
Optional schema?: (RealmObjectConstrutor<AnyRealmObject> | Esquema de objetos)[]Especifica todos os Tipo de objeto de Realm neste Realm. Obrigatório ao criar um Realm pela primeira vez neste path. Se omitido, o esquema será lido a partir do Arquivo de Realm existente.
0.10.0
Optional Versão do esquemaSe alterar schema , este campo será obrigatório e deverá ser incrementado. Isso se aplica apenas aos Realms locais.
0.11.0
Optional deveA função chamada ao abrir um Realm pela primeira vez durante a vida de um processo para determinar se ele deve ser compactado antes de ser retornado ao usuário.
Ele retorna true para indicar que deve ser feita uma tentativa de compactar o arquivo. A compactação será ignorada se outro processo estiver acessando-a.
O tamanho total do arquivo (dados + espaço livre).
O total de bytes usados pelos dados no arquivo.
true se o Arquivo de Realm precisar ser compactado antes de ser aberto.
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;
}
A função chamada ao abrir um Realm pela primeira vez durante a vida de um processo para determinar se ele deve ser compactado antes de ser retornado ao usuário.
Ele retorna true para indicar que deve ser feita uma tentativa de compactar o arquivo. A compactação será ignorada se outro processo estiver acessando-a.
O tamanho total do arquivo (dados + espaço livre).
O total de bytes usados pelos dados no arquivo.
true se o Arquivo de Realm precisar ser compactado antes de ser aberto.
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 sincronizar?: SyncConfigurationGerado usando TypeDoc
As opções usadas para criar uma Instância de Realm.