Class BucketSettings

Inheritance
object
BucketSettings
Inherited Members
Namespace: Couchbase.Management.Buckets
Assembly: Couchbase.NetClient.dll
Syntax
[JsonConverter(typeof(BucketSettingsJsonConverter))]
public class BucketSettings

Properties

| Edit this page View Source

BucketType

The BucketType type to be created.

Declaration
public BucketType BucketType { get; set; }
Property Value
Type Description
BucketType
| Edit this page View Source

CompressionMode

The CompressionMode to use.

Declaration
public CompressionMode? CompressionMode { get; set; }
Property Value
Type Description
CompressionMode?
| Edit this page View Source

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?
| Edit this page View Source

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.

| Edit this page View Source

EjectionMethod

Declaration
[Obsolete("Use EvictionPolicy instead.")]
public EvictionPolicyType? EjectionMethod { get; set; }
Property Value
Type Description
EvictionPolicyType?
| Edit this page View Source

EvictionPolicy

The EvictionPolicy to use.

Declaration
public EvictionPolicyType? EvictionPolicy { get; set; }
Property Value
Type Description
EvictionPolicyType?
| Edit this page View Source

FlushEnabled

Enables flushing on the bucket.

Declaration
public bool FlushEnabled { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

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; init; }
Property Value
Type Description
ulong?
| Edit this page View Source

HistoryRetentionCollectionDefault

Whether to enable history retention on collections by default.

Declaration
public bool? HistoryRetentionCollectionDefault { get; init; }
Property Value
Type Description
bool?
| Edit this page View Source

HistoryRetentionDuration

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

Declaration
public TimeSpan? HistoryRetentionDuration { get; init; }
Property Value
Type Description
TimeSpan?
| Edit this page View Source

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
| Edit this page View Source

Name

The bucket name.

Declaration
public string Name { get; set; }
Property Value
Type Description
string
| Edit this page View Source

NumReplicas

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

Declaration
public int NumReplicas { get; set; }
Property Value
Type Description
int
| Edit this page View Source

RamQuotaMB

The amount of RAM to allocate for the bucket.

Declaration
public long RamQuotaMB { get; set; }
Property Value
Type Description
long
| Edit this page View Source

ReplicaIndexes

Whether or not to replicate indexes across the cluster.

Declaration
public bool ReplicaIndexes { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

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?