yaql/README.rst
Kirill Zaitsev f134c743b0 Documentation structure update
Updated README to include some quickstart information and information on
what YAQL is.
Includes stubs for further expansion of YAQL documentation and proposes
general structure of how YAQL documentation might look like.

Targets blueprint: yaql-docs

Change-Id: I65885bd132bb3efa5798aa0cb6f1774b2348a44e
2015-08-26 14:53:54 +03:00

69 lines
1.3 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:
.. code-block:: console
pip install yaql>=1.0.0
..
Run yaql REPL:
.. code-block:: console
yaql
..
Load a json file:
.. code-block:: console
yaql> @load my_file.json
..
Check it loaded to current context, i.e. `$`:
.. code-block:: console
yaql> $
..
Run some queries:
.. code-block:: console
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