BucketSettings
in package
Table of Contents
- bucketType() : string
- compressionMode() : string
- enableFlush() : BucketSettings
- enableReplicaIndexes() : BucketSettings
- evictionPolicy() : string
- flushEnabled() : bool
- maxTtl() : int
- minimalDurabilityLevel() : int
- Retrieves minimal durability level configured for the bucket
- name() : string
- numReplicas() : int
- ramQuotaMb() : int
- replicaIndexes() : bool
- setBucketType() : BucketSettings
- setCompressionMode() : BucketSettings
- setEvictionPolicy() : BucketSettings
- Configures eviction policy for the bucket.
- setMaxTtl() : BucketSettings
- setMinimalDurabilityLevel() : BucketSettings
- Configures minimal durability level for the bucket
- setName() : BucketSettings
- setNumReplicas() : BucketSettings
- setRamQuotaMb() : BucketSettings
- setStorageBackend() : BucketSettings
- Configures storage backend for the bucket.
- storageBackend() : string
Methods
bucketType()
public
bucketType() : string
Return values
string —compressionMode()
public
compressionMode() : string
Return values
string —enableFlush()
public
enableFlush(bool $enable) : BucketSettings
Parameters
- $enable : bool
Return values
BucketSettings —enableReplicaIndexes()
public
enableReplicaIndexes(bool $enable) : BucketSettings
Parameters
- $enable : bool
Return values
BucketSettings —evictionPolicy()
public
evictionPolicy() : string
Return values
string —flushEnabled()
public
flushEnabled() : bool
Return values
bool —maxTtl()
public
maxTtl() : int
Return values
int —minimalDurabilityLevel()
Retrieves minimal durability level configured for the bucket
public
minimalDurabilityLevel() : int
Tags
Return values
int —name()
public
name() : string
Return values
string —numReplicas()
public
numReplicas() : int
Return values
int —ramQuotaMb()
public
ramQuotaMb() : int
Return values
int —replicaIndexes()
public
replicaIndexes() : bool
Return values
bool —setBucketType()
public
setBucketType(string $type) : BucketSettings
Parameters
- $type : string
Return values
BucketSettings —setCompressionMode()
public
setCompressionMode(string $mode) : BucketSettings
Parameters
- $mode : string
Return values
BucketSettings —setEvictionPolicy()
Configures eviction policy for the bucket.
public
setEvictionPolicy(string $policy) : BucketSettings
Parameters
- $policy : string
-
eviction policy. Use constants FULL, VALUE_ONLY, NO_EVICTION, NOT_RECENTLY_USED.
Tags
Return values
BucketSettings —setMaxTtl()
public
setMaxTtl(int $ttlSeconds) : BucketSettings
Parameters
- $ttlSeconds : int
Return values
BucketSettings —setMinimalDurabilityLevel()
Configures minimal durability level for the bucket
public
setMinimalDurabilityLevel(int $durabilityLevel) : BucketSettings
Parameters
- $durabilityLevel : int
-
durability level.
Tags
Return values
BucketSettings —setName()
public
setName(string $name) : BucketSettings
Parameters
- $name : string
Return values
BucketSettings —setNumReplicas()
public
setNumReplicas(int $numReplicas) : BucketSettings
Parameters
- $numReplicas : int
Return values
BucketSettings —setRamQuotaMb()
public
setRamQuotaMb(int $sizeInMb) : BucketSettings
Parameters
- $sizeInMb : int
Return values
BucketSettings —setStorageBackend()
Configures storage backend for the bucket.
public
setStorageBackend(string $policy) : BucketSettings
Parameters
- $policy : string
-
storage backend. Use constants COUCHSTORE, MAGMA.
Tags
Return values
BucketSettings —storageBackend()
public
storageBackend() : string