Interface IBucketSettings

Specifies a number of options which can be used when updating a buckets settings.

interface IBucketSettings {
    bucketType?: string;
    compressionMode?: 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;
    ramQuotaMB: number;
    replicaIndexes?: boolean;
    storageBackend?: string;
}

Hierarchy (view full)

Implemented by

Properties

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

Properties

Optional bucketType

bucketType?: string

Specifies the type of bucket that should be used.

Optional compressionMode

compressionMode?: string

Specifies the compression mode that should be used.

Optional durabilityMinLevel

durabilityMinLevel?: string

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

Deprecated

Use IBucketSettings.minimumDurabilityLevel instead.

Optional ejectionMethod

ejectionMethod?: string

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

Deprecated

Use IBucketSettings.evictionPolicy instead.

Optional evictionPolicy

evictionPolicy?: string

Specifies the ejection method that should be used.

Optional flushEnabled

flushEnabled?: boolean

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

Optional historyRetentionBytes

historyRetentionBytes?: number

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

Optional historyRetentionCollectionDefault

historyRetentionCollectionDefault?: boolean

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

See

StorageBackend.Magma.

Optional historyRetentionDuration

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.

Optional maxExpiry

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.

Optional maxTTL

maxTTL?: number

Same as IBucketSettings.maxExpiry.

Deprecated

Use IBucketSettings.maxExpiry instead.

Optional minimumDurabilityLevel

minimumDurabilityLevel?: string | DurabilityLevel

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

name

name: string

The name of the bucket.

Optional numReplicas

numReplicas?: number

The number of replicas that should exist for this bucket.

ramQuotaMB

ramQuotaMB: number

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

Optional replicaIndexes

replicaIndexes?: boolean

Whether the indexes on this bucket should be replicated.

Optional storageBackend

storageBackend?: string

Specifies the storage backend to use for the bucket.

Settings

Member Visibility

Theme

On This Page

bucketTypecompressionModedurabilityMinLevelejectionMethodevictionPolicyflushEnabledhistoryRetentionByteshistoryRetentionCollectionDefaulthistoryRetentionDurationmaxExpirymaxTTLminimumDurabilityLevelnamenumReplicasramQuotaMBreplicaIndexesstorageBackend