com.basho.riak.client.api.commands.search

Class Search

java.lang.Object

com.basho.riak.client.api.RiakCommand<R,I>

com.basho.riak.client.api.AsIsRiakCommand<SearchOperation.Response,BinaryValue>

com.basho.riak.client.api.commands.search.Search

public final class Search
extends AsIsRiakCommand<SearchOperation.Response,BinaryValue>

Command used to perform a search in Riak.

To do a search in Riak, you must have search turned on, indexes created, and documents/objects indexed. Please see http://docs.basho.com/riak/latest/dev/using/search/ for more information. To use the Search class, you need a minimum of an Index to search, and a query to execute. Other options are available for pagination, sorting, filtering and what fields to return.

 String index = "Author_Biographies";
 String query = "name_s:Al* AND bio_tsd:awesome";

 Search sch =
      new Search.Builder(index, query).withRows(10).build();
 SearchOperation.Response response = client.execute(sch);

All operations can called async as well.

 ...
 RiakFuture<SearchOperation.Response, BinaryValue> future = client.executeAsync(sv);
 ...
 future.await();
 if (future.isSuccess())
 {
     ...
 }

Since:

2.0

Author:

Dave Rusek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Search.Builder Builder for a Search command.
static class	Search.Option<T>
static class	Search.Presort Enum that encapsulates the possible settings for a search command's presort setting.

Constructor Summary

Constructors

Constructor and Description
Search(Search.Builder builder)

Method Summary

Modifier and Type	Method and Description
protected SearchOperation	buildCoreOperation()

Methods inherited from class com.basho.riak.client.api.AsIsRiakCommand

executeAsync

Methods inherited from class com.basho.riak.client.api.RiakCommand

execute, execute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Search

public Search(Search.Builder builder)

Method Detail

buildCoreOperation

protected SearchOperation buildCoreOperation()

Specified by:

buildCoreOperation in class AsIsRiakCommand<SearchOperation.Response,BinaryValue>