doc/book/pyramid/index.rst
author Laurent Wouters <lwouters@cenotelie.fr>
Fri, 20 Mar 2020 14:34:07 +0100
changeset 12931 6eae252361e5
parent 12819 053329493511
permissions -rw-r--r--
[rql] Store selected variables for RQL select queries in ResultSet (#17218476) By storing the name of the selected variables for RQL select queries in the ResultSet (within the "variables" attribute), the information can be passed down to specific protocols, e.g. rqlio that may wish to pass is down further to clients. In turn, clients can then choose to present the results of RQL select queries as symbolic bindings using the names used in the query's projection, instead of ordinal arrays.

Pyramid
=======

:mod:`cubicweb.pyramid` provides a way to bind a CubicWeb data repository to a
Pyramid WSGI web application.

It can be used in two different ways:

-   Through the :ref:`pyramid command <cubicweb-ctl_pyramid>` or through
    :func:`cubicweb.pyramid.wsgi_application` WSGI application factory, one can
    run an ``all-in-one`` CubicWeb instance with the web part served by a
    Pyramid application. This is referred to as the *backwards compatible
    mode*.

-   Through the ``pyramid`` configuration type, one can setup a CubicWeb
    instance which repository can be used from within a Pyramid application.
    Such an instance may be launched through ``pserve`` or any WSGI server as
    would any plain Pyramid application.


Narrative Documentation
=======================

.. toctree::
    :maxdepth: 2

    quickstart
    ctl
    settings
    auth
    profiling
    debug_toolbar

Api Documentation
=================

.. toctree::
    :maxdepth: 2
    :glob:

    ../../api/pyramid