5
========================
6
SQLAlchemy Documentation
7
========================
12
A high level view and getting set up.
14
:ref:`Overview <overview>` |
15
:ref:`Installation Guide <installation>` |
16
:doc:`Frequently Asked Questions <faq>` |
17
:doc:`Migration from 0.8 <changelog/migration_09>` |
18
:doc:`Glossary <glossary>` |
19
:doc:`Changelog catalog <changelog/index>`
24
Here, the Object Relational Mapper is introduced and
25
fully described. If you want to work with higher-level SQL which is
26
constructed automatically for you, as well as automated persistence
27
of Python objects, proceed first to the tutorial.
29
* **Read this first:**
32
* **ORM Configuration:**
33
:doc:`Mapper Configuration <orm/mapper_config>` |
34
:doc:`Relationship Configuration <orm/relationships>` |
35
:doc:`Inheritance Mapping <orm/inheritance>` |
36
:doc:`Advanced Collection Configuration <orm/collections>`
38
* **Configuration Extensions:**
39
:doc:`Declarative Extension <orm/extensions/declarative>` |
40
:doc:`Association Proxy <orm/extensions/associationproxy>` |
41
:doc:`Hybrid Attributes <orm/extensions/hybrid>` |
42
:doc:`Automap <orm/extensions/automap>` (**new**) |
43
:doc:`Mutable Scalars <orm/extensions/mutable>` |
44
:doc:`Ordered List <orm/extensions/orderinglist>`
47
:doc:`Session Usage and Guidelines <orm/session>` |
48
:doc:`Query API reference <orm/query>` |
49
:doc:`Relationship Loading Techniques <orm/loading>`
51
* **Extending the ORM:**
52
:doc:`ORM Event Interfaces <orm/events>` |
53
:doc:`Internals API <orm/internals>`
56
:doc:`Introduction to Examples <orm/examples>` |
57
:doc:`Deprecated Event Interfaces <orm/deprecated>` |
58
:doc:`ORM Exceptions <orm/exceptions>` |
59
:doc:`Horizontal Sharding <orm/extensions/horizontal_shard>` |
60
:doc:`Alternate Instrumentation <orm/extensions/instrumentation>`
65
The breadth of SQLAlchemy's SQL rendering engine, DBAPI
66
integration, transaction integration, and schema description services
67
are documented here. In contrast to the ORM's domain-centric mode of usage, the SQL Expression Language provides a schema-centric usage paradigm.
69
* **Read this first:**
72
* **All the Built In SQL:**
73
:doc:`SQL Expression API <core/expression_api>`
75
* **Engines, Connections, Pools:**
76
:doc:`Engine Configuration <core/engines>` |
77
:doc:`Connections, Transactions <core/connections>` |
78
:doc:`Connection Pooling <core/pooling>`
80
* **Schema Definition:**
81
:ref:`Tables and Columns <metadata_describing_toplevel>` |
82
:ref:`Database Introspection (Reflection) <metadata_reflection_toplevel>` |
83
:ref:`Insert/Update Defaults <metadata_defaults_toplevel>` |
84
:ref:`Constraints and Indexes <metadata_constraints_toplevel>` |
85
:ref:`Using Data Definition Language (DDL) <metadata_ddl_toplevel>`
88
:ref:`Overview <types_toplevel>` |
89
:ref:`Generic Types <types_generic>` |
90
:ref:`SQL Standard Types <types_sqlstandard>` |
91
:ref:`Vendor Specific Types <types_vendor>` |
92
:ref:`Building Custom Types <types_custom>` |
93
:ref:`Defining New Operators <types_operators>` |
94
:ref:`API <types_api>`
96
* **Extending the Core:**
97
:doc:`SQLAlchemy Events <core/event>` |
98
:doc:`Core Event Interfaces <core/events>` |
99
:doc:`Creating Custom SQL Constructs <core/compiler>` |
100
:doc:`Internals API <core/internals>`
103
:doc:`Runtime Inspection API <core/inspection>` |
104
:doc:`core/interfaces` |
105
:doc:`core/exceptions`
108
Dialect Documentation
109
======================
111
The **dialect** is the system SQLAlchemy uses to communicate with various types of DBAPIs and databases.
112
This section describes notes, options, and usage patterns regarding individual dialects.
114
:doc:`Index of all Dialects <dialects/index>`
added
removed
doc/_sources/index.txt
