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