redis.clients.jedis.search

Class Schema

java.lang.Object

redis.clients.jedis.search.Schema

public class Schema
extends Object

Schema abstracts the schema definition when creating an index. Documents can contain fields not mentioned in the schema, but the index will only index pre-defined fields

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schema.Field
static class	Schema.FieldType
static class	Schema.TagField
static class	Schema.TextField FullText field spec.
static class	Schema.VectorField

Field Summary

Fields

Modifier and Type	Field and Description
List<Schema.Field>	fields

Constructor Summary

Constructors

Constructor and Description
Schema()

Method Summary

Modifier and Type	Method and Description
Schema	addField(Schema.Field field)
Schema	addFlatVectorField(String name, Map<String,Object> attributes)
Schema	addGeoField(String name) Add a geo filtering field to the schema.
Schema	addHNSWVectorField(String name, Map<String,Object> attributes)
Schema	addNumericField(String name) Add a numeric field to the schema
Schema	addSortableNumericField(String name)
Schema	addSortableTagField(String name, String separator)
Schema	addSortableTextField(String name, double weight) Add a text field that can be sorted on
Schema	addTagField(String name)
Schema	addTagField(String name, String separator)
Schema	addTextField(String name, double weight) Add a text field to the schema with a given weight
Schema	addVectorField(String name, Schema.VectorField.VectorAlgo algorithm, Map<String,Object> attributes)
static Schema	from(Schema.Field... fields)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

fields

public final List<Schema.Field> fields

Constructor Detail

Schema

public Schema()

Method Detail

from

public static Schema from(Schema.Field... fields)

addTextField

public Schema addTextField(String name,
                           double weight)

Add a text field to the schema with a given weight

Parameters:

name - the field's name

weight - its weight, a positive floating point number

Returns:

the schema object

addSortableTextField

public Schema addSortableTextField(String name,
                                   double weight)

Add a text field that can be sorted on

Parameters:

name - the field's name

weight - its weight, a positive floating point number

Returns:

the schema object

addGeoField

public Schema addGeoField(String name)

Add a geo filtering field to the schema.

Parameters:

name - the field's name

Returns:

the schema object

addNumericField

public Schema addNumericField(String name)

Add a numeric field to the schema

Parameters:

name - the fields's nam e

Returns:

the schema object

addSortableNumericField

public Schema addSortableNumericField(String name)

addTagField

public Schema addTagField(String name)

addTagField

public Schema addTagField(String name,
                          String separator)

addSortableTagField

public Schema addSortableTagField(String name,
                                  String separator)

addVectorField

public Schema addVectorField(String name,
                             Schema.VectorField.VectorAlgo algorithm,
                             Map<String,Object> attributes)

addFlatVectorField

public Schema addFlatVectorField(String name,
                                 Map<String,Object> attributes)

addHNSWVectorField

public Schema addHNSWVectorField(String name,
                                 Map<String,Object> attributes)

addField

public Schema addField(Schema.Field field)

toString

public String toString()

Overrides:

toString in class Object