Início rápido - .NET SDK

Instalar Realm

Siga estas etapas para adicionar o .NET SDK a seu projeto.

Visual Studio para Mac

Visual Studio no Windows

1

Abrir o Gerenciador de pacotes NuGet

No Solution Explorer, clique com o botão direito do mouse em sua solução e selecione Manage NuGet Packages... para abrir a janela de gerenciamento do NuGet Package.

clique para ampliar

Observação

Adicionar o pacote no nível da Solução permite adicioná-lo a todos os projetos em uma única etapa.

2

Adicionar o pacote do Realm

Na barra de pesquisa, procure por Realm. Selecione o resultado e clique em Add Package. Se você estiver usando o Xamarin, poderá ser solicitado a selecionar quais projetos usam o pacote Realm. Selecione todos os projetos e clique em Ok.

1

Abrir o Gerenciador de pacotes NuGet

No Solution Explorer, clique com o botão direito do mouse em sua solução e selecione Manage NuGet Packages for Solution... para abrir a janela de gerenciamento do NuGet Package.

clique para ampliar

2

Adicionar o pacote do Realm

Na barra do Atlas Search , Atlas Search for Realm. Selecione o resultado e clique em Install. Quando solicitado, selecione todos os projetos e clique em Ok.

clique para ampliar

3

Adicionar o Realm Weaver ao FodyWeavers.xml

Observação

Você pode pular esta etapa se ainda não estiver usando Fody em seu projeto. O Visual Studio gerará um arquivo FodyWeavers.xml configurado corretamente para você quando você construir pela primeira vez.

Se o seu projeto já estava usando o Fody, você deve adicionar manualmente o Realm Weaver ao seu FodyWeavers.xml arquivo . Quando terminar, seu arquivo FodyWeavers.xml deverá ter a seguinte aparência:

<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
  <Realm />
</Weavers>

Importar Realm

Adicione a seguinte linha na parte superior dos seus arquivos de origem para usar o Realm:

using Realms;

Definir seu modelo de objeto

O modelo de objeto do aplicativo define os dados que você pode armazenar no Realm e sincronizar de e para o Atlas App Services.

O seguinte código mostra como definir um modelo de objeto para um objeto Item . Neste exemplo, marcamos o campo Id como chave primária e marcamos a propriedade Status como opcional. Também optamos por usar o atributo MapTo ; as propriedades serão armazenadas em letras minúsculas no servidor, mas podem usar letras maiúsculas e minúsculas compatíveis com .NET em nossos nomes de propriedade ao usar o Device Sync.

public partial class Item : IRealmObject
{
    [PrimaryKey]
    [MapTo("_id")]
    public ObjectId Id { get; set; } = ObjectId.GenerateNewId();
    [MapTo("assignee")]
    public string Assignee { get; set; }
    [MapTo("name")]
    public string? Name { get; set; }
    [MapTo("status")]
    public string? Status { get; set; }
}

Abra um Realm local

Em um domínio somente local, você abre um domínio com o método Realm.GetInstance() ou Realm.GetInstanceAsync() . O método que você usa depende inteiramente se e como você está usando padrões assíncronos em seu aplicativo. O seguinte código mostra como utilizar o GetInstance():

var realm = Realm.GetInstance();

Para mais informações, consulte: Abrir um Realm.

Criar, ler, atualizar e excluir objetos

Ao criar ou atualizar documentos, todas as gravações devem ocorrer em uma transação.

O código a seguir mostra dois métodos para criar um novo objeto de Realm. No primeiro exemplo, criamos o objeto primeiro e, em seguida, o adicionamos ao domínio dentro de um método WriteAsync() . No segundo exemplo, criamos o documento dentro do bloco WriteAsync , que retorna um objeto de domínio com o qual podemos trabalhar ainda mais.

var testItem = new Item
{
    Name = "Do this thing",
    Status = ItemStatus.Open.ToString(),
    Assignee = "Aimee"
};
await realm.WriteAsync(() =>
{
    realm.Add(testItem);
});
// Or 
var testItem2 =
    await realm.WriteAsync(() =>
    {
        return realm.Add<Item>(new Item
        {
            Name = "Do this thing, too",
            Status = ItemStatus.InProgress.ToString(),
            Assignee = "Satya"
        });
    }
);

A atualização de um documento é o mesmo que a criação de um novo, exceto pelo fato de que você define o parâmetro opcional update como true. Neste exemplo, criamos um novo objeto Item com um Id exclusivo. Em seguida, inserimos um item com o mesmo ID, mas um valor Name diferente. Como definimos o parâmetro update como true, o registro existente é atualizado com o novo nome.

var id = ObjectId.GenerateNewId();
var item1 = new Item
{
    Id = id,
    Name = "Defibrillate the Master Oscillator",
    Assignee = "Aimee"
};
// Add a new person to the realm. Since nobody with the existing Id
// has been added yet, this person is added.
await realm.WriteAsync(() =>
{
    realm.Add(item1, update: true);
});
var item2 = new Item
{
    Id = id,
    Name = "Fluxify the Turbo Encabulator",
    Assignee = "Aimee"
};
// Based on the unique Id field, we have an existing person,
// but with a different name. When `update` is true, you overwrite
// the original entry.
await realm.WriteAsync(() =>
{
    realm.Add(item2, update: true);
});
// item1 now has a Name of "Fluxify the Turbo Encabulator"
// and item2 was not added as a new Item in the collection.

Você também exclui itens dentro de um método WriteAsync() . O seguinte código mostra como excluir um único Item da coleção e como excluir uma coleção inteira:

realm.Write(() =>
{
    realm.Remove(myItem);
});
realm.Write(() =>
{
    realm.RemoveAll<Item>();
});

As páginas a seguir abordam cada um desses tópicos em mais detalhes:

• criar

• Update

• Excluir

Localizar, filtrar e classificar documentos

Você Atlas Search com o mecanismo de query Realm , usando LINQ ou o RQL (RQL). O exemplo a seguir encontra todos os objetos do tipo "Item":

var allItems = realm.All<Item>();

Você filtra os resultados usando LINQ ou RQL. Este exemplo usa LINQ para encontrar todos os itens que tenham o status de "Aberto":

var openItems = realm.All<Item>()
    .Where(i => i.Status == "Open");

Você também pode classificar os resultados usando LINQ ou RQL:

var sortedItems = realm.All<Item>()
    .OrderBy(i => i.Status);

Para obter detalhes sobre query, filtragem e classificação de documentos, consulte Filtrar e classificar dados - .NET SDK.

Fique atento às mudanças

À medida que as coleção de documento mudam, geralmente é importante fazer atualizações nos dados em um aplicativo cliente . Você pode assistir a um Realm, coleção ou objeto para alterações com o método SubscribeForNotifications() .

O exemplo a seguir mostra como adicionar um manipulador de notificações em uma coleção de domínio inteira:

// Observe realm notifications.
realm.RealmChanged += (sender, eventArgs) =>
{
    // The "sender" object is the realm that has changed.
    // "eventArgs" is reserved for future use.
    // ... update UI ...
};

Você também pode adicionar manipuladores de notificações em coleções e objetos individuais. Para mais informações, veja React a alterações.

Adicionar Device Sync (opcional)

Se você deseja sincronizar dados do Realm entre dispositivos, você pode configurar o Atlas App Services e habilitar a Device Sync. Depois de fazer isso, você adiciona a sincronização ao código do cliente.

app = App.Create(myRealmAppId);

var user = await app.LogInAsync(Credentials.Anonymous());

await user.LogOutAsync();

var config = new FlexibleSyncConfiguration(app.CurrentUser)
{
    PopulateInitialSubscriptions = (realm) =>
    {
        var myItems = realm.All<Item>().Where(n => n.OwnerId == myUserId);
        realm.Subscriptions.Add(myItems);
    }
};
// The process will complete when all the user's items have been downloaded.
var realm = await Realm.GetInstanceAsync(config);