class BinaryCollection (View source)

BinaryCollection is an object containing functionality for performing KeyValue operations against the server with binary documents.

Methods

string
name()

Get the name of the binary collection.

append(string $id, string $value, AppendOptions $options = null)

Appends a value to a document.

prepend(string $id, string $value, PrependOptions $options = null)

Prepends a value to a document.

increment(string $id, IncrementOptions $options = null)

Increments a counter document by a value.

decrement(string $id, DecrementOptions $options = null)

Decrements a counter document by a value.

Details

string name()

Get the name of the binary collection.

Return Value

string

MutationResult append(string $id, string $value, AppendOptions $options = null)

Appends a value to a document.

Parameters

string $id

the key of the document

string $value

the value to append

AppendOptions $options

the options to use for the operation

Return Value

MutationResult

MutationResult prepend(string $id, string $value, PrependOptions $options = null)

Prepends a value to a document.

Parameters

string $id

the key of the document

string $value

the value to prepend

PrependOptions $options

the options to use for the operation

Return Value

MutationResult

CounterResult increment(string $id, IncrementOptions $options = null)

Increments a counter document by a value.

Parameters

string $id

the key of the document

IncrementOptions $options

the options to use for the operation

Return Value

CounterResult

CounterResult decrement(string $id, DecrementOptions $options = null)

Decrements a counter document by a value.

Parameters

string $id

the key of the document

DecrementOptions $options

the options to use for the operation

Return Value

CounterResult