.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/25-intermediate/01-queries.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_25-intermediate_01-queries.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_25-intermediate_01-queries.py:


.. _ref_queries_example:

Item queries
============

The Ansys Dynamic Reporting database can contain any number of items, from a few
to tens of thousands. To handle all this data, the :func:`queryansys.dynamicreporting.core.Service.query>`
method allows you to quickly slice the database to select a subset of items.

.. note::
   This example assumes that you have a local Ansys installation.

.. GENERATED FROM PYTHON SOURCE LINES 17-21

Start an Ansys Dynamic Reporting service
----------------------------------------
Start an Ansys Dynamic Reporting service with a new database. The path for the
database directory must be to an empty directory.

.. GENERATED FROM PYTHON SOURCE LINES 21-29

.. code-block:: Python


    import ansys.dynamicreporting.core as adr

    ansys_loc = r"C:\Program Files\ANSYS Inc\v232"
    db_dir = r"C:\tmp\new_database"
    adr_service = adr.Service(ansys_installation=ansys_loc, db_directory=db_dir)
    session_guid = adr_service.start(create_db=True)


.. GENERATED FROM PYTHON SOURCE LINES 30-37

Create items
------------

Now that an Ansys Dynamic Reporting service is running on top of a
new database, you can populate it. To keep this example simple, this code
creates multiple text items. It then sets some different names, sources, and
tags.

.. GENERATED FROM PYTHON SOURCE LINES 37-56

.. code-block:: Python


    for i in range(100):
        if i % 3 == 0:
            my_text = adr_service.create_item(obj_name=f"Name {str(i%20)}", source="Application X")
        elif i % 3 == 1:
            my_text = adr_service.create_item(obj_name=f"Name {str(i%20)}", source="Application Y")
        elif i % 3 == 2:
            my_text = adr_service.create_item(obj_name=f"Name {str(i%20)}", source="Application Z")
        my_text.item_text = "Any text. Does not matter the actual payload"
        if i % 4 == 0:
            my_text.set_tags("var=pressure")
        elif i % 4 == 1:
            my_text.set_tags("var=energy")
        elif i % 4 == 2:
            my_text.set_tags("var=temperature")
        elif i % 4 == 3:
            my_text.set_tags("var=vorticity")
        my_text.add_tag(tag="dp", value=str(i % 50))


.. GENERATED FROM PYTHON SOURCE LINES 57-68

Query the database
------------------

Now that the database is populated with a hundred items with different
names, sources, and tags, query the database, beginning with an empty
query that returns the entire set (all 100 items). Next, query on the
source name, which results in three different lists, with 34, 33, and 33 items
respectively. Finally, query on the name and the ``dp`` tag. See that the lists
have theexpected length. You can try different queries using the other attributes
that have been set on the items.


.. GENERATED FROM PYTHON SOURCE LINES 68-85

.. code-block:: Python


    all_items = adr_service.query()
    test_one = len(all_items) == 100
    app_x = adr_service.query(filter="A|i_src|cont|Application X")
    app_y = adr_service.query(filter="A|i_src|cont|Application Y")
    app_z = adr_service.query(filter="A|i_src|cont|Application Z")
    test_two = len(app_x) == 34
    test_three = len(app_y) == len(app_z) == 33
    name_0 = adr_service.query(filter="A|i_name|cont|Name 0")
    name_11 = adr_service.query(filter="A|i_name|cont|Name 11")
    name_7 = adr_service.query(filter="A|i_name|cont|Name 7")
    test_four = len(name_7) == len(name_0) == len(name_11) == 5
    dp0_items = adr_service.query(filter="A|i_tags|cont|dp=0")
    dp10_items = adr_service.query(filter="A|i_tags|cont|dp=10")
    dp33_items = adr_service.query(filter="A|i_tags|cont|dp=33")
    test_five = len(dp0_items) == len(dp10_items) == len(dp33_items) == 2


.. GENERATED FROM PYTHON SOURCE LINES 86-91

Close the service
-----------------

Close the Ansys Dynamic Reporting service. The database with the items that
were created remains on disk.

.. GENERATED FROM PYTHON SOURCE LINES 91-94

.. code-block:: Python


    # sphinx_gallery_thumbnail_path = '_static/default_thumb.png'
    adr_service.stop()


.. _sphx_glr_download_examples_25-intermediate_01-queries.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: 01-queries.ipynb <01-queries.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: 01-queries.py <01-queries.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: 01-queries.zip <01-queries.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_