yaql/README.rst
zhurong 60408a506e Fix readme Pygments package not found
Change-Id: Ibb9dd3a73d8067c5cf50b51c598994b2d51d2682
2018-10-10 11:02:15 +08:00

53 lines
1.1 KiB
ReStructuredText

YAQL: Yet Another Query Language
================================
YAQL (Yet Another Query Language) is an embeddable and extensible query
language, that allows performing complex queries against arbitrary objects. It
has a vast and comprehensive standard library of frequently used querying
functions and can be extend even further with user-specified functions. YAQL is
written in python and is distributed via PyPI.
Quickstart
----------
Install the latest version of yaql:
pip install yaql>=1.0.0
Run yaql REPL:
yaql
Load a json file:
yaql> @load my_file.json
Check it loaded to current context, i.e. `$`:
yaql> $
Run some queries:
yaql> $.customers
...
yaql> $.customers.orders
...
yaql> $.customers.where($.age > 18)
...
yaql> $.customers.groupBy($.sex)
...
yaql> $.customers.where($.orders.len() >= 1 or name = "John")
Project Resources
-----------------
* `Official Documentation <http://yaql.readthedocs.org>`_
* Project status, bugs, and blueprints are tracked on
`Launchpad <https://launchpad.net/yaql>`_
License
-------
Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0