Interface IBucketSettings

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


Implemented by


bucketType?: string

Specifies the type of bucket that should be used.

compressionMode?: string

Specifies the compression mode that should be used.

durabilityMinLevel?: string

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

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.

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


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.

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.

Generated using TypeDoc