1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
:orphan:
.. _index_toplevel:
========================
SQLAlchemy Documentation
========================
.. container:: left_right_container
.. container:: leftmost
.. rst-class:: h2
Getting Started
.. container::
New to SQLAlchemy? Start here:
* **For Python Beginners:** :ref:`Installation Guide <installation>` - basic guidance on installing with pip and similar
* **For Python Veterans:** :doc:`SQLAlchemy Overview <intro>` - brief architectural overview
.. container:: left_right_container
.. container:: leftmost
.. rst-class:: h2
Tutorials
.. container::
**SQLAlchemy 1.4 / 2.0**
SQLAlchemy 2.0 is functionally available as part of SQLAlchemy 1.4, and integrates
Core and ORM working styles more closely than ever. The new tutorial introduces
both concepts in parallel.
* **For a quick glance:** :doc:`/orm/quickstart` - a glimpse at what working with the ORM looks like
* **For all users:** :doc:`/tutorial/index` - The new SQLAlchemy 1.4/2.0 Tutorial
.. container::
**Legacy SQLAlchemy 1.x Tutorials**
The 1.x Object Relational Tutorial and Core Tutorial are the legacy tutorials
that should be consulted for existing SQLAlchemy codebases.
* :doc:`orm/tutorial`
* :doc:`core/tutorial`
.. container:: left_right_container
.. container:: leftmost
.. rst-class:: h2
Migration Notes
.. container::
* :doc:`Migration from 1.3 <changelog/migration_14>` - Migration notes for SQLAlchemy Version 1.4
* :doc:`SQLAlchemy 2.0 Preview <changelog/migration_20>` - Background on preparing a SQLAlchemy 1.4 application for SQLAlchemy 2.0
* :doc:`Changelog catalog <changelog/index>` - Detailed changelogs for all SQLAlchemy Versions
.. container:: left_right_container
.. container:: leftmost
.. rst-class:: h2
Reference Documentation
.. container:: orm
**SQLAlchemy ORM**
* **ORM Configuration:**
:doc:`Mapped Class Configuration <orm/mapper_config>` |
:doc:`Relationship Configuration <orm/relationships>`
* **ORM Usage:**
:doc:`Session Usage and Guidelines <orm/session>` |
:doc:`Querying Data, Loading Objects <orm/loading_objects>` |
:doc:`AsyncIO Support <orm/extensions/asyncio>`
* **Configuration Extensions:**
:doc:`Mypy integration <orm/extensions/mypy>` |
:doc:`Association Proxy <orm/extensions/associationproxy>` |
:doc:`Hybrid Attributes <orm/extensions/hybrid>` |
:doc:`Automap <orm/extensions/automap>` |
:doc:`Mutable Scalars <orm/extensions/mutable>` |
:doc:`All extensions <orm/extensions/index>`
* **Extending the ORM:**
:doc:`ORM Events and Internals <orm/extending>`
* **Other:**
:doc:`Introduction to Examples <orm/examples>`
.. container:: core
**SQLAlchemy Core**
* **Engines, Connections, Pools:**
:doc:`Engine Configuration <core/engines>` |
:doc:`Connections, Transactions, Results <core/connections>` |
:doc:`AsyncIO Support <orm/extensions/asyncio>` |
:doc:`Connection Pooling <core/pooling>`
* **Schema Definition:**
:doc:`Overview <core/schema>` |
:ref:`Tables and Columns <metadata_describing_toplevel>` |
:ref:`Database Introspection (Reflection) <metadata_reflection_toplevel>` |
:ref:`Insert/Update Defaults <metadata_defaults_toplevel>` |
:ref:`Constraints and Indexes <metadata_constraints_toplevel>` |
:ref:`Using Data Definition Language (DDL) <metadata_ddl_toplevel>`
* **SQL Reference:**
:doc:`SQL Expression API docs <core/expression_api>`
* **Datatypes:**
:ref:`Overview <types_toplevel>` |
:ref:`Building Custom Types <types_custom>` |
:ref:`API <types_api>`
* **Core Basics:**
:doc:`Overview <core/api_basics>` |
:doc:`Runtime Inspection API <core/inspection>` |
:doc:`Event System <core/event>` |
:doc:`Core Event Interfaces <core/events>` |
:doc:`Creating Custom SQL Constructs <core/compiler>`
.. container:: left_right_container
.. container:: leftmost
.. rst-class:: h2
Dialect Documentation
.. container::
The **dialect** is the system SQLAlchemy uses to communicate with various types of DBAPIs and databases.
This section describes notes, options, and usage patterns regarding individual dialects.
:doc:`PostgreSQL <dialects/postgresql>` |
:doc:`MySQL <dialects/mysql>` |
:doc:`SQLite <dialects/sqlite>` |
:doc:`Oracle <dialects/oracle>` |
:doc:`Microsoft SQL Server <dialects/mssql>`
:doc:`More Dialects ... <dialects/index>`
.. container:: left_right_container
.. container:: leftmost
.. rst-class:: h2
Supplementary
.. container::
* :doc:`Frequently Asked Questions <faq/index>` - A collection of common problems and solutions
* :doc:`Glossary <glossary>` - Terms used in SQLAlchemy's documentation
* :doc:`Error Message Guide <errors>` - Explainations of many SQLAlchemy Errors
* :doc:`Complete table of of contents <contents>`
* :ref:`Index <genindex>`
|
