Documentation

BucketSettings
in package

Table of Contents

$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.

Properties

$conflictResolutionType

private string|null $conflictResolutionType = null

$historyRetentionBytes

private int|null $historyRetentionBytes = null

$historyRetentionCollectionDefault

private bool|null $historyRetentionCollectionDefault = null

$historyRetentionDuration

private int|null $historyRetentionDuration = null

$minimumDurabilityLevel

private string|null $minimumDurabilityLevel = null

Methods

__construct()

public __construct(string $name) : mixed
Parameters
$name : string

the name of the bucket

Tags
since
4.0.0
Return values
mixed

bucketType()

Get the type of bucket that the bucket is.

public bucketType() : string|null
Tags
see
BucketType::COUCHBASE
see
BucketType::MEMCACHED
see
BucketType::EPHEMERAL
since
4.0.0
Return values
string|null

compressionMode()

Get the compression mode used by the bucket.

public compressionMode() : string|null
Tags
see
CompressionMode::OFF
see
CompressionMode::ACTIVE
see
CompressionMode::PASSIVE
since
4.0.0
Return values
string|null

conflictResolutionType()

Get the conflict resolution type used by the bucket.

public conflictResolutionType() : string|null
Tags
see
ConflictResolutionType::TIMESTAMP
see
ConflictResolutionType::SEQUENCE_NUMBER
see
ConflictResolutionType::CUSTOM
since
4.0.0
Return values
string|null

enableHistoryRetentionCollectionDefault()

Sets whether to enable history on collections by default

public enableHistoryRetentionCollectionDefault(bool $historyRetentionCollectionDefault) : BucketSettings
Parameters
$historyRetentionCollectionDefault : bool
Tags
since
4.1.6
Return values
BucketSettings

enableReplicaIndexes()

Sets whether replicas are enabled.

public enableReplicaIndexes(bool $enable) : BucketSettings
Parameters
$enable : bool

whether to enable replicas

Tags
since
4.0.0
Return values
BucketSettings

evictionPolicy()

Get the eviction policy used by the bucket.

public evictionPolicy() : string|null
Tags
see
EvictionPolicy::FULL
see
EvictionPolicy::VALUE_ONLY
see
EvictionPolicy::NO_EVICTION
see
EvictionPolicy::NOT_RECENTLY_USED
since
4.0.0
Return values
string|null

flushEnabled()

Whether flush is enabled for the bucket.

public flushEnabled() : bool|null
Tags
since
4.0.0
Return values
bool|null

historyRetentionBytes()

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

public historyRetentionBytes() : int|null
Tags
since
4.1.6
Return values
int|null

historyRetentionCollectionDefault()

Get the default history retention on all collections in this bucket

public historyRetentionCollectionDefault() : bool|null
Tags
since
4.1.6
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
Tags
since
4.1.6
Return values
int|null

maxExpiry()

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

public maxExpiry() : int|null
Tags
since
4.0.0
Return values
int|null

maxTtl()

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

public maxTtl() : int|null
Tags
deprecated

see maxExpiry

since
4.0.0
Return values
int|null

minimalDurabilityLevel()

Retrieves minimal durability level configured for the bucket

public minimalDurabilityLevel() : string|null
Tags
see
DurabilityLevel::NONE
see
DurabilityLevel::MAJORITY
see
DurabilityLevel::MAJORITY_AND_PERSIST_TO_ACTIVE
see
DurabilityLevel::PERSIST_TO_MAJORITY
see
minimumDurabilityLevel
deprecated
since
4.0.0
Return values
string|null

minimumDurabilityLevel()

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

public minimumDurabilityLevel() : string|null
Tags
see
DurabilityLevel::NONE
see
DurabilityLevel::MAJORITY
see
DurabilityLevel::MAJORITY_AND_PERSIST_TO_ACTIVE
see
DurabilityLevel::PERSIST_TO_MAJORITY
since
4.0.0
Return values
string|null

name()

Get the name of the bucket.

public name() : string
Tags
since
4.0.0
Return values
string

numReplicas()

Get the number of replicas for the bucket.

public numReplicas() : int|null
Tags
since
4.0.0
Return values
int|null

ramQuotaMb()

Get the ram quota of the bucket.

public ramQuotaMb() : int|null
Tags
since
4.0.0
Return values
int|null

replicaIndexes()

Whether replicas are enabled for the bucket.

public replicaIndexes() : bool|null
Tags
since
4.0.0
Return values
bool|null

setBucketType()

Sets the type of the bucket.

public setBucketType(string $type) : BucketSettings
Parameters
$type : string

the type of the bucket

Tags
see
BucketType::COUCHBASE
see
BucketType::MEMCACHED
see
BucketType::EPHEMERAL
since
4.0.0
Return values
BucketSettings

setCompressionMode()

Configures compression mode for the bucket.

public setCompressionMode(string $mode) : BucketSettings
Parameters
$mode : string
Tags
see
CompressionMode::OFF
see
CompressionMode::ACTIVE
see
CompressionMode::PASSIVE
since
4.0.0
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.

Tags
see
ConflictResolutionType::TIMESTAMP
see
ConflictResolutionType::SEQUENCE_NUMBER
see
ConflictResolutionType::CUSTOM
since
4.0.0
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
see
EvictionPolicy::FULL
see
EvictionPolicy::VALUE_ONLY
see
EvictionPolicy::NO_EVICTION
see
EvictionPolicy::NOT_RECENTLY_USED
since
4.0.0
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
Tags
since
4.1.6
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

Tags
since
4.1.6
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.

Tags
since
4.0.0
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.

Tags
deprecated
see
setMaxExpiry
since
4.0.0
Return values
BucketSettings

setMinimalDurabilityLevel()

Configures minimal durability level for the bucket.

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

durability level.

Tags
see
DurabilityLevel::NONE
see
DurabilityLevel::MAJORITY
see
DurabilityLevel::MAJORITY_AND_PERSIST_TO_ACTIVE
see
DurabilityLevel::PERSIST_TO_MAJORITY
see
setMinimumDurabilityLevel
deprecated
since
4.0.0
Return values
BucketSettings

setMinimumDurabilityLevel()

Configures minimum durability level for the bucket.

public setMinimumDurabilityLevel(int|string $durabilityLevel) : BucketSettings
Parameters
$durabilityLevel : int|string

durability level.

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

setName()

Sets the name of the bucket.

public setName(string $name) : BucketSettings
Parameters
$name : string

the name of the bucket

Tags
deprecated

use constructor argument instead

since
4.0.0
Return values
BucketSettings

setNumReplicas()

Sets the number of replicas for the bucket.

public setNumReplicas(int $numReplicas) : BucketSettings
Parameters
$numReplicas : int

the number of replicas

Tags
since
4.0.0
Return values
BucketSettings

setStorageBackend()

Configures storage backend for the bucket.

public setStorageBackend(string $backend) : BucketSettings
Parameters
$backend : string

storage backend. Use constants COUCHSTORE, MAGMA.

Tags
see
StorageBackend::COUCHSTORE
see
StorageBackend::MAGMA
Return values
BucketSettings

storageBackend()

Get the storage backend used by the bucket.

public storageBackend() : string|null
Tags
see
StorageBackend::COUCHSTORE
see
StorageBackend::MAGMA
since
4.0.0
Return values
string|null

        

Search results