Crie uma nova Instância de Realm, no caminho padrão.
Um erro quando um Realm sincronizado incompatível é aberto.
Crie uma nova Instância de Realm no caminho fornecido.
Obrigatório ao criar o Realm pela primeira vez.
Um erro se o Realm não puder ser aberto no caminho fornecido.
Um erro quando um Realm sincronizado incompatível é aberto.
Crie uma nova Instância de Realm usando a configuração fornecida. Se um Realm ainda não existir em config.path (ou Realm.defaultPath se não for fornecido), esse construtor o criará com o config.schema fornecido (que é necessário nesse caso). Caso contrário, a instância acessará o Realm existente do arquivo nesse caminho. Nesse caso, config.schema é opcional ou não foi alterado, a menos que config.schemaVersion seja incrementado, caso em que o Realm será migrado automaticamente para usar o novo esquema. No caso da sincronização baseada em query, o config.schema é necessário. Uma exceção será lançada se config.schema não estiver definido.
Obrigatório ao criar o Realm pela primeira vez.
Um erro se algo na configuração fornecida for inválido.
Um erro quando um Realm sincronizado incompatível é aberto.
Readonly sessãoA sessão de sincronização, se este for um Realm sincronizado
Static caminhoIndica se este Realm foi fechado.
true se fechado, false caso contrário.
2.1.0
Indica se este Realm contém algum objeto.
true se vazio, false caso contrário.
1.10.0
Indica se este Realm foi aberto na memória.
true se este Realm estiver na memória, caso contrário false .
Indica se este Realm está em migração.
true se estiver migrando, caso contrário false
12.3.0
Indica se este Realm está em uma transação de escrita.
true se em uma transação de escrita, false caso contrário.
1.10.3
Indica se este Realm foi aberto como somente leitura.
true se este Realm for somente leitura, false caso contrário.
0.12.0
O caminho para o arquivo onde este Realm está armazenado.
Uma string contendo o caminho para o arquivo onde este Realm está armazenado.
0.12.0
Uma representação normalizada do esquema fornecido na Configuração quando este Realm foi construído.
Uma array de CanonicalObjectSchema descrevendo todos os objetos neste Realm.
0.12.0
A versão atual do esquema do Realm.
A versão do esquema deste Realm, como um number.
0.12.0
O conjunto mais recente de assinaturas de Flexible Sync.
Um objeto SubscriptionSet .
Um erro se a Flexible Sync não estiver habilitada para esse aplicativo.
Adicione uma chamada de resposta de ouvinte para o eventName especificado.
O nome do evento que deve fazer com que a chamada de resposta seja chamada.
Função a ser chamada quando ocorre um evento de alteração. Cada chamada de resposta só será chamada uma vez por evento, independentemente do número de vezes que foi adicionada.
Um erro se um evento inválido eventName for fornecido, se o Realm estiver fechado ou se a chamada de resposta não for uma função.
Inicie uma transação de escrita.
Ao fazer uma transação, é altamente recomendável fazer o tratamento de erros. Se você não lidar com erros, seus dados podem se tornar inconsistentes. O tratamento de erros geralmente envolve o cancelamento da transação.
Um erro se já estiver na transação de escrita
realm.beginTransaction();
try {
realm.create('Person', { name: 'Arthur Dent', origin: 'Earth' });
realm.create('Person', { name: 'Ford Prefect', origin: 'Betelgeuse Five' });
realm.commitTransaction();
} catch (e) {
realm.cancelTransaction();
throw e;
}
Substitui todas as colunas de cadeia de caracteres neste Realm por uma coluna de enumeração de cadeia de caracteres e compacta o arquivo de reconhecimento de data center.
Não pode ser chamado de uma transação de escrita.
A compactação não ocorrerá se existirem outras Instância de Realm .
Enquanto a compactação estiver em andamento, as tentativas de outros threads ou processos de abrir o reconhecimento de data center aguardarão.
Esteja avisado que os requisitos de recursos para compactação são proporcionais à quantidade de dados em tempo real no banco de dados. A compactação grava o conteúdo do banco de dados em um arquivo de banco de dados temporário e, em seguida, substitui o banco de dados pelo temporário.
true se a compactação for bem-sucedida, false caso contrário.
Crie um novo RealmObject do tipo fornecido e com as propriedades especificadas. Para objetos marcados como assimétricos, undefined é retornado. A API para objetos assimétricos está sujeita a alterações futuras.
O tipo de objeto de Realm a ser criado.
Valores de propriedade para todas as propriedades necessárias sem um valor padrão.
Optional modo: booleano | Nunca | Modificado | TodosModo de atualização opcional. O padrão é UpdateMode.Never.
Um RealmObject ou undefined se o objeto for assimétrico.
Optional modo: booleano | Nunca | Modificado | TodosExclui um modelo de Realm, incluindo todos os seus objetos. Se chamado fora de uma função de migração, o esquema e o schemaVersion serão atualizados.
O nome do modelo.
Pesquisar um Objeto de Realm por sua chave primária.
Um RealmObject ou null se nenhum objeto for encontrado.
Um erro será gerado se o tipo passado para esse método for inválido, ou se o tipo de objeto não tiver uma primaryKey especificada no esquema, ou se for marcado como assimétrico.
0.14.0
Retorna todos os objetos do tipo fornecido no Realm.
O tipo de Objeto de Realm a serem recuperados.
Resultados que serão atualizados à medida que os objetos forem criados, modificados e destruídos.
Um erro se o tipo passado para este método for inválido ou se o tipo estiver marcado como incorporado ou assimétrico.
Remova todos os ouvintes de eventos (restringidos ao evento eventName, se fornecido).
Optional eventName: RealmEventNameO nome do evento cujos ouvintes devem ser removidos.
Um erro quando o evento eventName inválido é fornecido.
Remove a chamada de resposta do ouvinte para o evento especificado eventName.
O nome do evento.
Função que foi adicionada anteriormente como ouvinte para este evento por meio do método addListener .
um erro se um evento inválido eventName for fornecido, se o realm estiver fechado ou se a chamada de resposta não for uma função.
Chame de forma síncrona a chamada de resposta fornecida dentro de uma transação de escrita. Se acontecer uma exceção dentro de uma transação, você perderá as alterações nessa transação, mas o próprio Realm não será afetado (ou corrompido). Mais precisamente, getTransaction e commitTransaction serão chamados automaticamente. Se alguma exceção for lançada durante a transação, cancelTransaction será chamado em vez de commitTransaction e a exceção será lançada novamente para o chamador de write.
Transação agrupadas (chamando write dentro de write) não são possíveis.
Valor retornado da chamada de resposta.
Escreve uma cópia compactada do Realm com a configuração fornecida.
O arquivo de destino ainda não pode existir. Todas as conversões entre Realms sincronizados e não sincronizados são suportadas e serão realizadas de acordo com o parâmetro de configuração, que descreve a saída desejada.
Observe que, se esse método for chamado de dentro de uma transação de gravação, os dados atuais serão gravados, não os dados do ponto em que a transação de escrita anterior foi confirmada.
Configuração do Realm que descreve o Realm de saída.
Static copiarCopie quaisquer Arquivo de Realm (ou seja, *.realm) fornecidos com o aplicativo do diretório de aplicativos para o diretório de documentos do aplicativo, para que possam ser abertos e usados pelo Realm. Se o arquivo já existir no diretório de documentos, ele não será substituído, para que possa ser chamado com segurança várias vezes.
Isso deve ser chamado antes de abrir o Realm, a fim de mover o Arquivo de Realm para um local onde eles podem ser gravados.
// Given a bundled file, example.realm, this will copy example.realm (and any other .realm files)
// from the app bundle into the app's documents directory. If the file already exists, it will
// not be overwritten, so it is safe to call this every time the app starts.
Realm.copyBundledRealmFiles();
const realm = await Realm.open({
// This will open example.realm from the documents directory, with the bundled data in.
path: "example.realm"
});
Isso só é implementado para o React Native.
um erro se ocorrer um erro de E/S ou se o método não estiver implementado.
Static criarCria um objeto de modelo para uma classe de modelo Realm em que todos os campos opcionais são indefinidos e todos os campos obrigatórios têm o valor padrão para o tipo de dados fornecido, o valor definido pela propriedade padrão no esquema ou o valor padrão para o tipo de dados, se o esquema não especifica um, ou seja, 0, falso e "".
Esquema descrevendo o objeto que deve ser criado.
Static excluirExclua o Arquivo de Realm para a configuração fornecida.
A configuração do Realm que está sendo excluído.
Um erro se algo na configuração fornecida for inválido.
Static existeVerifica se o Realm já existe no disco.
O caminho para um Realm.
true se o Realm existir no dispositivo, false caso contrário.
Um erro se algo no caminho fornecido for inválido.
Verifica se o Realm já existe no disco.
A configuração de um Realm.
true se o Realm existir no dispositivo, false caso contrário.
Um erro se algo na configuração fornecida for inválido.
Static abrirAbra o Realm padrão de forma assíncrona com uma promessa.
Uma promessa que será resolvida com a Instância de Realm quando estiver disponível.
Abra um Realm de forma assíncrona com uma promessa. Se o Realm estiver sincronizado, ele será totalmente sincronizado antes de estar disponível.
O caminho para o Realm.
Uma promessa que será resolvida com a Instância de Realm quando estiver disponível.
Abra um Realm de forma assíncrona com uma promessa. Se o Realm estiver sincronizado, ele será totalmente sincronizado antes de estar disponível. No caso de sincronização baseada em query, Configuration.schema é necessário. Uma exceção será lançada se Configuration.schema não estiver definido.
A configuração do Realm.
Uma promessa que será resolvida com a Instância de Realm quando estiver disponível.
Um erro se algo na configuração fornecida for inválido.
Static Versão do esquemaObtenha a versão do esquema atual do Realm no caminho fornecido.
O caminho para o arquivo onde o banco de dados do Realm está armazenado.
Optional encryptionKey: ArrayBuffer | ArrayBufferViewNecessário apenas ao acessar Realms criptografados.
Versão do esquema como um número inteiro ou -1 se não existir nenhum Realm no caminho.
Um erro ao passar uma chave de criptografia inválida ou não correspondente.
0.11.0
Static definirDefine o nível de registro.
O nível de registro a ser usado pelo criador de logs. O valor padrão é info.
Optional categoria: "Realm" | "Realm.Storage" | "Realm.Storage.Transaction" | "Realm.Storage.Query" | "Realm.Storage.Object" | "Realm.Storage.Notification" | "Realm.Sync" | "Realm.Sync.Client" | "Realm.Sync.Client.Session" | "Realm.Sync.Client.Changeset" | "Realm.Sync.Client.Network" | "Realm.Sync.Client.Reset" | "Realm.Sync.Server" | "Realm.App" | "Realm.SDK"A categoria para a qual definir o nível de registro. Se omitido, o nível de registro é definido para todas as categorias ("Realm").
O nível de registro pode ser alterado durante a vida útil do aplicativo.
12.0.0
Realm.setLogLevel("all");
Static definirDefine a chamada de resposta do registrador.
A chamada de resposta invocada pelo criador de logs. A chamada de resposta padrão usa console.log, console.warn e console.error, dependendo do nível da mensagem.
A chamada de resposta do logger precisa ser configurada antes de abrir o primeiro Realm.
12.0.0
Realm.setLogger(({ category, level, message }) => {
console.log(`[${category} - ${level}] ${message}`);
});
Define a chamada de resposta do registrador.
A chamada de resposta invocada pelo criador de logs. A chamada de resposta padrão usa console.log, console.warn e console.error, dependendo do nível da mensagem.
A chamada de resposta do logger precisa ser configurada antes de abrir o primeiro Realm.
12.0.0
Passe um retorno de chamada usando um único argumento de objeto.
Realm.setLogger((level, message) => {
console.log(`[${level}] ${message}`);
});
Static desligarFecha todos os Realms, cancela todas as chamadas Realm.open pendentes, limpa os caches internos, redefine o registrador e coleta lixo. Chame esse método para liberar o loop de eventos e permitir que o Node.js execute uma saída normalmente.
Gerado usando TypeDoc
O Realm reconhecimento de data center.