Document.TimeToLive プロパティ

[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)

プロパティ値

これは省略可能なプロパティです。 有効な値は、0 以外の正の整数 、'-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の を参照した後に評価されます。

TimeToLiveが nullの場合、ドキュメントはコレクションの DefaultTimeToLiveを継承します。 コレクションの が 0 以外の正の DefaultTimeToLive 整数の場合、ドキュメントはその値を有効期間 (秒単位) として継承し、最後の書き込み時刻から既定の有効期間 (秒) 後に期限切れになります。 期限切れのドキュメントはバックグラウンドで削除されます。 それ以外の場合、ドキュメントの有効期限は切れません。

TimeToLiveが '-1' の場合、コレクションの値に関係なく、ドキュメントはDefaultTimeToLive期限切れになりません。

TimeToLiveが 0 以外の正の整数の場合は、コレクションの DefaultTimeToLiveをチェックする必要があります。 コレクションの DefaultTimeToLive が の場合は null、コレクションの有効期間がオフになっていて、ドキュメントは TimeToLive 無視され、ドキュメントの有効期限は切れません。 それ以外の場合は、ドキュメントの TimeToLive が優先されます。 ドキュメントは、前回の書き込み時間から既定の有効期間 (秒単位) の後に期限切れになります。 期限切れのドキュメントはバックグラウンドで削除されます。

次の表は、コレクション DefaultTimeToLive とドキュメントの を指定した最終有効期間ポリシーを評価するマトリックスの TimeToLive例を示しています。

適用対象

こちらもご覧ください

• DocumentCollection