couchbase
    Preparing search index...

    Interface ICreateBucketSettings

    Specifies a number of settings which can be set when creating a bucket.

    interface ICreateBucketSettings {
        bucketType?: string;
        compressionMode?: string;
        conflictResolutionType?: string;
        durabilityMinLevel?: string;
        ejectionMethod?: string;
        evictionPolicy?: string;
        flushEnabled?: boolean;
        historyRetentionBytes?: number;
        historyRetentionCollectionDefault?: boolean;
        historyRetentionDuration?: number;
        maxExpiry?: number;
        maxTTL?: number;
        minimumDurabilityLevel?: string | DurabilityLevel;
        name: string;
        numReplicas?: number;
        numVBuckets?: number;
        ramQuotaMB: number;
        replicaIndexes?: boolean;
        storageBackend?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bucketType? compressionMode? conflictResolutionType? durabilityMinLevel? ejectionMethod? evictionPolicy? flushEnabled? historyRetentionBytes? historyRetentionCollectionDefault? historyRetentionDuration? maxExpiry? maxTTL? minimumDurabilityLevel? name numReplicas? numVBuckets? ramQuotaMB replicaIndexes? storageBackend?

    Properties

    bucketType?: string

    Specifies the type of bucket that should be used.

    compressionMode?: string

    Specifies the compression mode that should be used.

    conflictResolutionType?: string

    Specifies the conflict resolution mode to use for XDCR of this bucket.

    durabilityMinLevel?: string

    Same as IBucketSettings.minimumDurabilityLevel, but represented as the raw server-side configuration string.

    Use IBucketSettings.minimumDurabilityLevel instead.

    ejectionMethod?: string

    Same as IBucketSettings.evictionPolicy, but represented as the raw server-side configuration string.

    Use IBucketSettings.evictionPolicy instead.

    evictionPolicy?: string

    Specifies the ejection method that should be used.

    flushEnabled?: boolean

    Whether the flush operation (truncating all data in the bucket) should be enabled.

    historyRetentionBytes?: number

    Specifies the maximum history retention in bytes on all collections in this bucket.

    historyRetentionCollectionDefault?: boolean

    Specifies the default history retention on all collections in this bucket. Only available on Magma Buckets.

    StorageBackend.Magma.

    historyRetentionDuration?: number

    Specifies the maximum duration in seconds to be covered by the change history that is written to disk for all collections in this bucket.

    maxExpiry?: number

    Specifies the maximum expiry time that any document should be permitted to have. Any documents stored with an expiry configured higher than this will be forced to this number.

    maxTTL?: number

    Same as IBucketSettings.maxExpiry.

    Use IBucketSettings.maxExpiry instead.

    minimumDurabilityLevel?: string | DurabilityLevel

    Specifies the minimum durability level that should be used for any write operations which are performed against this bucket.

    name: string

    The name of the bucket.

    numReplicas?: number

    The number of replicas that should exist for this bucket.

    numVBuckets?: number

    Specifies the number of vBuckets in this bucket.

    ramQuotaMB: number

    The amount of RAM which should be allocated to this bucket, expressed in megabytes.

    replicaIndexes?: boolean

    Whether the indexes on this bucket should be replicated.

    storageBackend?: string

    Specifies the storage backend to use for the bucket.

    Settings

    Member Visibility

    On This Page

    Properties