diff --git a/docs/doc/hefquin_service.html b/docs/doc/hefquin_service.html index 2e5fe4110b..d6b2b95773 100644 --- a/docs/doc/hefquin_service.html +++ b/docs/doc/hefquin_service.html @@ -98,50 +98,51 @@
Furthermore, the client may include any of the following headers to control the query processing or to
request additional information about the query and its execution. The headers that request additional
- information in the response are only supported if the response format is JSON.
+ information in the response are only supported if the response format is JSON. Each header accepts the
+ value true or false. The default value is false.
X-HeFQUIN-Skip-Execution - Use this argument if you want HeFQUIN to create the query
+ X-HeFQUIN-Skip-Execution - Use this header if you want HeFQUIN to create the query
execution plan for the given query, but without actually executing this plan.X-HeFQUIN-Print-Source-Assignment - Use this argument to instruct the query planning
+ X-HeFQUIN-Print-Source-Assignment - Use this header to instruct the query planning
component of HeFQUIN to include the initial logical plan that is the output of the source selection
& query decomposition process in the response; i.e., this is the logical plan that is passed as
input to the logical query optimizer.
To include the plan in the JSON response, it is represented as a single (multi-line) string that is
given as value for a key named sourceAssignment.
- X-HeFQUIN-Print-Logical-Plan - Use this argument to instruct the query planning
+ X-HeFQUIN-Print-Logical-Plan - Use this header to instruct the query planning
component of HeFQUIN to include the logical plan that is the output of the logical query optimizer
in the response; i.e., this is the logical plan that is passed as input to the physical query
optimizer. To include the plan in the JSON response, it is represented as a single (multi-line) string
that is given as a value for a key named logicalPlan.
- X-HeFQUIN-Print-Physical-Plan - Use this argument to instruct the query planning
+ X-HeFQUIN-Print-Physical-Plan - Use this header to instruct the query planning
component of HeFQUIN to include the physical plan that is the output of the physical query optimizer
in the response; i.e., this is the physical plan that is used to execute the query. To include the plan
in the JSON response, it is represented as a single (multi-line) string that is given as a value for a
key named physicalPlan.
- X-HeFQUIN-Print-Executable-Plan - Use this argument to instruct the query planning
+ X-HeFQUIN-Print-Executable-Plan - Use this header to instruct the query planning
component of HeFQUIN to include the executable plan produced by the query planning component in the
response; i.e., this is the plan consisting of the concrete executable operators that are used to
execute the query. To include the plan in the JSON response, it is represented as a single (multi-line)
string that is given as a value for a key named executablePlan.
- X-HeFQUIN-Return-Query-Proc-Stats - Use this argument to instruct the HeFQUIN engine
+ X-HeFQUIN-Return-Query-Proc-Stats - Use this header to instruct the HeFQUIN engine
to include detailed statistics about the query planning and the query execution processes, as
collected by the different components involved in these processes (including the operators that
have been part of the query execution plan), in the response. To include the statistics in the JSON
response, they are represented as a JSON object that is given as a value for a key named
queryProcStats.X-HeFQUIN-Return-Fed-Access-Stats - Use this argument to instruct the HeFQUIN engine
+ X-HeFQUIN-Return-Fed-Access-Stats - Use this header to instruct the HeFQUIN engine
to include detailed statistics collected by the federation access component of HeFQUIN in the
response. To include the statistics in the JSON response, they are represented as a JSON object that
is given as a value for a key namedfedAccessStats.X-HeFQUIN-Return-Full-Stack-Trace - Use this argument to instruct the HeFQUIN engine
+ X-HeFQUIN-Return-Full-Stack-Trace - Use this header to instruct the HeFQUIN engine
to include the complete stack trace for each exception, in addition to the exception message,
in the exceptions field of the JSON response.X-HeFQUIN-Ignore-Retrieval-Cache - Use this argument to instruct the HeFQUIN engine
+ X-HeFQUIN-Ignore-Retrieval-Cache - Use this header to instruct the HeFQUIN engine
to bypass the retrieval cache when processing the query, which means that every data retrieval request
during every execution is indeed executed instead of being served from the cache. The responses received
for these requests are still used to update the cache.X-HeFQUIN-Ignore-Cardinality-Cache - Use this argument to instruct the HeFQUIN engine
+ X-HeFQUIN-Ignore-Cardinality-Cache - Use this header to instruct the HeFQUIN engine
to bypass the cardinality cache when processing the query, which means that cardinality requests are
indeed issued instead of being served from the cache.
The responses obtained via such requests are still used to update the cache.