Skip to main content
Version: v20 R4 BETA

Getting Server Information

You can get several information from the REST server:

  • the exposed datastores and their attributes
  • the REST server cache contents, including user sessions.

Catalog​

Use the $catalog, $catalog/{dataClass}, or $catalog/$all parameters to get the list of exposed dataclasses and their attributes.

To get the collection of all exposed dataclasses along with their attributes:

GET /rest/$catalog/$all

Cache info​

Use the $info parameter to get information about the entity selections currently stored in 4D Server's cache as well as running user sessions.

queryPath and queryPlan​

Entity selections that are generated through queries can have the following two properties: queryPlan and queryPath. To calculate and return these properties, you just need to add $queryPlan and/or $queryPath in the REST request.

For example:

GET /rest/People/$filter="employer.name=acme AND lastName=Jones"&$queryplan=true&$querypath=true

These properties are objects that contain information about how the server performs composite queries internally through dataclasses and relations:

  • queryPlan: object containing the detailed description of the query just before it was executed (i.e., the planned query).
  • queryPath: object containing the detailed description of the query as it was actually performed.

The information recorded includes the query type (indexed and sequential) and each necessary subquery along with conjunction operators. Query paths also contain the number of entities found and the time required to execute each search criterion. You may find it useful to analyze this information while developing your application. Generally, the description of the query plan and its path are identical but they can differ because 4D can implement dynamic optimizations when a query is executed in order to improve performance. For example, the 4D engine can dynamically convert an indexed query into a sequential one if it estimates that it is faster. This particular case can occur when the number of entities being searched for is low.