Document.TimeToLive Propriedade

Definição

Namespace:

Microsoft.Azure.Documents

Assemblies:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Pacotes:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Obtém ou define o tempo de vida em segundos do documento no serviço do Azure Cosmos DB.

[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="ttl")]
public int? TimeToLive { get; set; }

[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="ttl")>]
member this.TimeToLive : Nullable<int> with get, set

Public Property TimeToLive As Nullable(Of Integer)

Valor da propriedade

Nullable<Int32>

É uma propriedade opcional. Um valor válido deve ser um inteiro positivo diferente de zero, '-1' ou null. Por padrão, TimeToLive é definido como nulo, o que significa que o documento herda o da DefaultTimeToLivecoleção. A unidade de medida é de segundos. O valor máximo permitido é 2147483647. Quando o valor for '-1', isso significa nunca expirar, independentemente do valor da DefaultTimeToLive coleção.

Atributos

Newtonsoft.Json.JsonPropertyAttribute

Exemplos

O exemplo a seguir remove 'ttl' do conteúdo do documento. O documento herdará a coleção DefaultTimeToLive como seu valor de vida útil.

document.TimeToLive = null;

O exemplo a seguir garante que o documento nunca expire independentemente.

document.TimeToLive = -1;

O exemplo a seguir define o tempo de vida em segundos em um documento. O documento expirará após 1000 segundos desde o último tempo de gravação, quando o da DefaultTimeToLive coleção não nullfor .

document.TimeToLive = 1000;

Comentários

A política de vida útil final de um documento é avaliada depois de consultar a coleção DefaultTimeToLive.

Quando o TimeToLive é null, o documento herda o da DefaultTimeToLivecoleção. Se a coleção for um inteiro positivo diferente de DefaultTimeToLive zero, o documento herdará esse valor como seu tempo de vida em segundos e expirará após o tempo de vida padrão em segundos desde o último tempo de gravação. Os documentos expirados serão excluídos em segundo plano. Caso contrário, o documento nunca expirará.

Quando o TimeToLive for '-1', o documento nunca expirará independentemente do valor da DefaultTimeToLive coleção.

Quando o TimeToLive for um inteiro positivo diferente de zero, precisará marcar o da DefaultTimeToLivecoleção. Se a coleção DefaultTimeToLive for null, o que significa que a vida útil foi desativada na coleção e a do TimeToLive documento deve ser desconsiderada e o documento nunca expirará. Caso contrário, o do TimeToLive documento será honrado. O documento expirará após o tempo de vida padrão em segundos desde o último tempo de gravação. Os documentos expirados serão excluídos em segundo plano.

A tabela a seguir mostra um exemplo da matriz para avaliar a política de vida útil final dada a de DefaultTimeToLive uma coleção e de TimeToLiveum documento.

Coleção	Matriz
DefaultTimeToLive = nulo	Documento Resultado TimeToLive = nulo O TTL está desabilitado. O documento nunca expirará (padrão). TimeToLive = -1 O TTL está desabilitado. O documento nunca expirará. TimeToLive = 2000 O TTL está desabilitado. O documento nunca expirará.
DefaultTimeToLive = -1	Documento Result TimeToLive = nulo O TTL está habilitado. O documento nunca expirará (padrão). TimeToLive = -1 O TTL está habilitado. O documento nunca expirará. TimeToLive = 2000 O TTL está habilitado. O documento expirará após 2000 segundos.
DefaultTimeToLive = 1000	Documento Resultado TimeToLive = nulo O TTL está habilitado. O documento expirará após 1000 segundos (padrão). TimeToLive = -1 O TTL está habilitado. O documento nunca expirará. TimeToLive = 2000 O TTL está habilitado. O documento expirará após 2000 segundos.

Confira também

• DocumentCollection