Statement
in package
Statement encapsulates query statement parameters.
Table of Contents
Properties
- $bin_names : mixed
- $filter : mixed
- $index_name : mixed
- $namespace : mixed
- $setname : mixed
Methods
- __construct() : mixed
- getBinNames() : array<string|int, mixed>
- BinNames detemines bin names (optional)
- getFilter() : Filter|null
- Filter determines query index filter (Optional).
- getIndexName() : string|null
- IndexName determines query index name (Optional) If not set, the server will determine the index from the filter's bin name.
- getNamespace() : string
- Namespace determines query Namespace
- getSetname() : string
- SetName determines query Set name (Optional)
- setBinNames() : mixed
- setFilter() : mixed
- setIndexName() : mixed
- setNamespace() : mixed
- setSetname() : mixed
Properties
$bin_names
public
mixed
$bin_names
$filter
public
mixed
$filter
$index_name
public
mixed
$index_name
$namespace
public
mixed
$namespace
$setname
public
mixed
$setname
Methods
__construct()
public
__construct(string $namespace, string $set_name, mixed $filter, array<string|int, mixed>|null $bin_names) : mixed
Parameters
- $namespace : string
- $set_name : string
- $filter : mixed
- $bin_names : array<string|int, mixed>|null
getBinNames()
BinNames detemines bin names (optional)
public
getBinNames() : array<string|int, mixed>
Return values
array<string|int, mixed>getFilter()
Filter determines query index filter (Optional).
public
getFilter() : Filter|null
This filter is applied to the secondary index on query. Query index filters must reference a bin which has a secondary index defined.
Return values
Filter|nullgetIndexName()
IndexName determines query index name (Optional) If not set, the server will determine the index from the filter's bin name.
public
getIndexName() : string|null
Return values
string|nullgetNamespace()
Namespace determines query Namespace
public
getNamespace() : string
Return values
stringgetSetname()
SetName determines query Set name (Optional)
public
getSetname() : string
Return values
stringsetBinNames()
public
setBinNames(array<string|int, mixed> $bin_names) : mixed
Parameters
- $bin_names : array<string|int, mixed>
setFilter()
public
setFilter(mixed $filter) : mixed
Parameters
- $filter : mixed
setIndexName()
public
setIndexName(string|null $index_name) : mixed
Parameters
- $index_name : string|null
setNamespace()
public
setNamespace(string $namespace) : mixed
Parameters
- $namespace : string
setSetname()
public
setSetname(string $set_name) : mixed
Parameters
- $set_name : string