Hi all,
I'm aspiring to a nice & tidy REST API for my app. ES forms part of my
app, but unfortunately the complexity of search is dirtying my lovely API.
Across the rest of the system I've managed to included all data in the URI
which both has a functional beauty, but it also offers opportunities for
cache-ing, either at the server or the client.
In my ES searches, I'm able to encode the search in the URI, using "
_search?q=user:kimchy". But, to get the facets that relate to that search
I'll have to switch to storing the data in a JSON payload.
I imagine it's possible to use a similar encoding to list which facets
should be present in the results, particularly if the field-name is both
used to specify which field to select, plus what to call the results object
in the return payload.
I'd like to find out if there's any chance that facets could be included in
the URI construct. Is it technically possible?
I have begun working on something that would do exactly that and more.
This is the concept of search templates. Basically you can define a
template using the full query DSL with variables inside of it. When
you search you precise which template you want to use and the
variables in the templates are replaced using variables from the uri.
This approach has a lot of advantages:
less network transfer for each query which can be quite important if
you have a lot of complex queries
it is easier to cache results in cache layers like varnish and you
can even change your templates without invalidating the cache
you generally use only a few classes of queries in a common
application so it is very clear if you define a search template for
each class of query what queries you are actually using
you can abstract query complexity from search clients and expose
precisely the kind of queries and parameters you want. Even if the
templates are quite complex the exposed search uri are very simple if
you want to.
you could decide to restrict queries to only search templates which
would prevent client to do very costly queries
Hi all,
I'm aspiring to a nice & tidy REST API for my app. ES forms part of my app,
but unfortunately the complexity of search is dirtying my lovely API.
Across the rest of the system I've managed to included all data in the URI
which both has a functional beauty, but it also offers opportunities for
cache-ing, either at the server or the client.
In my ES searches, I'm able to encode the search in the URI, using
"_search?q=user:kimchy". But, to get the facets that relate to that search
I'll have to switch to storing the data in a JSON payload.
I imagine it's possible to use a similar encoding to list which facets
should be present in the results, particularly if the field-name is both
used to specify which field to select, plus what to call the results object
in the return payload.
I'd like to find out if there's any chance that facets could be included in
the URI construct. Is it technically possible?
I have begun working on something that would do exactly that and more.
This is the concept of search templates. Basically you can define a
template using the full query DSL with variables inside of it. When
you search you precise which template you want to use and the
variables in the templates are replaced using variables from the uri.
This approach has a lot of advantages:
less network transfer for each query which can be quite important if
you have a lot of complex queries
it is easier to cache results in cache layers like varnish and you
can even change your templates without invalidating the cache
you generally use only a few classes of queries in a common
application so it is very clear if you define a search template for
each class of query what queries you are actually using
you can abstract query complexity from search clients and expose
precisely the kind of queries and parameters you want. Even if the
templates are quite complex the exposed search uri are very simple if
you want to.
you could decide to restrict queries to only search templates which
would prevent client to do very costly queries
Hi all,
I'm aspiring to a nice & tidy REST API for my app. ES forms part of my app,
but unfortunately the complexity of search is dirtying my lovely API.
Across the rest of the system I've managed to included all data in the URI
which both has a functional beauty, but it also offers opportunities for
cache-ing, either at the server or the client.
In my ES searches, I'm able to encode the search in the URI, using
"_search?q=user:kimchy". But, to get the facets that relate to that search
I'll have to switch to storing the data in a JSON payload.
I imagine it's possible to use a similar encoding to list which facets
should be present in the results, particularly if the field-name is both
used to specify which field to select, plus what to call the results object
in the return payload.
I'd like to find out if there's any chance that facets could be included in
the URI construct. Is it technically possible?
Hi all,
I'm aspiring to a nice & tidy REST API for my app. ES forms part of my
app, but unfortunately the complexity of search is dirtying my lovely API.
Across the rest of the system I've managed to included all data in the URI
which both has a functional beauty, but it also offers opportunities for
cache-ing, either at the server or the client.
In my ES searches, I'm able to encode the search in the URI, using "
_search?q=user:kimchy". But, to get the facets that relate to that
search I'll have to switch to storing the data in a JSON payload.
I imagine it's possible to use a similar encoding to list which facets
should be present in the results, particularly if the field-name is both
used to specify which field to select, plus what to call the results object
in the return payload.
I'd like to find out if there's any chance that facets could be included
in the URI construct. Is it technically possible?
Apache, Apache Lucene, Apache Hadoop, Hadoop, HDFS and the yellow elephant
logo are trademarks of the
Apache Software Foundation
in the United States and/or other countries.
