DocumentCollection.DefaultTimeToLive プロパティ

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

プロパティ値

これは省略可能なプロパティです。 有効な値は、0 以外の正の整数 、'-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が 0 以外の正の整数の場合、コレクションの有効期間が有効になります。 また、既定の有効期間 (秒単位) がすべてのドキュメントに適用されます。 ドキュメントは、最後の書き込み時刻から指定した DefaultTimeToLive 値 (秒単位) の後に期限切れになります。 個々のドキュメントでは、 を設定することで、既定の有効期間ポリシーを TimeToLiveオーバーライドできます。 ドキュメントの TimeToLive 最終有効期間ポリシーの評価の詳細については、 を参照してください。

適用対象

こちらもご覧ください

• Document