Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 65 lines (40 sloc) 1.344 kB
30b3ded @rduplain Split docs into multiple pages for sphinx.
rduplain authored
1 API
2 ---
3
087c3c0 @mitsuhiko Updated docs
authored
4 .. module:: flask.ext.sqlalchemy
30b3ded @rduplain Split docs into multiple pages for sphinx.
rduplain authored
5
6 This part of the documentation documents all the public classes and
7 functions in Flask-SQLAlchemy.
8
9 Configuration
10 `````````````
11
12 .. autoclass:: SQLAlchemy
13 :members:
14
15 .. attribute:: Query
16
17 The :class:`BaseQuery` class.
18
19 Models
20 ``````
21
22 .. autoclass:: Model
23 :members:
24
228baac @mitsuhiko Huge update to the documentation
authored
25 .. attribute:: __bind_key__
26
27 Optionally declares the bind to use. `None` refers to the default
28 bind. For more information see :ref:`binds`.
29
30b3ded @rduplain Split docs into multiple pages for sphinx.
rduplain authored
30 .. autoclass:: BaseQuery
31 :members: get, get_or_404, paginate, first_or_404
32
33 .. method:: all()
34
35 Return the results represented by this query as a list. This
36 results in an execution of the underlying query.
37
38 .. method:: order_by(*criterion)
39
40 apply one or more ORDER BY criterion to the query and return the
41 newly resulting query.
42
43 .. method:: limit(limit)
44
45 Apply a LIMIT to the query and return the newly resulting query.
46
47 .. method:: offset(offset)
48
49 Apply an OFFSET to the query and return the newly resulting
50 query.
51
52 .. method:: first()
53
54 Return the first result of this query or `None` if the result
55 doesn’t contain any rows. This results in an execution of the
56 underlying query.
57
58 Utilities
59 `````````
60
61 .. autoclass:: Pagination
62 :members:
63
64 .. autofunction:: get_debug_queries
Something went wrong with that request. Please try again.