Inicio rápido - SDK .NET

Install Realm

Follow these steps to add the .NET SDK to your project.

Visual Studio para Mac

Visual Studio on Windows

1

Open the NuGet Package Manager

En el Explorador de soluciones, haga clic derecho en su solución y seleccione Manage NuGet Packages... para abrir la ventana de administración de paquetes NuGet.

haga clic para ampliar

Nota

Adding the package at the Solution level allows you to add it to every project in one step.

2

Añadir el paquete Realm

En la barra de búsqueda, busca Realm. Selecciona el resultado y haz clic en Add Package. Si usas Xamarin, es posible que se te solicite seleccionar qué proyectos utilizan el paquete Realm. Selecciona todos los proyectos y luego haz clic en Ok.

1

Open the NuGet Package Manager

In the Solution Explorer, right-click your solution and select Manage NuGet Packages for Solution... to open the NuGet Package management window.

haga clic para ampliar

2

Añadir el paquete Realm

En la barra de búsqueda, buscar Realm. Selecciona el resultado y haz clic en Install. Cuando se solicite, selecciona todos los proyectos y haz clic en Ok.

haga clic para ampliar

3

Add the Realm Weaver to FodyWeavers.xml

Nota

Puedes omitir este paso si aún no lo estabas usando Comida en su proyecto. Visual Studio generará un archivo correctamente configurado. FodyWeavers.xml archivo para usted cuando realiza la primera compilación.

If your project was already using Fody, you must manually add the Realm weaver to your FodyWeavers.xml file. When done, your FodyWeavers.xml file should look something like this:

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

Import Realm

Agregue la siguiente línea en la parte superior de sus archivos de origen para usar Realm:

using Realms;

Define tu modelo de objeto

El modelo de objeto de tu aplicación define los datos que puedes almacenar dentro de Realm y sincronizar hacia y desde App Services.

The following code shows how to define an object model for an Item object. In this example, we have marked the Id field as the Primary Key and marked the Status property as optional. We've also chosen to use the MapTo attribute; properties will be stored in lower case on the server, but can use .NET-friendly casing on our property names when using 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; }
}

Abrir un Realm local

In a local-only realm, you open a realm with either the Realm.GetInstance() or Realm.GetInstanceAsync() method. Which method you use depends entirely on if and how you are using asynchronous patterns in your app. The following code shows how to use GetInstance():

var realm = Realm.GetInstance();

Para más información, consulta: Abre un Realm.

Crear, leer, actualizar y eliminar objetos

Al crear o actualizar documentos, todas las operaciones de guardar deben acontecer dentro de una transacción.

El siguiente código muestra dos métodos para crear un nuevo objeto Realm. En el primer ejemplo, primero creamos el objeto y luego lo añadimos al reino mediante un método WriteAsync(). En el segundo ejemplo, creamos el documento dentro del WriteAsync bloque, que devuelve un objeto Realm con el que podemos seguir trabajando.

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"
        });
    }
);

Actualizar un documento es lo mismo que crear uno nuevo, excepto que se establece el parámetro adicional opcional update en true. En este ejemplo, creamos un nuevo objeto Item con un Id único. Luego insertamos un elemento con el mismo id pero con un valor diferente de Name. Como hemos configurado el parámetro update en true, el registro existente se actualiza con el nuevo nombre.

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.

También puedes borrar elementos dentro de un método WriteAsync(). El siguiente código muestra cómo eliminar un solo Item de la colección y cómo eliminar toda una colección:

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

Las siguientes páginas cubren cada uno de estos temas con más detalle:

• Crear

• Update

• Borrar

Cómo encontrar, filtrar y ordenar documentos

Se buscan documentos con el motor de query de Realm, utilizando LINQ o el Realm Query Language (RQL). El siguiente ejemplo encuentra todos los objetos de tipo "Item":

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

You filter results using either LINQ or RQL. This example uses LINQ to find all Items that have a status of "Open":

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

También puede ordenar los resultados utilizando LINQ o RQL:

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

Para obtener detalles sobre cómo consultar, filtrar y ordenar documentos, consulta Filtrar y ordenar datos – .NET SDK.

Esté atento a los cambios

A medida que cambian las colecciones de documentos, a menudo es importante actualizar los datos en una aplicación cliente. Tú puedes supervisar un realm, colección u objeto para ver cambios con el método SubscribeForNotifications().

El siguiente ejemplo muestra cómo agregar un controlador de notificaciones a toda una colección realm:

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

También puedes añadir manejadores de notificaciones en colecciones y objetos individuales. Para obtener más información, consulta Reaccionar a cambios.

Agregar sincronización de dispositivos (opcional)

Si desea sincronizar los datos de Realm entre dispositivos, puede configurar Atlas App Services y habilitar la sincronización de dispositivos. Una vez hecho esto, agregue la sincronización a su código de 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);