DocumentCollection.DefaultTimeToLive Propiedad

Definición

Espacio de nombres:

Microsoft.Azure.Documents

Ensamblados:

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

Paquetes:

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

Obtiene el tiempo predeterminado de vida en segundos para los documentos de una colección del servicio 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 de propiedad

Nullable<Int32>

Es una propiedad opcional. Un valor válido debe ser un entero positivo distinto de cero, "-1" o null. De forma predeterminada, DefaultTimeToLive se establece en null, lo que significa que el período de vida está desactivado para la colección. La unidad de medida es de segundos. El valor máximo permitido es 2147483647.

Atributos

Newtonsoft.Json.JsonPropertyAttribute

Ejemplos

En el ejemplo siguiente se deshabilita el período de vida en una colección.

collection.DefaultTimeToLive = null;

En el ejemplo siguiente se habilita el período de vida en una colección. De forma predeterminada, todos los documentos nunca expiran.

collection.DefaultTimeToLive = -1;

En el ejemplo siguiente se habilita el período de vida en una colección. De forma predeterminada, el documento expirará después de 1000 segundos desde su última hora de escritura.

collection.DefaultTimeToLive = 1000;

Comentarios

DefaultTimeToLive Se aplicará a todos los documentos de la colección como directiva predeterminada de período de vida. El documento individual podría invalidar la directiva predeterminada de período de vida estableciendo su TimeToLive.

DefaultTimeToLive Cuando es null, el período de vida se desactivará para la colección. Significa que todos los documentos nunca expirarán. Se ignorará el TimeToLive documento individual.

DefaultTimeToLive Cuando es "-1", el período de vida se activará para la colección. De forma predeterminada, todos los documentos nunca expirarán. Al documento individual se le podría dar un valor de período de vida específico estableciendo su TimeToLive. Se respetará el documento TimeToLive y los documentos expirados se eliminarán en segundo plano.

DefaultTimeToLive Cuando es un entero positivo distinto de cero, el período de vida se activará para la colección. Y se aplicará un período de vida predeterminado en segundos a todos los documentos. Un documento expirará después del valor especificado DefaultTimeToLive en segundos desde su última hora de escritura. El documento individual podría invalidar la directiva predeterminada de período de vida estableciendo su TimeToLive. Consulte para TimeToLive obtener más información sobre cómo evaluar la directiva de período de vida final de un documento.

Consulte también

• Document