Document.TimeToLive Propiedad
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Obtiene o establece el período de vida en segundos del documento en el servicio 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 de propiedad
Es una propiedad opcional.
Un valor válido debe ser un entero positivo distinto de cero, "-1" o null
.
De forma predeterminada, TimeToLive se establece en null, lo que significa que el documento hereda la colección DefaultTimeToLive.
La unidad de medida es de segundos. El valor máximo permitido es 2147483647.
Cuando el valor es "-1", significa que nunca expirará independientemente del valor de DefaultTimeToLive la colección.
- Atributos
-
Newtonsoft.Json.JsonPropertyAttribute
Ejemplos
En el ejemplo siguiente se quita "ttl" del contenido del documento. El documento heredará la colección DefaultTimeToLive como su valor de período de vida.
document.TimeToLive = null;
En el ejemplo siguiente se garantiza que el documento nunca debe expirar independientemente.
document.TimeToLive = -1;
En el ejemplo siguiente se establece el período de vida en segundos en un documento.
El documento expirará después de 1000 segundos desde su última hora de escritura cuando la colección DefaultTimeToLive no null
sea .
document.TimeToLive = 1000;
Comentarios
La última directiva de período de vida de un documento se evalúa después de consultar la colección.DefaultTimeToLive
TimeToLive Cuando es null
, el documento hereda el objeto de DefaultTimeToLivela colección. Si el de DefaultTimeToLive la colección es un entero positivo distinto de cero, el documento heredará ese valor como su período de vida en segundos y expirará después del período de vida predeterminado en segundos desde su última hora de escritura. Los documentos expirados se eliminarán en segundo plano. De lo contrario, el documento nunca expirará.
TimeToLive Cuando es "-1", el documento nunca expirará independientemente del valor de DefaultTimeToLive la colección.
TimeToLive Cuando es un entero positivo distinto de cero, debe comprobar el valor de DefaultTimeToLivela colección. Si el de DefaultTimeToLive la colección es null
, lo que significa que el período de vida se ha desactivado en la colección y el documento TimeToLive debe omitirse y el documento nunca expirará. De lo contrario, se respetará el documento TimeToLive . El documento expirará después del período de vida predeterminado en segundos desde su última hora de escritura. Los documentos expirados se eliminarán en segundo plano.
En la tabla siguiente se muestra un ejemplo de la matriz para evaluar la directiva de período de vida final dada la colección DefaultTimeToLive y el documento TimeToLive.
Colección | Matriz | ||||||||
---|---|---|---|---|---|---|---|---|---|
DefaultTimeToLive = null |
| ||||||||
DefaultTimeToLive = -1 |
| ||||||||
DefaultTimeToLive = 1000 |
|
Se aplica a
Consulte también
Azure SDK for .NET
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de