Class UpdateCollectionSettings

Inheritance

object

UpdateCollectionSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.Management.Collections

Assembly: Couchbase.NetClient.dll

Syntax

public class UpdateCollectionSettings

Constructors

UpdateCollectionSettings(TimeSpan?, bool?)

Optional settings when creating a new Collection.

Declaration

public UpdateCollectionSettings(TimeSpan? expiry = null, bool? history = null)

Parameters

Type	Name	Description
TimeSpan?	expiry	See MaxExpiry
bool?	history	See History

Fields

NoExpiry

Declaration

public static readonly TimeSpan NoExpiry

Field Value

Type	Description
TimeSpan

Properties

Default

Declaration

public static UpdateCollectionSettings Default { get; }

Property Value

Type	Description
UpdateCollectionSettings

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
bool?

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
TimeSpan?