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

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:

Field
Definition
Example
Default

domain

Name of the query manager to read data from

product

-

inputElement

Json path for the input in event payload for query variables

parameters

-

outputElement

Json path for the output in response event payload

$.list

-

With event metadata parameters as:

Parameter
Definition
Example
Default

outputPattern

JMESPath pattern to apply on data output, before returning response

{id:id, name:data.name, description:data.description}

-

queryId

Id of the query to execute

product_search_0001

-

queryName

Name of the query to execute

Product Search

-

queryJson

Full Json representation of query to execute

-

-

sortPath

Json path in query results to be used for sorting

product.id

-

sorterPath

Json path in request event payload to be used for sorting

productids

-

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:

Field
Definition
Example
Default

domain

Name of the query manager to produce statement for

product

-

inputElement

Json path for the input in event payload for query variables

parameters

-

outputElement

Json path for the output in response event payload

$.query

-

With event metadata parameters as:

Parameter
Definition
Example
Default

queryId

Id of the query to execute

product_search_0001

-

queryJson

Full Json representation of query to execute

-

-

queryName

Name of the query to execute

Product Search

-

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

Last updated