DocumentCollection.DefaultTimeToLive Propriedade

Referência

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

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Obtém o tempo padrão de vida em segundos para documentos em uma coleção do serviço do Azure Cosmos DB.

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

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

Public Property DefaultTimeToLive 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, DefaultTimeToLive é definido como nulo, o que significa que a vida útil está desativada para a coleção. A unidade de medida é de segundos. O valor máximo permitido é 2147483647.

Atributos: Newtonsoft.Json.JsonPropertyAttribute

Exemplos

O exemplo a seguir desabilita o tempo de vida em uma coleção.

collection.DefaultTimeToLive = null;

O exemplo a seguir habilita a vida útil em uma coleção. Por padrão, todos os documentos nunca expiram.

collection.DefaultTimeToLive = -1;

O exemplo a seguir habilita a vida útil em uma coleção. Por padrão, o documento expirará após 1000 segundos desde o último tempo de gravação.

collection.DefaultTimeToLive = 1000;

Comentários

O DefaultTimeToLive será aplicado a todos os documentos da coleção como a política de vida útil padrão. O documento individual pode substituir a política de vida útil padrão definindo seu TimeToLive.

Quando for DefaultTimeToLivenull, a vida útil será desativada para a coleção. Isso significa que todos os documentos nunca expirarão. O documento TimeToLive individual será desconsiderado.

Quando o DefaultTimeToLive for '-1', o tempo de vida será ativado para a coleção. Por padrão, todos os documentos nunca expirarão. O documento individual pode receber um valor específico de vida útil definindo seu TimeToLive. O do TimeToLive documento será respeitado e os documentos expirados serão excluídos em segundo plano.

Quando o DefaultTimeToLive for um inteiro positivo diferente de zero, o tempo de vida será ativado para a coleção. E um tempo de vida padrão em segundos será aplicado a todos os documentos. Um documento expirará após o valor especificado DefaultTimeToLive em segundos desde o último tempo de gravação. O documento individual pode substituir a política de vida útil padrão definindo seu TimeToLive. Consulte o TimeToLive para obter mais detalhes sobre como avaliar a política de vida útil final de um documento.

Aplica-se a

Confira também

Document

Compartilhar via