Query Data

This handler (com.rierino.handler.QueryEventHandler) provides ability to generate and execute system specific queries on a query manager on demand, from simple select statements to complex requests.

Handler Parameters

This handler is cacheable.

Parameter	Definition	Example	Default
query.state	Name of the state manager storing query definitions	customQueries	query

366B

handler-query-0001.json

Open

Example Query Handler Definition (Can be Imported on Element Screen)

Actions

GetQuery

Executes and returns results for a single query from a specific query manager. Event metadata fields applicable for this action are as follows:

Table

Field	Definition	Example	Default
Domain	Name of the query manager to read data from	product	-
Input Element	Json path for the input in event payload for query variables	parameters	-
Output Element	Json path for the output in response event payload	$.list	-

JSON Schema

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Output Pattern	JMESPath pattern to apply on data output, before returning response	{id:id, name:data.name, description:data.description}	-
Query ID	Id of the query to execute	product_search_0001	-
Query Name	Name of the query to execute	Product Search	-
Query Json	Full Json representation of query to execute	-	-
First	Whether to return first record only from results	true	false
Sort Path	Json path in query results to be used for sorting	product.id	-
Sorter Path	Json path in request event payload to be used for sorting	productids	-

JSON Schema

Example

Input

{
    "parameters": {
        "search": "test"
    }
}

Event Metadata

sortPath and sorterPath parameters are used to allow sorting of results by an already prioritized list of ids (such as product ids sorted based on search releavence).

ProduceQuery

Generates a query statement for a specific query manager, which is typically used by 3rd party systems in converting query objects into system specific requests. Event metadata fields applicable for this action are as follows:

Table

Field	Definition	Example	Default
Domain	Name of the query manager to produce statement for	product	-
Input Element	Json path for the input in event payload for query variables	parameters	-
Output Element	Json path for the output in response event payload	$.query	-

JSON Schema

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Query ID	Id of the query to execute	product_search_0001	-
Query Name	Name of the query to execute	Product Search	-
Query Json	Full Json representation of query to execute	-	-

JSON Schema

Produced statement is returned as a "query" field of the outputElement.