Configurar e abrir um Realm - SDK do Flutter

Abra um Realm somente local

Para criar um realm que persista os dados apenas localmente, crie uma configuração com Configuration.local(). Você deve fornecer uma lista de esquemas como um argumento.

Passe o Configuration para o construtor Realm.

final config = Configuration.local([Car.schema]);
final realm = Realm(config);

Agora você pode usar essa instância de domínio para trabalhar com objetos no banco de dados.

Abrir um realm sincronizado

Para abrir um domínio que sincroniza dados com Atlas utilizando a Device Sync, consulte Abrir um Realm Sincronizado.

Abrir um Realm na memória

Para criar um realm que executa na memória sem ser persistente, crie seu Configuration com Configuration.inMemory(). Você deve fornecer uma lista de esquemas como um argumento. Os realms na memória também não podem ser somente para leitura.

Passe o Configuration para o construtor do Realm .

final config = Configuration.inMemory([Car.schema]);
final realm = Realm(config);

Abra um Realm somente leitura

Você pode abrir um domínio existente no modo somente leitura. Para abrir um domínio somente leitura, adicione readOnly: true ao seu objeto Configuration.

Você só pode abrir domínios existentes no modo somente leitura. Se você tentar gravar em um domínio somente leitura, ocorrerá um erro.

final config = Configuration.local([Car.schema], isReadOnly: true);
final realm = Realm(config);

Definir arquivos especiais FIFO personalizados

Definir um valor para os arquivos especiais FIFO do Realm localização. A abertura de um domínio cria uma série de arquivos especiais FIFO leves que coordenam o acesso ao domínio entre threads e processos. Se o arquivo de Realm estiver em um local que não permite a criação de arquivos especiais FIFO (como sistemas de arquivos FAT ), o domínio32 não poderá ser aberto. Nesse caso, o Realm precisa de um local diferente para armazenar esses arquivos. Adicione fifoFilesFallbackPath: <Your Custom FIFO File Path> ao seu Configuration objeto .

Esta propriedade será ignorada se o diretório do arquivo de realm permitir arquivos especiais FIFO.

final config = Configuration.local([Car.schema],
    fifoFilesFallbackPath: "./fifo_folder");
final realm = Realm(config);

Adicionar dados iniciais ao Realm

Usar initialDataCallback() para invocar uma função de retorno de chamada na primeira vez que você abrir um domínio. A função é executada somente na primeira vez que você abre esse domínio no dispositivo. A instância do domínio passada para a função de retorno de chamada já tem uma transação de gravação aberta, portanto, não é necessário envolver as operações de gravação em um Realm.write() bloco de transação . initialDataCallback pode ser útil para adicionar dados iniciais ao seu aplicativo na primeira vez que ele for aberto em um dispositivo.

void dataCb(Realm realm) {
  realm.add(Car(ObjectId(), 'Honda'));
}
final config =
    Configuration.local([Car.schema], initialDataCallback: dataCb);
final realm = Realm(config);
Car honda = realm.all<Car>()[0];

Personalizar configuração padrão

Você pode personalizar o caminho padrão em que o Realm armazena os arquivos do banco de dados e o nome padrão dado aos arquivos do banco de dados.

Use o estático Configuration.defaultRealmName e Configuration.defaultRealmPath para definir a configuração padrão para todos os domínios abertos dentro de um aplicativo.

Configuration.defaultRealmName = "myRealmName.realm";
final customDefaultRealmPath = path.join(
    (await Directory.systemTemp.createTemp()).path,
    Configuration.defaultRealmName);
Configuration.defaultRealmPath = customDefaultRealmPath;
// Configurations used in the application will use these values
final config = Configuration.local([Car.schema]);
// The path is your system's temp directory
// with the file named 'myRealmName.realm'
print(config.path);

Você também pode verificar onde o domínio armazena os arquivos por padrão usando o getter estático Configuration.defaultStoragePath. O valor dessa propriedade varia de acordo com a plataforma em que você está usando o SDK e se está usando as versões Dart ou Flutter do Realm. Verifique o valor do Configuration.defaultStoragePath em seu aplicativo para ver onde os arquivos de área são armazenados em seu ambiente.

final storagePath = Configuration.defaultStoragePath;
// See value in your application
print(storagePath);

Gerenciar alterações no esquema

Para obter mais informações sobre como gerenciar alterações de esquema ao configurar um domínio, consulte a documentação Atualizar um esquema de objetos de Realm.

Criptografar um Realm

Você pode criptografar seu realm local para garantir a segurança dos dados. Para mais informações, consulte Criptografar um Realm.

Compactar um domínio

Você pode reduzir o tamanho do arquivo de região local para melhorar o desempenho e gerenciar o tamanho do arquivo em um ambiente com restrição de recursos. Para mais informações, consulte Compact a Realm.