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

Class UpdateQueryBuilder

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

  • Field Details

  • Constructor Details

    • UpdateQueryBuilder

      public UpdateQueryBuilder()
      Default constructor.

  • Method Details

    • orderBy

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

    • orderByAnn

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

    • orderByAnn

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

    • withUpsert

      public UpdateQueryBuilder withUpsert()
      Max result.
      Returns:
      number of items

    • withReturnDocument

      public UpdateQueryBuilder withReturnDocument(UpdateQueryBuilder.ReturnDocument returnDocument)
      Specifies which document to perform the projection on. If `before` the projection is performed on the document before the update is applied, if `after` the document projection is from the document after the update.
      Parameters:
      returnDocument - document returned
      Returns:
      current builder

    • enableUpsert

      public UpdateQueryBuilder enableUpsert()
      Upsert: "When `true`, if no documents match the `filter` clause the command will create a new _empty_ document and apply the `update` clause and all equality filters to the empty document."
      Returns:
      current builder

    • withOption

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

    • filter

      public UpdateQueryBuilder filter(String jsonFilter)
      Full filter as a json string.
      Parameters:
      jsonFilter - filter
      Returns:
      reference to self

    • filter

      public UpdateQueryBuilder filter(Filter pFilter)
      Full filter as a filter object
      Parameters:
      pFilter - filter
      Returns:
      reference to self

    • where

      public UpdateQueryBuilder 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

    • withJsonUpdate

      public UpdateQueryBuilder withJsonUpdate(String jsonUpdate)
      Full update as a json string.
      Parameters:
      jsonUpdate - content of the update as json
      Returns:
      reference to self

    • replaceBy

      public <DOC> UpdateQueryBuilder replaceBy(Document<DOC> replacement)
      Builder pattern
      Type Parameters:
      DOC - type of document
      Parameters:
      replacement - new value for document
      Returns:
      reference to self

    • updateInc

      public UpdateQueryBuilder updateInc(String key, Integer offset)
      Builder pattern
      Parameters:
      key - field name
      offset - increment value
      Returns:
      reference to self

    • updateUnset

      public UpdateQueryBuilder updateUnset(String key)
      Builder pattern
      Parameters:
      key - field name
      Returns:
      reference to self

    • updateSet

      public UpdateQueryBuilder updateSet(String key, Object value)
      Builder pattern
      Parameters:
      key - field name
      value - filed value
      Returns:
      reference to self

    • updateMin

      public UpdateQueryBuilder updateMin(String key, Object value)
      Builder pattern
      Parameters:
      key - field name
      value - filed value
      Returns:
      reference to self

    • updatePush

      public UpdateQueryBuilder updatePush(String key, Object value)
      Builder pattern
      Parameters:
      key - field name
      value - filed value
      Returns:
      reference to self

    • updatePop

      public UpdateQueryBuilder updatePop(String key, Object value)
      Builder pattern
      Parameters:
      key - field name
      value - filed value
      Returns:
      reference to self

    • updatePushEach

      public UpdateQueryBuilder updatePushEach(String key, List<Object> values, Integer position)
      Builder pattern.
      Parameters:
      key - field name
      values - filed list values
      position - where to push in the list
      Returns:
      reference to self

    • updateAddToSet

      public UpdateQueryBuilder updateAddToSet(String key, Object value)
      Builder pattern
      Parameters:
      key - field name
      value - filed value
      Returns:
      reference to self

    • updateRename

      public UpdateQueryBuilder updateRename(@NonNull @NonNull Map<String,String> fields)
      Builder pattern
      Parameters:
      fields - fields to rename
      Returns:
      reference to self

    • build

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