Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IBucketSettings

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

Hierarchy

Implemented by

Index

Properties

bucketType

bucketType: string

Specifies the type of bucket that should be used.

compressionMode

compressionMode: string

Specifies the compression mode that should be used.

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.

evictionPolicy

evictionPolicy: string

Specifies the ejection method that should be used.

flushEnabled

flushEnabled: boolean

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

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.

maxTTL

maxTTL: number
deprecated

Use IBucketSettings.maxExpiry instead.

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.

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.

replicaIndexes

replicaIndexes: boolean

Whether the indexes on this bucket should be replicated.

Generated using TypeDoc