Table of Contents

Full table of contents. For a high level overview of all documentation, see SQLAlchemy Documentation.

• Overview
  • Overview
  • Documentation Overview
  • Code Examples
  • Installation Guide
    • Installing with setuptools or pip
    • Installing using setup.py
    • Installing the C Extensions
    • Installing on Python 3
    • Installing a Database API
    • Checking the Installed SQLAlchemy Version
  • 0.5 to 0.6 Migration
• SQLAlchemy ORM
  • Object Relational Tutorial
    • Introduction
    • Version Check
    • Connecting
    • Define and Create a Table
    • Define a Python Class to be Mapped
    • Setting up the Mapping
    • Creating Table, Class and Mapper All at Once Declaratively
    • Creating a Session
    • Adding new Objects
    • Rolling Back
    • Querying
    • Building a Relationship
    • Working with Related Objects
    • Querying with Joins
    • Deleting
    • Building a Many To Many Relationship
    • Further Reference
  • Mapper Configuration
    • Customizing Column Properties
    • Deferred Column Loading
    • SQL Expressions as Mapped Attributes
    • Changing Attribute Behavior
    • Composite Column Types
    • Mapping a Class against Multiple Tables
    • Mapping a Class against Arbitrary Selects
    • Multiple Mappers for One Class
    • Multiple “Persistence” Mappers for One Class
    • Constructors and Object Initialization
    • The mapper() API
  • Relationship Configuration
    • Basic Relational Patterns
    • Adjacency List Relationships
    • Specifying Alternate Join Conditions to relationship()
    • Rows that point to themselves / Mutually Dependent Rows
    • Mutable Primary Keys / Update Cascades
    • The relationship() API
  • Collection Configuration and Techniques
    • Working with Large Collections
    • Customizing Collection Access
  • Mapping Class Inheritance Hierarchies
    • Joined Table Inheritance
    • Single Table Inheritance
    • Concrete Table Inheritance
    • Using Relationships with Inheritance
    • Using Inheritance with Declarative
  • Using the Session
    • What does the Session do ?
    • Getting a Session
    • Using the Session
    • Cascades
    • Managing Transactions
    • Embedding SQL Insert/Update Expressions into a Flush
    • Using SQL Expressions with Sessions
    • Joining a Session into an External Transaction
    • The Session object and sessionmaker() function
    • Contextual/Thread-local Sessions
    • Partitioning Strategies
    • Session Utilities
    • Attribute and State Management Utilities
  • Querying
    • The Query Object
    • ORM-Specific Query Constructs
  • Relationship Loading Techniques
    • Using Loader Strategies: Lazy Loading, Eager Loading
    • The Zen of Eager Loading
    • What Kind of Loading to Use ?
    • Routing Explicit Joins/Statements into Eagerly Loaded Collections
    • Relation Loader API
  • ORM Event Interfaces
    • Mapper Events
    • Session Events
    • Attribute Events
    • Instrumentation Events and Re-implementation
  • ORM Extensions
    • Association Proxy
    • Declarative
    • Ordering List
    • Horizontal Sharding
    • SqlSoup
  • Examples
    • Adjacency List
    • Associations
    • Attribute Instrumentation
    • Beaker Caching
    • Derived Attributes
    • Directed Graphs
    • Dynamic Relations as Dictionaries
    • Horizontal Sharding
    • Inheritance Mappings
    • Large Collections
    • Nested Sets
    • Polymorphic Associations
    • PostGIS Integration
    • Versioned Objects
    • Vertical Attribute Mapping
    • XML Persistence
  • ORM Exceptions
• SQLAlchemy Core
  • SQL Expression Language Tutorial
    • Introduction
    • Version Check
    • Connecting
    • Define and Create Tables
    • Insert Expressions
    • Executing
    • Executing Multiple Statements
    • Connectionless / Implicit Execution
    • Selecting
    • Operators
    • Conjunctions
    • Using Text
    • Using Aliases
    • Using Joins
    • Intro to Generative Selects and Transformations
    • Everything Else
    • Inserts and Updates
    • Deletes
    • Further Reference
  • SQL Statements and Expressions
    • Functions
    • Classes
    • Generic Functions
  • Engine Configuration
    • Supported Databases
    • Database Engine Options
    • Database Urls
    • Custom DBAPI connect() arguments
    • Configuring Logging
  • Working with Engines and Connections
    • Basic Usage
    • Using Transactions
    • Understanding Autocommit
    • Connectionless Execution, Implicit Execution
    • Using the Threadlocal Execution Strategy
  • Connection Pooling
    • Connection Pool Configuration
    • Switching Pool Implementations
    • Using a Custom Connection Function
    • Constructing a Pool
    • Pool Event Listeners
    • Builtin Pool Implementations
    • Pooling Plain DB-API Connections
  • Schema Definition Language
    • Describing Databases with MetaData
    • Reflecting Database Objects
    • Column Insert/Update Defaults
    • Defining Constraints and Indexes
    • Customizing DDL
  • Column and Data Types
    • Generic Types
    • SQL Standard Types
    • Vendor-Specific Types
    • Custom Types
    • Base Type API
  • Core Event Interfaces
    • Execution, Connection and Cursor Events
    • Connection Pool Events
  • Custom SQL Constructs and Compilation Extension
    • Synopsis
    • Dialect-specific compilation rules
    • Compiling sub-elements of a custom expression construct
    • Changing the default compilation of existing constructs
    • Changing Compilation of Types
    • Subclassing Guidelines
  • Expression Serializer Extension
  • Core Exceptions
• Dialects
  • Firebird
    • Dialects
    • Locking Behavior
    • RETURNING support
    • kinterbasdb
  • Informix
    • informixdb Notes
  • MaxDB
    • Overview
    • Connecting
    • Implementation Notes
  • Microsoft Access
  • Microsoft SQL Server
    • Connecting
    • Auto Increment Behavior
    • Collation Support
    • LIMIT/OFFSET Support
    • Nullability
    • Date / Time Handling
    • Compatibility Levels
    • Triggers
    • Enabling Snapshot Isolation
    • Known Issues
    • SQL Server Data Types
    • PyODBC
    • mxODBC
    • pymssql
    • zxjdbc Notes
    • AdoDBAPI
  • MySQL
    • Supported Versions and Features
    • Connecting
    • Connection Timeouts
    • Storage Engines
    • Keys
    • SQL Mode
    • MySQL SQL Extensions
    • Troubleshooting
    • MySQL Data Types
    • MySQL-Python Notes
    • OurSQL Notes
    • MySQL-Connector Notes
    • pyodbc Notes
    • zxjdbc Notes
  • Oracle
    • Connect Arguments
    • Auto Increment Behavior
    • Identifier Casing
    • Unicode
    • LIMIT/OFFSET Support
    • ON UPDATE CASCADE
    • Oracle 8 Compatibility
    • Synonym/DBLINK Reflection
    • Oracle Data Types
    • cx_Oracle Notes
    • zxjdbc Notes
  • PostgreSQL
    • Sequences/SERIAL
    • Transaction Isolation Level
    • INSERT/UPDATE...RETURNING
    • Indexes
    • PostgreSQL Data Types
    • psycopg2 Notes
    • py-postgresql Notes
    • pg8000 Notes
    • zxjdbc Notes
  • SQLite
    • Date and Time Types
    • Auto Incrementing Behavior
    • Transaction Isolation Level
    • SQLite Data Types
    • Pysqlite
  • Sybase
    • python-sybase notes
    • pyodbc notes
    • mxodbc notes

Indices and tables

• Index
• Search Page