\Elastica\AggregationGeohashGrid

Class GeohashGrid.

Summary

Methods
Properties
Constants
__construct()
setField()
setPrecision()
setSize()
setShardSize()
No public properties found
DEFAULT_PRECISION_VALUE
DEFAULT_SIZE_VALUE
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

DEFAULT_PRECISION_VALUE

DEFAULT_PRECISION_VALUE

DEFAULT_SIZE_VALUE

DEFAULT_SIZE_VALUE

Methods

__construct()

__construct(string  $name, string  $field) 

Parameters

string $name

the name of this aggregation

string $field

the field on which to perform this aggregation

setField()

setField(string  $field) : $this

Set the field for this aggregation.

Parameters

string $field

the name of the document field on which to perform this aggregation

Returns

$this

setPrecision()

setPrecision(integer  $precision) : $this

Set the precision for this aggregation.

Parameters

integer $precision

an integer between 1 and 12, inclusive. Defaults to 5.

Returns

$this

setSize()

setSize(integer  $size) : $this

Set the maximum number of buckets to return.

Parameters

integer $size

defaults to 10,000

Returns

$this

setShardSize()

setShardSize(integer  $shardSize) : $this

Set the number of results returned from each shard.

Parameters

integer $shardSize

Returns

$this