Documentation

BinaryCollection

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

Table of Contents

name() Get the name of the binary collection. string
append() Appends a value to a document. MutationResult
prepend() Prepends a value to a document. MutationResult
increment() Increments a counter document by a value. CounterResult
decrement() Decrements a counter document by a value. CounterResult

Methods

name()

Get the name of the binary collection.

public name( ) : string
Return values
string

append()

Appends a value to a document.

public append( $id : string , $value : string [, $options : AppendOptions = null ] ) : MutationResult
Parameters
$id : string

the key of the document

$value : string

the value to append

$options : AppendOptions = null

the options to use for the operation

Return values
MutationResult

prepend()

Prepends a value to a document.

public prepend( $id : string , $value : string [, $options : PrependOptions = null ] ) : MutationResult
Parameters
$id : string

the key of the document

$value : string

the value to prepend

$options : PrependOptions = null

the options to use for the operation

Return values
MutationResult

Search results