Class UpdateCollectionSettings

Inheritance
System.Object
UpdateCollectionSettings
Namespace: Couchbase.Management.Collections
Assembly: Couchbase.NetClient.dll
Syntax
public class UpdateCollectionSettings : object

Constructors

| Improve this Doc View Source

UpdateCollectionSettings(Nullable<TimeSpan>, Nullable<Boolean>)

Optional settings when creating a new Collection.

Declaration
public UpdateCollectionSettings(TimeSpan? expiry = null, bool? history = null)
Parameters
Type Name Description
System.Nullable<TimeSpan> expiry

See MaxExpiry
System.Nullable<System.Boolean> history

See History

Fields

| Improve this Doc View Source

NoExpiry

Declaration
public static readonly TimeSpan NoExpiry
Field Value
Type Description
TimeSpan

Properties

| Improve this Doc View Source

Default

Declaration
public static UpdateCollectionSettings Default { get; }
Property Value
Type Description
UpdateCollectionSettings
| Improve this Doc View Source

History

Whether history retention override is enabled on this collection. If left unset, it defaults to the bucket-level setting.

Declaration
public bool? History { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

MaxExpiry

The maximum Time-To-Live (TTL) for new documents in the collection. Unset or 0 : Uses the Bucket's MaxExpiry -1 (TimeSpan.FromSeconds(-1)) : Documents do not expire. You can use the static constant NoExpiry for this.

Declaration
public TimeSpan? MaxExpiry { get; set; }
Property Value
Type Description
System.Nullable<TimeSpan>