1. class
  2. Couchbase
  3. \
  4. BucketSettings

BucketSettings

class BucketSettings (View source)

Methods

string
name()

No description

bool
flushEnabled()

No description

int
ramQuotaMb()

No description

int
numReplicas()

No description

bool
replicaIndexes()

No description

string
bucketType()

No description

string
evictionPolicy()

No description

string
storageBackend()

No description

int
maxTtl()

No description

string
compressionMode()

No description

BucketSettings
setName(string $name)

No description

BucketSettings
enableFlush(bool $enable)

No description

BucketSettings
setRamQuotaMb(int $sizeInMb)

No description

BucketSettings
setNumReplicas(int $numReplicas)

No description

BucketSettings
enableReplicaIndexes(bool $enable)

No description

BucketSettings
setBucketType(string $type)

No description

BucketSettings
setEvictionPolicy(string $policy)

Configures eviction policy for the bucket.

BucketSettings
setStorageBackend(string $policy)

Configures storage backend for the bucket.

BucketSettings
setMaxTtl(int $ttlSeconds)

No description

BucketSettings
setCompressionMode(string $mode)

No description

int
minimalDurabilityLevel()

Retrieves minimal durability level configured for the bucket

BucketSettings
setMinimalDurabilityLevel(int $durabilityLevel)

Configures minimal durability level for the bucket

Details

at line 1420
string name()

No description

Return Value

string

at line 1422
bool flushEnabled()

No description

Return Value

bool

at line 1424
int ramQuotaMb()

No description

Return Value

int

at line 1426
int numReplicas()

No description

Return Value

int

at line 1428
bool replicaIndexes()

No description

Return Value

bool

at line 1430
string bucketType()

No description

Return Value

string

at line 1432
string evictionPolicy()

No description

Return Value

string

at line 1434
string storageBackend()

No description

Return Value

string

at line 1436
int maxTtl()

No description

Return Value

int

at line 1438
string compressionMode()

No description

Return Value

string

at line 1440
BucketSettings setName(string $name)

No description

Parameters

string $name

Return Value

BucketSettings

at line 1442
BucketSettings enableFlush(bool $enable)

No description

Parameters

bool $enable

Return Value

BucketSettings

at line 1444
BucketSettings setRamQuotaMb(int $sizeInMb)

No description

Parameters

int $sizeInMb

Return Value

BucketSettings

at line 1446
BucketSettings setNumReplicas(int $numReplicas)

No description

Parameters

int $numReplicas

Return Value

BucketSettings

at line 1448
BucketSettings enableReplicaIndexes(bool $enable)

No description

Parameters

bool $enable

Return Value

BucketSettings

at line 1450
BucketSettings setBucketType(string $type)

No description

Parameters

string $type

Return Value

BucketSettings

at line 1463
BucketSettings setEvictionPolicy(string $policy)

Configures eviction policy for the bucket.

Parameters

string $policy

eviction policy. Use constants FULL, VALUE_ONLY, NO_EVICTION, NOT_RECENTLY_USED.

Return Value

BucketSettings

See also

EvictionPolicy::FULL
EvictionPolicy::VALUE_ONLY
EvictionPolicy::NO_EVICTION
EvictionPolicy::NOT_RECENTLY_USED

at line 1473
BucketSettings setStorageBackend(string $policy)

Configures storage backend for the bucket.

Parameters

string $policy

storage backend. Use constants COUCHSTORE, MAGMA.

Return Value

BucketSettings

See also

StorageBackend::COUCHSTORE
StorageBackend::MAGMA

at line 1475
BucketSettings setMaxTtl(int $ttlSeconds)

No description

Parameters

int $ttlSeconds

Return Value

BucketSettings

at line 1477
BucketSettings setCompressionMode(string $mode)

No description

Parameters

string $mode

Return Value

BucketSettings

at line 1487
int minimalDurabilityLevel()

Retrieves minimal durability level configured for the bucket

Return Value

int

See also

DurabilityLevel::NONE
DurabilityLevel::MAJORITY
DurabilityLevel::MAJORITY_AND_PERSIST_TO_ACTIVE
DurabilityLevel::PERSIST_TO_MAJORITY

at line 1499
BucketSettings setMinimalDurabilityLevel(int $durabilityLevel)

Configures minimal durability level for the bucket

Parameters

int $durabilityLevel

durability level.

Return Value

BucketSettings

See also

DurabilityLevel::NONE
DurabilityLevel::MAJORITY
DurabilityLevel::MAJORITY_AND_PERSIST_TO_ACTIVE
DurabilityLevel::PERSIST_TO_MAJORITY