API
---

.. module:: flask.ext.sqlalchemy

这部分文档记录了 Flask-SQLAlchemy 里的所有公开的类和函数。

配置
`````````````

.. autoclass:: SQLAlchemy
   :members:

   .. attribute:: Query

      The :class:`BaseQuery` class.

模型
``````

.. autoclass:: Model
   :members:

   .. attribute:: __bind_key__

      Optionally declares the bind to use.  `None` refers to the default
      bind.  For more information see :ref:`binds`.

   .. attribute:: __tablename__

      The name of the table in the database.  This is required by SQLAlchemy;
      however, Flask-SQLAlchemy will set it automatically if a model has a
      primary key defined.  If the ``__table__`` or ``__tablename__`` is set
      explicitly, that will be used instead.

.. autoclass:: BaseQuery
   :members: get, get_or_404, paginate, first_or_404

   .. method:: all()

      Return the results represented by this query as a list.  This
      results in an execution of the underlying query.

   .. method:: order_by(*criterion)

      apply one or more ORDER BY criterion to the query and return the
      newly resulting query.

   .. method:: limit(limit)

      Apply a LIMIT  to the query and return the newly resulting query.

   .. method:: offset(offset)

      Apply an OFFSET  to the query and return the newly resulting
      query.

   .. method:: first()

      Return the first result of this query or `None` if the result
      doesn’t contain any rows.  This results in an execution of the
      underlying query.
    
会话
````````

.. autoclass:: SignallingSession
   :members:

实用工具
`````````

.. autoclass:: Pagination
   :members:

.. autofunction:: get_debug_queries