package io.axoniq.axonserver.grpc.query

Get desktop application:
View/edit binary Protocol Buffers messages

Service providing operations for the Query Messaging component of AxonServer

• rpc OpenStream (stream QueryProviderOutbound, stream QueryProviderInbound)

  query.proto:10

  Opens a Query- and Instruction stream to AxonServer.

  message QueryProviderOutbound

  query.proto:23

  Message containing Query related instructions for Axon Server

  • oneof request

    The actual instruction to send

    • QuerySubscription subscribe = 1

      Registers a Query Handler with AxonServer

    • QuerySubscription unsubscribe = 2

      Unregisters a Query Handler with AxonServer

    • FlowControl flow_control = 3

      Grant permits to AxonServer to send a number of messages to the client

    • QueryResponse query_response = 4

      Sends a Response to a Query received via the inbound stream

    • QueryComplete query_complete = 5

      Indicator that all responses for Query have been sent

    • SubscriptionQueryResponse subscription_query_response = 6

      Sends a response for a Subscription Query that has been received via the inbound stream

    • InstructionAck ack = 7

      Acknowledgement of previously sent instruction via inbound stream

  • string instruction_id = 8

    Instruction identifier. If this identifier is set, this instruction will be acknowledged via inbound stream

  message QueryProviderInbound

  query.proto:55

  Queries or Query related instructions from AxonServer for the connected application

  • oneof request

    The actual query or instruction

    • InstructionAck ack = 1

      Acknowledgement of previously sent instruction via outbound stream

    • QueryRequest query = 2

      Represents an incoming Query, for which this component is expected to provide a response

    • SubscriptionQueryRequest subscription_query_request = 3

      Represents an incoming Subscription Query, for which this component is expected to provide a response and updates

    • QueryReference query_cancel = 5

      Indicator that receiver is no more interested in updates of this query

    • QueryFlowControl query_flow_control = 6

      Indicator that receiver should send more updates of this query

  • string instruction_id = 4

    Instruction identifier. If this identifier is set, this instruction will be acknowledged via outbound stream

• rpc Query (QueryRequest, stream QueryResponse)

  query.proto:14

  Sends a point-to-point or scatter-gather Query

• rpc Subscription (stream SubscriptionQueryRequest, stream SubscriptionQueryResponse)

  query.proto:18

  Opens a Subscription Query

Message indicating that query has been completed.

Used in: QueryProviderOutbound

• string message_id = 1

  A unique identifier for this message

• string request_id = 2

  The identifier of the incoming query to complete

Message indicating that consumer is requesting more messages from producer.

Used in: QueryProviderInbound

• optional QueryReference query_reference = 1

  The identifier of the incoming query to complete

• int64 permits = 2

  Number of messages requested

Used in: QueryFlowControl, QueryProviderInbound

• string request_id = 1

  The identifier of the query request.

Message representing an incoming Query

Used as request type in: QueryService.Query

Used as field type in: QueryProviderInbound, SubscriptionQuery

• string message_identifier = 1

  The message ID of the incoming Query

• string query = 2

  The name of the Query to execute

• int64 timestamp = 3

  The timestamp of the Query creation

• optional SerializedObject payload = 4

  A payload accompanying the Query

• map<string, MetaDataValue> meta_data = 5

  Meta Data providing contextual information of the Query

• optional SerializedObject response_type = 6

  An object describing the expectations of the Response Type. Deprecated. no longer used in Axon Framework 5

• repeated ProcessingInstruction processing_instructions = 7

  Any instructions for components Routing or Handling the Query

• string client_id = 8

  The unique identifier of the client instance dispatching the query

• string component_name = 9

  The Name of the Component dispatching the query

Message that represents the Response to a Query

Used as response type in: QueryService.Query

Used as field type in: QueryProviderOutbound, SubscriptionQueryResponse

• string message_identifier = 1

  The unique identifier of the Response Message

• string error_code = 2

  An Error Code identifying the type of error, if any

• optional ErrorMessage error_message = 3

  A detailed description of the error, if any

• optional SerializedObject payload = 4

  The Payload of the Response Message

• map<string, MetaDataValue> meta_data = 5

  Any Meta Data describing the context of the Response Message

• repeated ProcessingInstruction processing_instructions = 6

  Any instructions for components Routing or Handling the Response Message

• string request_identifier = 7

  The unique identifier of the Query to which this is a response

Message containing details of a Registration of a Query Handler in a component

Used in: QueryProviderOutbound

• string message_id = 1

  The unique identifier of this Message

• string query = 2

  The name of the Query the Handler is subscribed to

• string result_name = 3

  The type of Result this Handler produces

• string component_name = 4

  The name of the Component containing the Query Handler

• string client_id = 5

  The unique identifier of the Client Instance containing the Query Handler

A message containing an Update of a Query Subscription Response

Used in: SubscriptionQueryResponse

• string message_identifier = 2

  The unique identifier of this Update

• optional SerializedObject payload = 3

  The object representing the Update

• map<string, MetaDataValue> meta_data = 4

  Meta Data providing contextual information of the Update

• string client_id = 5

  The identifier of the Client instance providing the Update

• string component_name = 6

  The Component Name of the Client providing the Update

• string error_code = 7

  An Error Code identifying the type of error, if any

• optional ErrorMessage error_message = 8

  A detailed description of the error, if any

Message indicating that all relevant Updates have been sent for a Subscription Query, and that no further Updates are available

Used in: SubscriptionQueryResponse

• string client_id = 2

  The identifier of the Client instance providing the Update

• string component_name = 3

  The Component Name of the Client providing the Update

Message indicating that an Error occurred and that no Updates will be sent for a Subscription Query

Used in: SubscriptionQueryResponse

• string client_id = 2

  The identifier of the Client instance providing the Update

• string component_name = 3

  The Component Name of the Client providing the Update

• string error_code = 5

  The Code describing the type of Error that occurred

• optional ErrorMessage error_message = 6

  A detailed description of the error, if available

Message that represents a Subscription Query

Used in: SubscriptionQueryRequest

• string subscription_identifier = 1

  A unique identifier for this subscription

• int64 number_of_permits = 2

  The number of messages the Server may send before needing to await additional permits

• optional QueryRequest query_request = 3

  The Query describing the desire for information

• optional SerializedObject update_response_type = 4

  A description of the type of Object expected as Update Responses. Deprecated: queries don't need to provide expected response types

Message describing possible interactions for a Subscription Query

Used as request type in: QueryService.Subscription

Used as field type in: QueryProviderInbound

• oneof request

  The actual request. The Subscription Query is opened using a `subscribe`, which opens the flow of updates. Once successful, the `get_initial_result` retrieves the initial result of the subscription. For the server to send more updates than the initial number of permits, use the `flow_control` request to send more permits.

  • SubscriptionQuery subscribe = 1

    Start a Subscription Query with the given details.

  • SubscriptionQuery unsubscribe = 2

    Ends a previously started Subscription Query with the given details

  • SubscriptionQuery get_initial_result = 3

    Requests the initial result of a subscription query to be sent. This should always be done after opening the subscription query itself, to remove concurrency conflicts with Update messages. Note that this request is deprecated. It is recommended to retrieve the initial request using a regular query.

  • SubscriptionQuery flow_control = 4

    Allows the Server to provide additional Updates to be sent. Only the `number_of_permits` field needs to be set on this message.

Represents a Response Message for a Subscription Query

Used as response type in: QueryService.Subscription

Used as field type in: QueryProviderOutbound

• string message_identifier = 1

  The unique identifier for this message

• string subscription_identifier = 2

  The identifier of the subscription query this is a response for

• oneof response

  The actual response. The `initial_result` message is sent as a response to `get_initial_result`. An `update` messages is sent for each update available for the query, even before the Initial Result is supplied. The `complete` or `complete_exceptionally` are sent when the publishing side completed the Subscription Query, either regularly (`complete`) or because an error occurred (`complete_exceptionally`).

  • QueryResponse initial_result = 3

    Provides an Initial Response

  • QueryUpdate update = 4

    Provides an Update Response

  • QueryUpdateComplete complete = 5

    Indicates the Query is complete, and no more Updates will be sent

  • QueryUpdateCompleteExceptionally complete_exceptionally = 6

    Indicates the Query failed exceptionally, and no more Updates will be sent