Class QueryIndex

Used to query a secondary index in Riak.

$command = (new Command\Builder\QueryIndex($riak))
  ->buildBucket('users')
  ->withIndex('users_name', 'Knuth')
  ->build();

$response = $command->execute($command);

$index_results = $response->getIndexResults();

Basho\Riak\Command\Builder

Extended by

Basho\Riak\Command\Builder\QueryIndex implements Basho\Riak\Command\BuilderInterface uses Basho\Riak\Command\Builder\BucketTrait, Basho\Riak\Command\Builder\IndexTrait

Namespace: Basho\Riak\Command\Builder
Author: Alex Moore
Located at Riak/Command/Builder/QueryIndex.php

Methods summary

`public Basho\Riak\Command\Indexes\Query`	# `build( )` Command build Command build Returns `Basho\Riak\Command\Indexes\Query` Implementation of `Basho\Riak\Command\BuilderInterface::build()`
`public boolean`	# `validate( )` Validate command Validate command Returns boolean Throws Builder\Exception Overrides `Basho\Riak\Command\Builder::validate`

Methods inherited from Basho\Riak\Command\Builder

__construct(), getConnection(), getParameters(), getVerbose(), required(), withParameter(), withParameters(), withVerboseMode()

Methods used from Basho\Riak\Command\Builder\BucketTrait

buildBucket(), getBucket(), inBucket()

Methods used from Basho\Riak\Command\Builder\IndexTrait

getContinuation(), getIndexName(), getLowerBound(), getMatchValue(), getMaxResults(), getPaginationSort(), getReturnTerms(), getTermFilter(), getTimeout(), getUpperBound(), isMatchQuery(), isParamSet(), isRangeQuery(), withContinuation(), withIndexName(), withMaxResults(), withPaginationSort(), withRangeValue(), withReturnTerms(), withScalarValue(), withTermFilter(), withTimeout()

Constants summary

Constants inherited from Basho\Riak\Command\BuilderInterface

Properties summary

Properties inherited from Basho\Riak\Command\Builder

$headers, $parameters, $riak, $verbose

Properties used from Basho\Riak\Command\Builder\BucketTrait

Properties used from Basho\Riak\Command\Builder\IndexTrait

$continuation, $indexName, $lowerBound, $match, $maxResults, $paginationSort, $returnTerms, $termFilter, $timeout, $upperBound