Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BucketSettings

Represents the the configured options for a bucket.

Hierarchy

  • BucketSettings

Implements

Index

Properties

bucketType

bucketType: BucketType

Specifies the type of bucket that should be used.

compressionMode

compressionMode: CompressionMode

Specifies the compression mode that should be used.

evictionPolicy

evictionPolicy: EvictionPolicy

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.

minimumDurabilityLevel

minimumDurabilityLevel: 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.

Accessors

durabilityMinLevel

  • get durabilityMinLevel(): string

ejectionMethod

  • get ejectionMethod(): string
  • set ejectionMethod(val: string): void

maxTTL

  • get maxTTL(): number
  • set maxTTL(val: number): void

Generated using TypeDoc