Skip to content

Commit

Permalink
Renamed variable in user guide sample query
Browse files Browse the repository at this point in the history
  • Loading branch information
ckunki committed Oct 8, 2024
1 parent 8c5899e commit cf2872e
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions doc/user_guide/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ class ExampleQueryHandler(UDFQueryHandler):
query_list = [
SelectQuery("SELECT 1 FROM DUAL"),
SelectQuery("SELECT 2 FROM DUAL")]
query_handler_input_query = SelectQueryWithColumnDefinition(
query_handler_return_query = SelectQueryWithColumnDefinition(
query_string="SELECT 5 AS 'return_column' FROM DUAL",
output_columns=[
Column(ColumnName("return_column"), ColumnType("INTEGER"))])
Expand All @@ -207,8 +207,10 @@ class ExampleQueryHandler(UDFQueryHandler):
return Finish(result=f"Assertion of the final result: 32 == {result}")
```

The figure below illustrates the execution of this algorithm implemented in `CustomQueryHandler` class. When method `start()` is called, it executes two queries and an additional `input_query` to obtain the next state.
The figure below illustrates the execution of this algorithm implemented in `ExampleQueryHandler` class.
* When method `start()` is called, it executes two queries and an additional `input_query` to obtain the next state.
* After the first iteration is completed, the framework calls method `handle_query_result` with the `query_result` of the `input_query` of the previous iteration.

After the first iteration is completed, the framework calls the `handle_query_result` method with the `query_result` of the `input_query` of the previous iteration. In this example, the algorithm is finished at this state, presents the two to the power of the return value as final result.
In this example, the algorithm is finished at this state, presents the two to the power of `return_value` as final result.

![Sample Execution](../images/sample_execution.png "Sample Execution")

0 comments on commit cf2872e

Please sign in to comment.