Modelos de objetos - .NET SDK

Esquema de objetos

Um esquema de objeto é um objeto de configuração que define as propriedades e relacionamentos de um objeto de Realm. Os aplicativos cliente de realm definem esquemas de objeto com a implementação de classe nativa em sua respectiva linguagem usando o Esquema de Objeto.

Os esquemas de objeto especificam restrições nas propriedades do objeto, como o tipo de dados de cada propriedade e se uma propriedade é necessária ou não. Os esquemas também podem definir relações entre tipos de objeto em um realm.

Cada aplicação tem um Esquema App Services composto por uma lista de esquemas de objetos para cada tipo de objeto que os realms desse aplicativo podem conter. O Realm garante que todos os objetos em um realm estejam em conformidade com o esquema do seu tipo de objeto e valida os objetos sempre que eles são criados, modificados ou excluídos.

Chave primária

Uma chave primária é uma propriedade que identifica exclusivamente um objeto. Você pode criar uma chave primária com qualquer um dos seguintes tipos (ou suas contrapartes anuláveis):

• ObjectId

• UUID

• string

• char

• byte

• short

• int

• long

Você pode definir uma chave primária em uma propriedade única para um tipo de objeto como parte do esquema de objetos. O Realm indexa automaticamente as propriedades de chave primária, o que lhe permite ler e modificar objetos com eficiência com base em sua chave primária.

Se um tipo de objeto tiver uma chave primária, todos os objetos desse tipo deverão incluir a propriedade da chave primária com um valor exclusivo entre objetos do mesmo tipo em um domínio.

O exemplo a seguir demonstra como designar uma chave primária em um esquema de objeto:

public partial class Dog : IRealmObject
{
    [PrimaryKey]
    public string Name { get; set; }
    public int Age { get; set; }
    public Person? Owner { get; set; }
}

Indexes

Índices melhoram significativamente os tempos de query em um Realm. Sem índices, o Realm verifica todos os documentos de uma coleção para selecionar os documentos que correspondem à query fornecida. No entanto, se um índice aplicável existir para uma query, o Realm usará o índice para limitar o número de documentos que ele deve inspecionar.

Você pode indexar propriedades com os seguintes tipos:

• bool

• byte

• short

• int

• long

• DateTimeOffset

• char

• string

• ObjectId

• UUID

Para indexar uma propriedade, use o atributo Indexado . Com o atributo Indexed , você pode especificar o tipo de índice na propriedade usando o enum IndexType . No exemplo seguinte, temos um índice padrão ("Geral") na propriedade Name :

public partial class Person : IRealmObject
{
    [Indexed(IndexType.General)]
    public string Name { get; set; }
    [Indexed(IndexType.FullText)]
    public string Biography { get; set; }
}

Índices de pesquisa de texto completo

Além dos índices padrão, o Realm também suporta índices de Pesquisa de Texto Completo (FTS) em propriedades do string. Embora você possa executar uma query de um campo de string com ou sem um índice padrão, um índice FTS permite pesquisar várias palavras e frases e excluir outras.

Para obter mais informações sobre a consulta de índices de texto completo, consulte Full Text Search (LINQ) e Full Text Search (RQL).

Para indexar uma propriedade FTS, use o atributo Indexado com o enum IndexType.FullText . No exemplo seguinte, temos um índice FullText na propriedade Biography :

public partial class Person : IRealmObject
{
    [Indexed(IndexType.General)]
    public string Name { get; set; }
    [Indexed(IndexType.FullText)]
    public string Biography { get; set; }
}

Valores de campo padrão

Você pode utilizar as feições de idioma embutidas para atribuir um valor padrão para uma propriedade. Em C#, você pode atribuir um valor padrão em primitivos na declaração de propriedade. Você não pode definir um valor padrão em uma coleção, exceto para defini-lo para null!. Mesmo que você defina uma coleção como null!, as collections são sempre inicializadas no primeiro acesso, portanto, nunca serão nulas.

public partial class Person : IRealmObject
{
    public string Name { get; set; } = "foo";
    public IList<PhoneNumber> PhoneNumbers { get; } = null!;
}

Ignorar uma propriedade

Se não quiser salvar uma propriedade em seu modelo em um domínio, você poderá ignorar esta propriedade. Uma propriedade é ignorada por padrão se não for autoimplementada ou não tiver um setter.

Ignore uma propriedade de um modelo de objeto Realm com o atributo Ignorado :

// Rather than store an Image in Realm,
// store the path to the Image...
public string ThumbnailPath { get; set; }
// ...and the Image itself can be
// in-memory when the app is running:
[Ignored]
public Image? Thumbnail { get; set; }

Renomear uma propriedade

Por padrão, o Realm utiliza o nome definido na classe do modelo para representar propriedades internamente. Em alguns casos, talvez você queira alterar esse comportamento:

• Para facilitar o trabalho em todas as plataformas, uma vez que as convenções de nomenclatura são diferentes.

• Para alterar um nome de propriedade no .NET sem forçar uma migração.

Escolher um nome interno diferente do nome usado nas classes de modelo tem as seguintes implicações:

• As migrações devem usar o nome interno ao criar classes e propriedades.

• Erros de esquema relatados usarão o nome interno.

Use o atributo [MapTo] para renomear uma propriedade:

public partial class Person : IRealmObject
{
    [MapTo("moniker")]
    public string Name { get; set; }
}

Renomear uma turma

Por padrão, o Realm utiliza o nome definido na classe de modelo para representar classes internamente. Em alguns casos, você pode querer alterar esse comportamento:

• Para oferecer suporte a várias classes de modelo com o mesmo nome simples em diferentes namespaces.

• Para facilitar o trabalho em todas as plataformas, uma vez que as convenções de nomenclatura são diferentes.

• Para usar um nome de classe maior que o limite de 57 caracteres imposto pelo Realm.

• Para alterar o nome de classe no .NET sem forçar uma migração.

Use o atributo [MapTo] para renomear uma classe:

[MapTo("Human")]
public partial class Person : IRealmObject
{
    public string Name { get; set; }
}

Setters personalizados

O Realm não armazenará uma propriedade com uma preparação personalizada. Para usar uma preparação personalizada, armazene o valor da propriedade em uma propriedade privada e, em seguida, mapeie esse valor para uma propriedade pública com a preparação personalizada. O Realm irá armazenar a propriedade privada, enquanto modifica o seu valor através da propriedade pública. No código a seguir, a propriedade privada email é armazenada no realm, mas a propriedade pública Email, que fornece validação não é persistida:

// This property will be stored in the Realm
private string email { get; set; }
// Custom validation of the email property.
// This property is *not* stored in Realm.
public string Email
{
    get { return email; }
    set
    {
        if (!value.Contains("@")) throw new Exception("Invalid email address");
        email = value;
    }
}

Ignorando nulidade

Você pode preferir ter mais flexibilidade na definição da nulidade das propriedades em seus objetos de Realm. Você pode fazer isso definindo realm.ignore_objects_nullability = true em um arquivo de configuração global.

Se você habilitar realm.ignore_objects_nullability, as anotações de nulidade serão ignoradas nas propriedades do objeto Realm, incluindo coleções de Objetos de Realm.