Documentation

BucketSettings

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

Methods

bucketType()

public bucketType() : string
Return values
string

compressionMode()

public compressionMode() : string
Return values
string

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
see
DurabilityLevel::NONE
see
DurabilityLevel::MAJORITY
see
DurabilityLevel::MAJORITY_AND_PERSIST_TO_ACTIVE
see
DurabilityLevel::PERSIST_TO_MAJORITY
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

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
see
EvictionPolicy::FULL
see
EvictionPolicy::VALUE_ONLY
see
EvictionPolicy::NO_EVICTION
see
EvictionPolicy::NOT_RECENTLY_USED
Return values
BucketSettings

setMinimalDurabilityLevel()

Configures minimal durability level for the bucket

public setMinimalDurabilityLevel(int $durabilityLevel) : BucketSettings
Parameters
$durabilityLevel : int

durability level.

Tags
see
DurabilityLevel::NONE
see
DurabilityLevel::MAJORITY
see
DurabilityLevel::MAJORITY_AND_PERSIST_TO_ACTIVE
see
DurabilityLevel::PERSIST_TO_MAJORITY
Return values
BucketSettings

Search results