Skip navigation links
A B C D E F G H I K L M N P Q R S T U V W _ 

A

addDocument(String, double, Map<String, Object>, boolean, boolean, byte[]) - Method in class io.redisearch.client.Client
Add a single document to the query
addDocument(String, double, Map<String, Object>) - Method in class io.redisearch.client.Client
See above
addDocument(String, Map<String, Object>) - Method in class io.redisearch.client.Client
See above
addField(Schema.Field) - Method in class io.redisearch.Schema
 
addFilter(Query.Filter) - Method in class io.redisearch.Query
Add a filter to the query's filter list
addGeoField(String) - Method in class io.redisearch.Schema
Add a geo filtering field to the schema.
addHash(String, double, boolean) - Method in class io.redisearch.client.Client
Index a document already in redis as a HASH key.
addNumericField(String) - Method in class io.redisearch.Schema
Add a numeric field to the schema
addSortableNumericField(String) - Method in class io.redisearch.Schema
 
addSortableTextField(String, double) - Method in class io.redisearch.Schema
Add a text field that can be sorted on
addTextField(String, double) - Method in class io.redisearch.Schema
Add a text field to the schema with a given weight
AutoCompleter - Class in io.redisearch.client
TODO: Abstract auto-complete commands
AutoCompleter() - Constructor for class io.redisearch.client.AutoCompleter
 
AutoCompleter.Command - Enum in io.redisearch.client
 

B

broadcast(String...) - Method in class io.redisearch.client.ClusterClient
 

C

Client - Class in io.redisearch.client
Client is the main RediSearch client class, wrapping connection management and all RediSearch commands
Client(String, String, int, int, int) - Constructor for class io.redisearch.client.Client
Create a new client to a RediSearch index
Client(String, String, int) - Constructor for class io.redisearch.client.Client
 
Client.IndexOptions - Class in io.redisearch.client
IndexOptions encapsulates flags for index creation and shuold be given to the client on index creation
ClusterClient - Class in io.redisearch.client
Created by dvirvolk on 12/04/2017.
ClusterClient(String, String, int, int, int) - Constructor for class io.redisearch.client.ClusterClient
Create a new client to a RediSearch index
ClusterClient(String, String, int) - Constructor for class io.redisearch.client.ClusterClient
 
ClusterCommands() - Constructor for class io.redisearch.client.Commands.ClusterCommands
 
commands - Variable in class io.redisearch.client.Client
 
Commands - Class in io.redisearch.client
Jedis enum for command encapsulation
Commands() - Constructor for class io.redisearch.client.Commands
 
Commands.ClusterCommand - Enum in io.redisearch.client
 
Commands.ClusterCommands - Class in io.redisearch.client
 
Commands.Command - Enum in io.redisearch.client
 
Commands.CommandProvider - Interface in io.redisearch.client
 
Commands.SingleNodeCommands - Class in io.redisearch.client
 
createIndex(Schema, Client.IndexOptions) - Method in class io.redisearch.client.Client
Create the index definition in redis

D

Default() - Static method in class io.redisearch.client.Client.IndexOptions
The default indexing options - use term offsets and keep fields flags
DEFAULT_FLAGS - Static variable in class io.redisearch.client.Client.IndexOptions
 
deleteDocument(String) - Method in class io.redisearch.client.Client
Delete a document from the index.
docs - Variable in class io.redisearch.SearchResult
 
Document - Class in io.redisearch
Document represents a single indexed document or entity in the engine
Document(String, Double) - Constructor for class io.redisearch.Document
 
Document(String) - Constructor for class io.redisearch.Document
 
dropIndex() - Method in class io.redisearch.client.Client
Drop the index and all associated keys, including documents

E

explain(Query) - Method in class io.redisearch.client.Client
Generate an explanatory textual query tree for this query string

F

FEET - Static variable in class io.redisearch.Query.GeoFilter
 
Field(String, Schema.FieldType, boolean) - Constructor for class io.redisearch.Schema.Field
 
Field(String, Schema.FieldType, boolean, boolean) - Constructor for class io.redisearch.Schema.Field
 
fields - Variable in class io.redisearch.Schema
 

G

GeoFilter(String, double, double, double, String) - Constructor for class io.redisearch.Query.GeoFilter
 
get(String) - Method in class io.redisearch.Document
return the property value inside a key
getAddCommand() - Method in class io.redisearch.client.Commands.ClusterCommands
 
getAddCommand() - Method in interface io.redisearch.client.Commands.CommandProvider
 
getAddCommand() - Method in class io.redisearch.client.Commands.SingleNodeCommands
 
getAddHashCommand() - Method in class io.redisearch.client.Commands.ClusterCommands
 
getAddHashCommand() - Method in interface io.redisearch.client.Commands.CommandProvider
 
getAddHashCommand() - Method in class io.redisearch.client.Commands.SingleNodeCommands
 
getCreateCommand() - Method in class io.redisearch.client.Commands.ClusterCommands
 
getCreateCommand() - Method in interface io.redisearch.client.Commands.CommandProvider
 
getCreateCommand() - Method in class io.redisearch.client.Commands.SingleNodeCommands
 
getDelCommand() - Method in class io.redisearch.client.Commands.ClusterCommands
 
getDelCommand() - Method in interface io.redisearch.client.Commands.CommandProvider
 
getDelCommand() - Method in class io.redisearch.client.Commands.SingleNodeCommands
 
getDropCommand() - Method in class io.redisearch.client.Commands.ClusterCommands
 
getDropCommand() - Method in interface io.redisearch.client.Commands.CommandProvider
 
getDropCommand() - Method in class io.redisearch.client.Commands.SingleNodeCommands
 
getExplainCommand() - Method in class io.redisearch.client.Commands.ClusterCommands
 
getExplainCommand() - Method in interface io.redisearch.client.Commands.CommandProvider
 
getExplainCommand() - Method in class io.redisearch.client.Commands.SingleNodeCommands
 
getId() - Method in class io.redisearch.Document
 
getInfo() - Method in class io.redisearch.client.Client
Get the index info, including memory consumption and other statistics.
getInfoCommand() - Method in class io.redisearch.client.Commands.ClusterCommands
 
getInfoCommand() - Method in interface io.redisearch.client.Commands.CommandProvider
 
getInfoCommand() - Method in class io.redisearch.client.Commands.SingleNodeCommands
 
getNoContent() - Method in class io.redisearch.Query
 
getPayload() - Method in class io.redisearch.Document
 
getRaw() - Method in enum io.redisearch.client.AutoCompleter.Command
 
getRaw() - Method in enum io.redisearch.client.Commands.ClusterCommand
 
getRaw() - Method in enum io.redisearch.client.Commands.Command
 
getScore() - Method in class io.redisearch.Document
 
getSearchCommand() - Method in class io.redisearch.client.Commands.ClusterCommands
 
getSearchCommand() - Method in interface io.redisearch.client.Commands.CommandProvider
 
getSearchCommand() - Method in class io.redisearch.client.Commands.SingleNodeCommands
 
getWithPayloads() - Method in class io.redisearch.Query
 
getWithScores() - Method in class io.redisearch.Query
 

H

hasProperty(String) - Method in class io.redisearch.Document
 
highlightFields - Variable in class io.redisearch.Query
 
highlightFields(Query.HighlightTags, String...) - Method in class io.redisearch.Query
 
highlightFields(String...) - Method in class io.redisearch.Query
 
highlightTags - Variable in class io.redisearch.Query
 
HighlightTags(String, String) - Constructor for class io.redisearch.Query.HighlightTags
 

I

IndexOptions(int) - Constructor for class io.redisearch.client.Client.IndexOptions
Default constructor
io.redisearch - package io.redisearch
 
io.redisearch.client - package io.redisearch.client
 

K

KEEP_FIELD_FLAGS - Static variable in class io.redisearch.client.Client.IndexOptions
If set (default), we keep flags per index record telling us what fields the term appeared on, and allowing us to filter results by field
KEEP_TERM_FREQUENCIES - Static variable in class io.redisearch.client.Client.IndexOptions
With each document:term record, store how often the term appears within the document.
KILOMETERS - Static variable in class io.redisearch.Query.GeoFilter
 

L

limit(Integer, Integer) - Method in class io.redisearch.Query
Limit the results to a certain offset and limit
limitFields(String...) - Method in class io.redisearch.Query
Limit the query to results that are limited to a specific set of fields
load(String, Double, byte[], List) - Static method in class io.redisearch.Document
 

M

METERS - Static variable in class io.redisearch.Query.GeoFilter
 
MILES - Static variable in class io.redisearch.Query.GeoFilter
 

N

name - Variable in class io.redisearch.Schema.Field
 
noindex - Variable in class io.redisearch.Schema.Field
 
NumericFilter(String, double, boolean, double, boolean) - Constructor for class io.redisearch.Query.NumericFilter
 
NumericFilter(String, double, double) - Constructor for class io.redisearch.Query.NumericFilter
 

P

Paging(int, int) - Constructor for class io.redisearch.Query.Paging
 

Q

Query - Class in io.redisearch
Query represents query parameters and filters to load results from the engine
Query(String) - Constructor for class io.redisearch.Query
Create a new index
Query.GeoFilter - Class in io.redisearch
GeoFilter encapsulates a radius filter on a geographical indexed fields
Query.HighlightTags - Class in io.redisearch
 
Query.NumericFilter - Class in io.redisearch
NumericFilter wraps a range filter on a numeric field.
Query.Paging - Class in io.redisearch
 

R

replaceDocument(String, double, Map<String, Object>) - Method in class io.redisearch.client.Client
replaceDocument is a convenience for calling addDocument with replace=true

S

Schema - Class in io.redisearch
Schema abstracs the schema definition when creating an index.
Schema() - Constructor for class io.redisearch.Schema
 
Schema.Field - Class in io.redisearch
 
Schema.FieldType - Enum in io.redisearch
 
Schema.TextField - Class in io.redisearch
FullText field spec.
search(Query) - Method in class io.redisearch.client.Client
Search the index
SearchResult - Class in io.redisearch
SearchResult encapsulates the returned result from a search query.
SearchResult(List<Object>, boolean, boolean, boolean) - Constructor for class io.redisearch.SearchResult
 
serializeRedisArgs(List<String>) - Method in class io.redisearch.client.Client.IndexOptions
 
serializeRedisArgs(List<byte[]>) - Method in class io.redisearch.Query.GeoFilter
 
serializeRedisArgs(List<byte[]>) - Method in class io.redisearch.Query.NumericFilter
 
serializeRedisArgs(List<byte[]>) - Method in class io.redisearch.Query
 
serializeRedisArgs(List<String>) - Method in class io.redisearch.Schema.Field
 
serializeRedisArgs(List<String>) - Method in class io.redisearch.Schema.TextField
 
set(String, Object) - Method in class io.redisearch.Document
 
setLanguage(String) - Method in class io.redisearch.Query
Set the query language, for stemming purposes
setNoContent() - Method in class io.redisearch.Query
Set the query not to return the contents of documents, and rather just return the ids
SetNoStopwords() - Method in class io.redisearch.client.Client.IndexOptions
Set the index to contain no stopwords, overriding the default list
setNoStopwords() - Method in class io.redisearch.Query
Set the query not to filter for stopwords.
setPayload(byte[]) - Method in class io.redisearch.Query
 
setScore(float) - Method in class io.redisearch.Document
Set the document's score
setSortBy(String, boolean) - Method in class io.redisearch.Query
Set the query to be sorted by a sortable field defined in the schem
SetStopwords(String...) - Method in class io.redisearch.client.Client.IndexOptions
Set a custom stopword list
setVerbatim() - Method in class io.redisearch.Query
Set the query to verbatim mode, disabling stemming and query expansion
setWithPaload() - Method in class io.redisearch.Query
Set the query to return object payloads, if any were given
setWithScores() - Method in class io.redisearch.Query
Set the query to return a factored score for each results.
SingleNodeCommands() - Constructor for class io.redisearch.client.Commands.SingleNodeCommands
 
sortable - Variable in class io.redisearch.Schema.Field
 
summarizeFields - Variable in class io.redisearch.Query
 
summarizeFields(int, int, String, String...) - Method in class io.redisearch.Query
 
summarizeFields(String...) - Method in class io.redisearch.Query
 
summarizeFragmentLen - Variable in class io.redisearch.Query
 
summarizeNumFragments - Variable in class io.redisearch.Query
 
summarizeSeparator - Variable in class io.redisearch.Query
 

T

TextField(String, double) - Constructor for class io.redisearch.Schema.TextField
 
TextField(String, double, boolean) - Constructor for class io.redisearch.Schema.TextField
 
TextField(String, double, boolean, boolean) - Constructor for class io.redisearch.Schema.TextField
 
TextField(String, double, boolean, boolean, boolean) - Constructor for class io.redisearch.Schema.TextField
 
TextField(String) - Constructor for class io.redisearch.Schema.TextField
 
toString() - Method in class io.redisearch.Document
 
totalResults - Variable in class io.redisearch.SearchResult
 
type - Variable in class io.redisearch.Schema.Field
 

U

updateDocument(String, double, Map<String, Object>) - Method in class io.redisearch.client.Client
Replace specific fields in a document.
USE_TERM_OFFSETS - Static variable in class io.redisearch.client.Client.IndexOptions
Set this to tell the index not to save term offset vectors.

V

valueOf(String) - Static method in enum io.redisearch.client.AutoCompleter.Command
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.redisearch.client.Commands.ClusterCommand
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.redisearch.client.Commands.Command
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.redisearch.Schema.FieldType
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.redisearch.client.AutoCompleter.Command
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.redisearch.client.Commands.ClusterCommand
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.redisearch.client.Commands.Command
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.redisearch.Schema.FieldType
Returns an array containing the constants of this enum type, in the order they are declared.

W

wantsHighlight - Variable in class io.redisearch.Query
 
wantsSummarize - Variable in class io.redisearch.Query
 

_

_fields - Variable in class io.redisearch.Query
 
_filters - Variable in class io.redisearch.Query
The query's filter list.
_language - Variable in class io.redisearch.Query
 
_noContent - Variable in class io.redisearch.Query
 
_noStopwords - Variable in class io.redisearch.Query
 
_paging - Variable in class io.redisearch.Query
The sorting parameters
_payload - Variable in class io.redisearch.Query
 
_queryString - Variable in class io.redisearch.Query
The textual part of the query
_sortAsc - Variable in class io.redisearch.Query
 
_sortBy - Variable in class io.redisearch.Query
 
_verbatim - Variable in class io.redisearch.Query
 
_withPayloads - Variable in class io.redisearch.Query
 
_withScores - Variable in class io.redisearch.Query
 
A B C D E F G H I K L M N P Q R S T U V W _ 
Skip navigation links

Copyright © 2018. All rights reserved.