:orphan:

Example Gallery
===============

This gallery provides hands-on examples for ``pandera-catalog``.


.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to create a PanderaCatalog, register Pandera schemas with optional metadata, and then look them up.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_01_basic_catalog_usage_thumb.png
    :alt:

  :doc:`/auto_examples/01_basic_catalog_usage`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Basic Catalog Usage</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to serialise a Pandera schema to YAML, then reload it via load_schema_from_yaml and register it in a PanderaCatalog.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_02_load_schema_from_yaml_thumb.png
    :alt:

  :doc:`/auto_examples/02_load_schema_from_yaml`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Loading a Schema from YAML</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to register a Schema Projection from ordered steps, then export that projection as a Pandera DataFrameSchema.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_03_schema_projection_thumb.png
    :alt:

  :doc:`/auto_examples/03_schema_projection`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Schema Projection (Explicit Columns)</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to query the generated SQL views through CatalogViewReader and work with the returned pandas DataFrame objects.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_04_backend_view_reader_thumb.png
    :alt:

  :doc:`/auto_examples/04_backend_view_reader`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Catalog View Reader</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/01_basic_catalog_usage
   /auto_examples/02_load_schema_from_yaml
   /auto_examples/03_schema_projection
   /auto_examples/04_backend_view_reader


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

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

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

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

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