你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Document.TimeToLive 属性
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
获取或设置 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)
属性值
它是一个可选属性。
有效值必须是非零正整数“-1”或 null
。
默认情况下,TimeToLive 设置为 null,这意味着文档继承集合的 DefaultTimeToLive。
度量单位为秒。 允许的最大值为2147483647。
如果值为“-1”,则表示无论集合 DefaultTimeToLive 的值如何,永不过期。
- 属性
-
Newtonsoft.Json.JsonPropertyAttribute
示例
以下示例从文档内容中删除“ttl”。 文档将继承集合的 DefaultTimeToLive 作为其生存时间值。
document.TimeToLive = null;
下面的示例确保文档无论如何都不会过期。
document.TimeToLive = -1;
下面的示例设置文档的生存时间(以秒为单位)。
当集合的 DefaultTimeToLive 不是 null
时,文档将在上次写入后 1000 秒后过期。
document.TimeToLive = 1000;
注解
在查阅集合 DefaultTimeToLive的 后,将评估文档的最终生存时间策略。
当 为 TimeToLivenull
时,文档继承集合的 DefaultTimeToLive。 如果集合的 DefaultTimeToLive 是一个非零正整数,则文档将继承该值作为其生存时间(以秒为单位),并且将在自上次写入以来的默认生存时间(以秒为单位)之后过期。 过期的文档将在后台删除。 否则,文档永远不会过期。
当 为 TimeToLive “-1”时,无论集合 DefaultTimeToLive 的值如何,文档都不会过期。
TimeToLive当 为非零正整数时, 需要检查集合的 DefaultTimeToLive。 如果集合的 DefaultTimeToLive 为 null
,则表示集合的生存时间已关闭,并且应忽略文档的 TimeToLive ,并且文档永远不会过期。 否则,将遵循文档的 TimeToLive 。 文档将在自上次写入以来的默认生存时间(以秒为单位)之后过期。 过期的文档将在后台删除。
下表显示了一个矩阵示例,该矩阵用于评估给定集合的 和文档的最终DefaultTimeToLiveTimeToLive生存时间策略。
集合 | 矩阵 | ||||||||
---|---|---|---|---|---|---|---|---|---|
DefaultTimeToLive = null |
| ||||||||
DefaultTimeToLive = -1 |
| ||||||||
DefaultTimeToLive = 1000 |
|