Documentation

BucketSettings
in package

Application

$bucketType : string|null
$compressionMode : string|null
$conflictResolutionType : string|null
$evictionPolicy : string|null
$flushEnabled : bool|null
$historyRetentionBytes : int|null
$historyRetentionCollectionDefault : bool|null
$historyRetentionDuration : int|null
$maxExpiry : int|null
$minimumDurabilityLevel : string|null
$name : string
$numReplicas : int|null
$ramQuotaMb : int|null
$replicaIndexes : bool|null
$storageBackend : string|null
__construct() : mixed
bucketType() : string|null: Get the type of bucket that the bucket is.
build() : BucketSettings
compressionMode() : string|null: Get the compression mode used by the bucket.
conflictResolutionType() : string|null: Get the conflict resolution type used by the bucket.
enableFlush() : BucketSettings: Sets whether flush is enabled.
enableHistoryRetentionCollectionDefault() : BucketSettings: Sets whether to enable history on collections by default
enableReplicaIndexes() : BucketSettings: Sets whether replicas are enabled.
evictionPolicy() : string|null: Get the eviction policy used by the bucket.
flushEnabled() : bool|null: Whether flush is enabled for the bucket.
historyRetentionBytes() : int|null: Get the maximum history retention in bytes on all collections in this bucket
historyRetentionCollectionDefault() : bool|null: Get the default history retention on all collections in this bucket
historyRetentionDuration() : int|null: Get the maximum duration in seconds to be covered by the change history that is written to disk for all collections in this bucket
maxExpiry() : int|null: Get the maximum expiry to set on documents created within the bucket.
maxTtl() : int|null: Get the maximum expiry to set on documents created within the bucket.
minimalDurabilityLevel() : string|null: Retrieves minimal durability level configured for the bucket
minimumDurabilityLevel() : string|null: Get the minimum durability level used by the bucket when modifying documents.
name() : string: Get the name of the bucket.
numReplicas() : int|null: Get the number of replicas for the bucket.
ramQuotaMb() : int|null: Get the ram quota of the bucket.
replicaIndexes() : bool|null: Whether replicas are enabled for the bucket.
setBucketType() : BucketSettings: Sets the type of the bucket.
setCompressionMode() : BucketSettings: Configures compression mode for the bucket.
setConflictResolutionType() : BucketSettings: Set the conflict resolution type used by the bucket.
setEvictionPolicy() : BucketSettings: Configures eviction policy for the bucket.
setHistoryRetentionBytes() : BucketSettings: Sets the maximum size, in bytes, o the change history that is written to disk for all collections in this bucket
setHistoryRetentionDuration() : BucketSettings: Sets teh maximum number of seconds to be covered by the change history that is written to disk for all collections in this bucket
setMaxExpiry() : BucketSettings: Sets the default max expiry time for documents in the bucket.
setMaxTtl() : BucketSettings: Sets the default max expiry time for documents in the bucket.
setMinimalDurabilityLevel() : BucketSettings: Configures minimal durability level for the bucket.
setMinimumDurabilityLevel() : BucketSettings: Configures minimum durability level for the bucket.
setName() : BucketSettings: Sets the name of the bucket.
setNumReplicas() : BucketSettings: Sets the number of replicas for the bucket.
setRamQuotaMb() : BucketSettings: Sets the ram quota of the bucket.
setStorageBackend() : BucketSettings: Configures storage backend for the bucket.
storageBackend() : string|null: Get the storage backend used by the bucket.

$bucketType


    private
        string|null
    $bucketType
     = null

$compressionMode


    private
        string|null
    $compressionMode
     = null

$conflictResolutionType


    private
        string|null
    $conflictResolutionType
     = null

$evictionPolicy


    private
        string|null
    $evictionPolicy
     = null

$flushEnabled


    private
        bool|null
    $flushEnabled
     = null

$historyRetentionBytes


    private
        int|null
    $historyRetentionBytes
     = null

$historyRetentionCollectionDefault


    private
        bool|null
    $historyRetentionCollectionDefault
     = null

$historyRetentionDuration


    private
        int|null
    $historyRetentionDuration
     = null

$maxExpiry


    private
        int|null
    $maxExpiry
     = null

$minimumDurabilityLevel


    private
        string|null
    $minimumDurabilityLevel
     = null

$name


    private
        string
    $name

$numReplicas


    private
        int|null
    $numReplicas
     = null

$ramQuotaMb


    private
        int|null
    $ramQuotaMb
     = null

$replicaIndexes


    private
        bool|null
    $replicaIndexes
     = null

$storageBackend


    private
        string|null
    $storageBackend
     = null

__construct()


    public
                __construct(string $name) : mixed

Parameters

$name : string: the name of the bucket

Return values

mixed —

bucketType()

Get the type of bucket that the bucket is.


    public
                bucketType() : string|null

Return values

string|null —

build()


    public
            static    build(string $name) : BucketSettings

Parameters

$name : string: the name of the bucket

Return values

BucketSettings —

compressionMode()

Get the compression mode used by the bucket.


    public
                compressionMode() : string|null

Return values

string|null —

conflictResolutionType()

Get the conflict resolution type used by the bucket.


    public
                conflictResolutionType() : string|null

Return values

string|null —

enableFlush()

Sets whether flush is enabled.


    public
                enableFlush(bool $enable) : BucketSettings

Parameters

$enable : bool: whether flush is enabled

Return values

BucketSettings —

enableHistoryRetentionCollectionDefault()

Sets whether to enable history on collections by default


    public
                enableHistoryRetentionCollectionDefault(bool $historyRetentionCollectionDefault) : BucketSettings

Parameters

$historyRetentionCollectionDefault : bool

Return values

BucketSettings —

enableReplicaIndexes()

Sets whether replicas are enabled.


    public
                enableReplicaIndexes(bool $enable) : BucketSettings

Parameters

$enable : bool: whether to enable replicas

Return values

BucketSettings —

evictionPolicy()

Get the eviction policy used by the bucket.


    public
                evictionPolicy() : string|null

Return values

string|null —

flushEnabled()

Whether flush is enabled for the bucket.


    public
                flushEnabled() : bool|null

Return values

bool|null —

historyRetentionBytes()

Get the maximum history retention in bytes on all collections in this bucket


    public
                historyRetentionBytes() : int|null

Return values

int|null —

historyRetentionCollectionDefault()

Get the default history retention on all collections in this bucket


    public
                historyRetentionCollectionDefault() : bool|null

Return values

bool|null —

historyRetentionDuration()

Get the maximum duration in seconds to be covered by the change history that is written to disk for all collections in this bucket


    public
                historyRetentionDuration() : int|null

Return values

int|null —

maxExpiry()

Get the maximum expiry to set on documents created within the bucket.


    public
                maxExpiry() : int|null

Return values

int|null —

maxTtl()

Get the maximum expiry to set on documents created within the bucket.


    public
                maxTtl() : int|null

Return values

int|null —

minimalDurabilityLevel()

Retrieves minimal durability level configured for the bucket


    public
                minimalDurabilityLevel() : string|null

Return values

string|null —

minimumDurabilityLevel()

Get the minimum durability level used by the bucket when modifying documents.


    public
                minimumDurabilityLevel() : string|null

Return values

string|null —

name()

Get the name of the bucket.


    public
                name() : string

Return values

string —

numReplicas()

Get the number of replicas for the bucket.


    public
                numReplicas() : int|null

Return values

int|null —

ramQuotaMb()

Get the ram quota of the bucket.


    public
                ramQuotaMb() : int|null

Return values

int|null —

replicaIndexes()

Whether replicas are enabled for the bucket.


    public
                replicaIndexes() : bool|null

Return values

bool|null —

setBucketType()

Sets the type of the bucket.


    public
                setBucketType(string $type) : BucketSettings

Parameters

$type : string: the type of the bucket

Return values

BucketSettings —

setCompressionMode()

Configures compression mode for the bucket.


    public
                setCompressionMode(string $mode) : BucketSettings

Parameters

$mode : string

Return values

BucketSettings —

setConflictResolutionType()

Set the conflict resolution type used by the bucket.


    public
                setConflictResolutionType(string $resolutionType) : BucketSettings

Parameters

$resolutionType : string: the conflict resolution type.

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.

Return values

BucketSettings —

setHistoryRetentionBytes()

Sets the maximum size, in bytes, o the change history that is written to disk for all collections in this bucket


    public
                setHistoryRetentionBytes(int $historyRetentionBytes) : BucketSettings

Parameters

$historyRetentionBytes : int

Return values

BucketSettings —

setHistoryRetentionDuration()

Sets teh maximum number of seconds to be covered by the change history that is written to disk for all collections in this bucket


    public
                setHistoryRetentionDuration(int $historyRetentionDuration) : BucketSettings

Parameters

$historyRetentionDuration : int: duration in seconds

Return values

BucketSettings —

setMaxExpiry()

Sets the default max expiry time for documents in the bucket.


    public
                setMaxExpiry(int $expirySeconds) : BucketSettings

Parameters

$expirySeconds : int: the default expiry time.

Return values

BucketSettings —

setMaxTtl()

Sets the default max expiry time for documents in the bucket.


    public
                setMaxTtl(int $expirySeconds) : BucketSettings

Parameters

$expirySeconds : int: the default expiry time.

Return values

BucketSettings —

setMinimalDurabilityLevel()

Configures minimal durability level for the bucket.


    public
                setMinimalDurabilityLevel(int|string $durabilityLevel) : BucketSettings

Parameters

$durabilityLevel : int|string: durability level.

Return values

BucketSettings —

setMinimumDurabilityLevel()

Configures minimum durability level for the bucket.


    public
                setMinimumDurabilityLevel(int|string $durabilityLevel) : BucketSettings

Parameters

$durabilityLevel : int|string: durability level.

Return values

BucketSettings —

setName()

Sets the name of the bucket.


    public
                setName(string $name) : BucketSettings

Parameters

$name : string: the name of the bucket

Return values

BucketSettings —

setNumReplicas()

Sets the number of replicas for the bucket.


    public
                setNumReplicas(int $numReplicas) : BucketSettings

Parameters

$numReplicas : int: the number of replicas

Return values

BucketSettings —

setRamQuotaMb()

Sets the ram quota of the bucket.


    public
                setRamQuotaMb(int $sizeInMb) : BucketSettings

Parameters

$sizeInMb : int: the ram quota in mb.

Return values

BucketSettings —

setStorageBackend()

Configures storage backend for the bucket.


    public
                setStorageBackend(string $backend) : BucketSettings

Parameters

$backend : string: storage backend. Use constants COUCHSTORE, MAGMA.

Return values

BucketSettings —

storageBackend()

Get the storage backend used by the bucket.


    public
                storageBackend() : string|null

Return values

string|null —

BucketSettings in package Application

Table of Contents

Properties

$bucketType

$compressionMode

$conflictResolutionType

$evictionPolicy

$flushEnabled

$historyRetentionBytes

$historyRetentionCollectionDefault

$historyRetentionDuration

$maxExpiry

$minimumDurabilityLevel

$name

$numReplicas

$ramQuotaMb

$replicaIndexes

$storageBackend

Methods

__construct()

Parameters

Tags

Return values

bucketType()

Tags

Return values

build()

Parameters

Tags

Return values

compressionMode()

Tags

Return values

conflictResolutionType()

Tags

Return values

enableFlush()

Parameters

Tags

Return values

enableHistoryRetentionCollectionDefault()

Parameters

Tags

Return values

enableReplicaIndexes()

Parameters

Tags

Return values

evictionPolicy()

Tags

Return values

flushEnabled()

Tags

Return values

historyRetentionBytes()

Tags

Return values

historyRetentionCollectionDefault()

Tags

Return values

historyRetentionDuration()

Tags

Return values

maxExpiry()

Tags

Return values

maxTtl()

Tags

Return values

minimalDurabilityLevel()

Tags

Return values

minimumDurabilityLevel()

Tags

Return values

name()

Tags

Return values

numReplicas()

Tags

BucketSettings
in package

Application