Class BucketSettings

Inheritance

object

BucketSettings

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Couchbase.Management.Buckets

Assembly: Couchbase.NetClient.dll

Syntax

[JsonConverter(typeof(BucketSettingsJsonConverter))]
public class BucketSettings

Constructors

BucketSettings()

Declaration

public BucketSettings()

Properties

BucketType

The BucketType type to be created.

Declaration

public BucketType BucketType { get; set; }

Property Value

Type	Description
BucketType

CompressionMode

The CompressionMode to use.

Declaration

public CompressionMode? CompressionMode { get; set; }

Property Value

Type	Description
CompressionMode?

ConflictResolutionType

The type of conflict resolution to use. Note: Only use this with CreateBucketAsync().

Declaration

public ConflictResolutionType? ConflictResolutionType { get; set; }

Property Value

Type	Description
ConflictResolutionType?

DurabilityMinimumLevel

Returns the minimum durability level set for the bucket.

Declaration

public DurabilityLevel DurabilityMinimumLevel { get; set; }

Property Value

Type	Description
DurabilityLevel

Remarks

Note that if the bucket does not support it, and by default, it is set to None.

EjectionMethod

Declaration

[Obsolete("Use EvictionPolicy instead.")]
public EvictionPolicyType? EjectionMethod { get; set; }

Property Value

Type	Description
EvictionPolicyType?

EvictionPolicy

The EvictionPolicy to use.

Declaration

public EvictionPolicyType? EvictionPolicy { get; set; }

Property Value

Type	Description
EvictionPolicyType?

FlushEnabled

Enables flushing on the bucket.

Declaration

public bool FlushEnabled { get; set; }

Property Value

Type	Description
bool

HistoryRetentionBytes

The maximum size, in bytes, of the change history that is written to disk for all collections in this bucket.

Declaration

public ulong? HistoryRetentionBytes { get; set; }

Property Value

Type	Description
ulong?

HistoryRetentionCollectionDefault

Whether to enable history retention on collections by default.

Declaration

public bool? HistoryRetentionCollectionDefault { get; set; }

Property Value

Type	Description
bool?

HistoryRetentionDuration

The maximum duration of history each vBucket should aim to retain on disk.

Declaration

public TimeSpan? HistoryRetentionDuration { get; set; }

Property Value

Type	Description
TimeSpan?

MaxTtl

The maximum Time-To-Live (TTL) for new documents in the Bucket. 0 : Documents do not expire.

Declaration

public int MaxTtl { get; set; }

Property Value

Type	Description
int

Name

The bucket name.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

NumReplicas

The number of servers that a document will be replicated to.

Declaration

public int NumReplicas { get; set; }

Property Value

Type	Description
int

NumVBuckets

The number of vBuckets the bucket should have. If not set, the server default will be used. Refer to the Server documentation for the StorageBackend for more information on valid numVBuckets values.

Declaration

[InterfaceStability(Level.Volatile)]
public uint? NumVBuckets { get; set; }

Property Value

Type	Description
uint?

RamQuotaMB

The amount of RAM to allocate for the bucket.

Declaration

public long RamQuotaMB { get; set; }

Property Value

Type	Description
long

ReplicaIndexes

Whether or not to replicate indexes across the cluster.

Declaration

public bool ReplicaIndexes { get; set; }

Property Value

Type	Description
bool

StorageBackend

The type of storage to use with the bucket. This is only specified for "couchbase" buckets.

Declaration

[InterfaceStability(Level.Uncommitted)]
public StorageBackend? StorageBackend { get; set; }

Property Value

Type	Description
StorageBackend?