Package io.stargate.sdk.data.domain.query

Class SelectQueryBuilder

java.lang.Object
io.stargate.sdk.data.domain.query.SelectQueryBuilder
public class SelectQueryBuilder extends Object
Helper to build queries

  • Field Details

  • Constructor Details

    • SelectQueryBuilder

      public SelectQueryBuilder()
      Default constructor.

  • Method Details

    • select

      public SelectQueryBuilder select(String... keys)
      List of fields to be returned.
      Parameters:
      keys - keys
      Returns:
      reference to the builder

    • orderBy

      public SelectQueryBuilder orderBy(String key, Object value)
      Builder Pattern
      Parameters:
      key - updated key
      value - updated value
      Returns:
      self reference

    • orderByAnn

      public SelectQueryBuilder orderByAnn(float[] vector)
      Builder Pattern
      Parameters:
      vector - add vector in the order by
      Returns:
      self reference

    • orderByAnn

      public SelectQueryBuilder orderByAnn(@NonNull @NonNull String textFragment)
      Builder Pattern
      Parameters:
      textFragment - add text in the order by (vectorize)
      Returns:
      self reference

    • withLimit

      public SelectQueryBuilder withLimit(Integer limit)
      Max result.
      Parameters:
      limit - maximum number of returned object
      Returns:
      number of items

    • withSkip

      public SelectQueryBuilder withSkip(Integer skip)
      Max result.
      Parameters:
      skip - maximum number of returned object
      Returns:
      number of items

    • withPagingState

      public SelectQueryBuilder withPagingState(String pagingState)
      Paging State
      Parameters:
      pagingState - get second page
      Returns:
      current builder

    • includeSimilarity

      public SelectQueryBuilder includeSimilarity()
      Paging State
      Returns:
      current builder

    • withoutVector

      public SelectQueryBuilder withoutVector()
      Paging State
      Returns:
      current builder

    • withOption

      protected SelectQueryBuilder withOption(@NonNull @NonNull String key, @NonNull @NonNull Object value)
      Add an option to the request.
      Parameters:
      key - current key
      value - current value
      Returns:
      reference to self

    • filter

      public SelectQueryBuilder filter(Filter pFilter)
      Full filter as a json string.
      Parameters:
      pFilter - filter
      Returns:
      reference to self

    • where

      public SelectQueryBuilder where(String fieldName, FilterOperator op, Object value)
      Full filter as a json string.
      Parameters:
      fieldName - name of the filter
      op - operator
      value - simple filter
      Returns:
      reference to self

    • build

      public SelectQuery build()
      Terminal call to build immutable instance of SelectQuery.
      Returns:
      immutable instance of SelectQuery.