Package kalix.javasdk.annotations

Annotation Interface Query

@Target(METHOD) @Retention(RUNTIME) @Documented public @interface Query
Annotation used in the scope of a view for providing the query that will be used to explore data from that view.

Note: the actual method implementation is irrelevant as the method itself is never actually executed, only the query

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Assigns the actual query which makes use of the enclosing entity table name as source of data for composition.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    streamUpdates
    If enabled, initially, the normal query results are returned, but the stream does not complete once the full result has been streamed, instead the stream is kept open and updates and new entries added to the view are streamed.

  • Element Details

    • value

      String value
      Assigns the actual query which makes use of the enclosing entity table name as source of data for composition.

    • streamUpdates

      boolean streamUpdates
      If enabled, initially, the normal query results are returned, but the stream does not complete once the full result has been streamed, instead the stream is kept open and updates and new entries added to the view are streamed. Can only be enabled in stream methods returning Flux.
      Default:
      false