Interface FieldIndex

All Known Subinterfaces:
FlatVectorOptionalArgs, GeoIndex, HNSWVectorOptionalArgs, NumericIndex, TagIndex, TextIndex
All Known Implementing Classes:
FlatVectorIndexParams, GeoIndexParams, HNSWVectorIndexParams, NumericIndexParams, TagIndexParams, TextIndexParams

public interface FieldIndex
Author:
Nikita Koksharov
  • Method Details

    • numeric

      static NumericIndex numeric(String fieldName)
      Returns numeric field index
      Parameters:
      fieldName - field name
      Returns:
      options object
    • tag

      static TagIndex tag(String fieldName)
      Returns tag field index
      Parameters:
      fieldName - field name
      Returns:
      options object
    • text

      static TextIndex text(String fieldName)
      Returns text field index
      Parameters:
      fieldName - field name
      Returns:
      options object
    • flatVector

      static FlatVectorIndex flatVector(String fieldName)
      Returns vector field index which uses FLAT indexing method
      Parameters:
      fieldName - field name
      Returns:
      options object
    • hnswVector

      static HNSWVectorIndex hnswVector(String fieldName)
      Returns vector field index which uses HNSW indexing method
      Parameters:
      fieldName - field name
      Returns:
      options object
    • geo

      static GeoIndex geo(String fieldName)
      Returns geo field index
      Parameters:
      fieldName - field name
      Returns:
      options object