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
|
.. _index_toplevel:
========================
SQLAlchemy Documentation
========================
Getting Started
===============
A high level view and getting set up.
:ref:`Overview <overview>` |
:ref:`Installation Guide <installation>` |
:doc:`Frequently Asked Questions <faq>` |
:doc:`Migration from 0.7 <changelog/migration_08>` |
:doc:`Glossary <glossary>` |
:doc:`Changelog catalog <changelog/index>`
SQLAlchemy ORM
==============
Here, the Object Relational Mapper is introduced and
fully described. If you want to work with higher-level SQL which is
constructed automatically for you, as well as automated persistence
of Python objects, proceed first to the tutorial.
* **Read this first:**
:doc:`orm/tutorial`
* **ORM Configuration:**
:doc:`Mapper Configuration <orm/mapper_config>` |
:doc:`Relationship Configuration <orm/relationships>` |
:doc:`Inheritance Mapping <orm/inheritance>` |
:doc:`Advanced Collection Configuration <orm/collections>`
* **Configuration Extensions:**
:doc:`Declarative Extension <orm/extensions/declarative>` |
:doc:`Association Proxy <orm/extensions/associationproxy>` |
:doc:`Hybrid Attributes <orm/extensions/hybrid>` |
:doc:`Mutable Scalars <orm/extensions/mutable>` |
:doc:`Ordered List <orm/extensions/orderinglist>`
* **ORM Usage:**
:doc:`Session Usage and Guidelines <orm/session>` |
:doc:`Query API reference <orm/query>` |
:doc:`Relationship Loading Techniques <orm/loading>`
* **Extending the ORM:**
:doc:`ORM Event Interfaces <orm/events>` |
:doc:`Internals API <orm/internals>`
* **Other:**
:doc:`Introduction to Examples <orm/examples>` |
:doc:`Deprecated Event Interfaces <orm/deprecated>` |
:doc:`ORM Exceptions <orm/exceptions>` |
:doc:`Horizontal Sharding <orm/extensions/horizontal_shard>` |
:doc:`Alternate Instrumentation <orm/extensions/instrumentation>`
SQLAlchemy Core
===============
The breadth of SQLAlchemy's SQL rendering engine, DBAPI
integration, transaction integration, and schema description services
are documented here. In contrast to the ORM's domain-centric mode of usage, the SQL Expression Language provides a schema-centric usage paradigm.
* **Read this first:**
:doc:`core/tutorial`
* **All the Built In SQL:**
:doc:`SQL Expression API <core/expression_api>`
* **Engines, Connections, Pools:**
:doc:`Engine Configuration <core/engines>` |
:doc:`Connections, Transactions <core/connections>` |
:doc:`Connection Pooling <core/pooling>`
* **Schema Definition:**
: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>`
* **Datatypes:**
:ref:`Overview <types_toplevel>` |
:ref:`Generic Types <types_generic>` |
:ref:`SQL Standard Types <types_sqlstandard>` |
:ref:`Vendor Specific Types <types_vendor>` |
:ref:`Building Custom Types <types_custom>` |
:ref:`Defining New Operators <types_operators>` |
:ref:`API <types_api>`
* **Extending the Core:**
:doc:`SQLAlchemy Events <core/event>` |
:doc:`Core Event Interfaces <core/events>` |
:doc:`Creating Custom SQL Constructs <core/compiler>` |
:doc:`Internals API <core/internals>`
* **Other:**
:doc:`Runtime Inspection API <core/inspection>` |
:doc:`core/interfaces` |
:doc:`core/exceptions`
Dialect Documentation
======================
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:`Index of all Dialects <dialects/index>`
|