Package 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

  • Field Details

  • Constructor Details

    • Schema

      public Schema()

  • Method Details

    • 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)

    • addTagField

      public Schema addTagField(String name, boolean caseSensitive)

    • addTagField

      public Schema addTagField(String name, String separator, boolean caseSensitive)

    • addSortableTagField

      public Schema addSortableTagField(String name, String separator)

    • addSortableTagField

      public Schema addSortableTagField(String name, boolean caseSensitive)

    • addSortableTagField

      public Schema addSortableTagField(String name, String separator, boolean caseSensitive)

    • 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)

    • as

      public Schema as(String attribute)
      Chain as name to the last filed added to the schema
      Parameters:
      attribute -

    • toString

      public String toString()
      Overrides:
      toString in class Object