ESQL query builder prototype #1462
Conversation
|
@miguelgrinberg thanks for the PR it looks interesting. The only comment that I've at the moment is to split each class in a separate file. The name of the file must be the same of the class. This is a best practices in PHP . |
|
@ezimuel I refactored into multiple files (one per class) and added a couple more commands now. Let me know if this structure seems reasonable and I'll add the remaining commands and all the docs. Two usage examples: use Elastic\Elasticsearch\Helper\Esql;
$query = Esql\Query::from("books", "books*")
->where('author == "King"', 'year == 1982')
->limit(10);
echo $query;
$query = Esql\Query::row(a: 123, b: "test")
->limit(1);
echo $query; |
miguelgrinberg
force-pushed
the
esql-query-builder
branch
from
f1feaca to
82ae0fe
Compare
miguelgrinberg
force-pushed
the
esql-query-builder
branch
2 times, most recently
from
b54a783 to
c602ff7
Compare
miguelgrinberg
force-pushed
the
esql-query-builder
branch
from
c602ff7 to
85f63cc
Compare
|
@ezimuel This is ready to review! Maybe what makes the most sense is for you to read the unit test file first, so that you see how all the commands are constructed. |
miguelgrinberg
force-pushed
the
esql-query-builder
branch
from
c586cb8 to
bee8abb
Compare
miguelgrinberg
force-pushed
the
esql-query-builder
branch
from
e3c1282 to
491b3b2
Compare
There was a problem hiding this comment.
Thanks @miguelgrinberg for this awesome PR! I just left a couple of comments, the most relevant that I would suggest to investigate is the possibility to use Traits instead of passing the parent in EsqlBase.
Moreover, we should add also some documentation about this helper with an example on how to call it using the Esql endpoint.
| /** | ||
| * Helper function that checks if a forking command has been issued already. | ||
| */ | ||
| protected function isForked(): bool |
There was a problem hiding this comment.
Maybe we can avoid using this function and avoid to pass the parent reference for each class using a Trait here. I used this mechanism for code reuse in the AbstractEndpoint to share common code on each Endpoint implementation.
This PR contains a prototype of an ES|QL query builder feature for the PHP client based on the one I built for the Python client.
Example usage:
Output:
In IDEs, you get correct suggestions based on context. For example: