Graph Query API

The graph API is an experimental feature in Siren Federate and is subject to change. This feature is available only in clusters with a valid license and the graph module enabled.

The graph query API represents a paradigm shift in the search experience — from searching documents to searching graphs. This API abstracts how the data is searched from how the data is stored in Elasticsearch.

This allows the user to reason in terms of graphs, rather than in terms of nested joins — as is dictated by the JSON query DSL. Thanks to the Graph Query Language (GQL), a standardized query language, the graph API enables the user to express complex matching patterns — which would be, with the JSON query DSL, either cumbersome for the simplest, to simply impossible for the more complex ones.

The REST API presents how to use this new API. The data model represents data indexed in Elasticsearch with a graph modeling based on Entities and Relations. There are several examples of using GQL to query data, based on a model previously defined. The GQL syntax is presented then in detail. The set of paths to match can also be restricted using a selective path search.