Classe RealmConfigurationBase

Classe base para especificar as definições de configuração que afetam o comportamento do Realm.
Sua principal função é gerar um caminho canônico a partir de qualquer subdiretório absoluto, relativo ou apenas o nome de arquivo fornecido pelo usuário.

Herança

objeto

RealmConfigurationBase

InMemoryConfiguration

RealmConfiguration

SyncConfigurationBase

namespace: Realms

Conjunto: Realm.exe

Sintaxe

public abstract class RealmConfigurationBase

Propriedades

Caminho do Banco de Dados

Obtém o caminho completo dos Realms abertos com esta configuração. Pode ser substituído passando um nome separado.

Declaração

public string DatabasePath { get; }

Valor da propriedade

Tipo	Descrição
string	O caminho absoluto para o Realm.

DefaultRealmName

Obtém o nome do arquivo a ser combinado com o diretório do documento específico da plataforma.

Declaração

public static string DefaultRealmName { get; }

Valor da propriedade

Tipo	Descrição
string	Uma string que representa apenas um nome de arquivo, nenhum caminho.

fallbackpipepath

Obtém ou define o caminho onde os pipes nomeados usados pelo Realm podem ser colocados.

Declaração

public string? FallbackPipePath { get; set; }

Valor da propriedade

Tipo	Descrição
string	O caminho onde os pipes nomeados podem ser criados.

Observações

Na grande maioria dos casos, esse valor deve ser deixado nulo. Ele precisa ser definido se o Realm for aberto em um sistema de arquivos em que um pipe nomeado não possa ser criado, como armazenamento externo no Android que usa FAT32. Nesse caso, o ponto deve ponto para um local em um sistema de arquivos onde os pipe podem ser criados.

IsDynamic

Obtém ou define um valor que indica se o Realm será aberto no modo dinâmico. Se aberto no modo dinâmico, o esquema será lido do arquivo no disco.

Declaração

public bool IsDynamic { get; set; }

Valor da propriedade

Tipo	Descrição
bool	true se o Realm será aberto no modo dinâmico; false caso contrário.

MaxNumberOfAtiveVersions

Obtém ou define o número máximo de versões ativas permitidas antes que uma exceção seja lançada.

Declaração

public ulong MaxNumberOfActiveVersions { get; set; }

Valor da propriedade

Tipo	Descrição
ulong

Veja também

Congelar()

Esquema

Obtém ou define o esquema do Realm aberto com esta configuração.

Declaração

public RealmSchema Schema { get; set; }

Valor da propriedade

Tipo	Descrição
Esquema de Realm	O esquema dos tipos que podem ser persistidos no Realm.

Observações

Normalmente deixado nulo, então, por padrão, todas as instâncias IRealmObject e IEmbeddedObject poderão ser armazenadas em todos os Realms.
Se especificar o esquema explicitamente, você poderá usar o operador de conversão implícita de Type[] para RealmSchema ou construí-lo usando a API RealmSchema.Builder .

Exemplos

config.Schema = new Type[]
{
    typeof(CommonClass),
    typeof(RareClass)
};

// Alternatively
config.Schema = new RealmSchema.Builder
{
    new ObjectSchema.Builder("Person")
    {
        Property.Primitive("Name", RealmValueType.String, isPrimaryKey: true),
        Property.Primitive("Birthday", RealmValueType.Date, isNullable: true),
        Property.ObjectList("Addresses", objectType: "Address")
    },
    new ObjectSchema.Builder("Address")
    {
        Property.Primitive("City", RealmValueType.String),
        Property.Primitive("Street", RealmValueType.String),
    }
}

Versão do esquema

Obtém ou define um número, indicando a versão do esquema. Pode ser usado para distinguir arbitrariamente entre esquemas, mesmo que eles tenham os mesmos objetos e propriedades.

Declaração

public ulong SchemaVersion { get; set; }

Valor da propriedade

Tipo	Descrição
ulong	O valor baseado em 0 foi definido inicialmente como zero, portanto todos os valores definidos pelo usuário serão maiores.

DeveCompactOnLaunch

Obtém ou define o compacto na chamada de resposta de lançamento.

Declaração

public RealmConfigurationBase.ShouldCompactDelegate? ShouldCompactOnLaunch { get; set; }

Valor da propriedade

Tipo	Descrição
RealmConfigurationBase.ShouldCompactDelegate	O RealmConfigurationBase.ShouldCompactDelegate que será invocado ao abrir um Realm pela primeira vez para determinar se ele deve ser compactado antes de ser retornado ao usuário.

Métodos

GetPathToRealm(string?)

Utilitário para construir um caminho no qual um Realm será criado para que possa usar consistentemente nomes de arquivos e caminhos relativos.

Declaração

public static string GetPathToRealm(string? optionalPath = null)

Parâmetros

Tipo	Nome	Descrição
string	caminho opcional	O caminho para o Realm, deve ser um caminho completo válido para a plataforma atual, subdiretório relativo ou apenas o nome do arquivo.

Devoluções

Tipo	Descrição
string	Um caminho completo, incluindo o nome do Arquivo de Realm.