SQLAlchemy 0.3 Documentation
Version: 0.3.5 Last Updated: 03/18/07 18:39:07
Table of Contents
(view full table)- Tutorial
- Database Engines
- Database Meta Data
- Constructing SQL Queries via Python Expressions
- Data Mapping
- Session / Unit of Work
- Advanced Data Mapping
- The Types System
- Connection Pooling
- Plugins
- Generated Documentation
Table of Contents: Full
(view brief table)- Tutorial
- Installation
- Getting Started
- SQLAlchemy is Two Libraries in One
- Working with Database Objects
- Defining Metadata, Binding to Engines
- Creating a Table
- Inserting Rows
- Selecting
- Working with Rows
- Table Relationships
- Working with Object Mappers
- Creating a Mapper
- Obtaining a Session
- The Query Object
- Making Changes
- Saving
- Relationships
- Transactions
- Next Steps
- Database Engines
- Supported Databases
- Establishing a Database Engine
- Database Engine Options
- Configuring Logging
- Using Connections
- Transactions
- Implicit Execution
- Database Meta Data
- Describing Databases with MetaData
- Binding MetaData to an Engine
- Using the global Metadata object
- Reflecting Tables
- Specifying the Schema Name
- ON UPDATE and ON DELETE
- Enabling Table / Column Quoting
- Other Options
- Creating and Dropping Database Tables
- Column Defaults and OnUpdates
- Pre-Executed Insert Defaults
- Pre-Executed OnUpdate Defaults
- Inline Default Execution: PassiveDefault
- Defining Sequences
- Defining Constraints and Indexes
- Adapting Tables to Alternate Metadata
- Constructing SQL Queries via Python Expressions
- Simple Select
- Explicit Execution
- Binding ClauseElements to Engines
- Getting Results
- Using Column Labels
- Table/Column Specification
- WHERE Clause
- Inner and Outer Joins
- Table Aliases
- Subqueries
- Correlated Subqueries
- Unions
- Custom Bind Parameters
- Literal Text Blocks
- Building Select Objects
- Inserts
- Updates
- Deletes
- Data Mapping
- Basic Data Mapping
- Synopsis
- The Query Object
- Saving Objects
- Defining and Using Relationships
- Selecting from Relationships
- Selecting With Joins
- Creating Joins Using select_by()
- Generating Join Criterion Using join_to, join_via
- Eager Loading
- Using Options to Change the Loading Strategy
- One to One/Many to One
- Many to Many
- Association Object
- Session / Unit of Work
- Overview
- Object States
- Acquiring a Session
- Introduction to the Identity Map
- Whats Changed ?
- The Session API
- query()
- get()
- load()
- save()
- flush()
- close()
- delete()
- clear()
- refresh() / expire()
- expunge()
- bind_mapper() / bind_table()
- update()
- save_or_update()
- merge()
- Cascade rules
- SessionTransaction
- Analyzing Object Flushes
- Advanced Data Mapping
- More On Mapper Properties
- Overriding Column Names
- Overriding Properties
- Custom List Classes
- Custom Join Conditions
- Lazy/Eager Joins Multiple Times to One Table
- Deferred Column Loading
- Working with Large Collections
- Relation Options
- Controlling Ordering
- Limiting Rows
- Mapping a Class with Table Inheritance
- Mapping a Class against Multiple Tables
- Mapping a Class against Arbitrary Selects
- Multiple Mappers for One Class
- Self Referential Mappers
- Result-Set Mapping
- Mapper Options
- Extending Mapper
- The Types System
- Connection Pooling
- Plugins
- SessionContext
- SelectResults
- assignmapper
- associationproxy
- threadlocal
- ActiveMapper
- SqlSoup
- ProxyEngine
- Generated Documentation
- module sqlalchemy.sql
- Module Functions
- alias()
- and_()
- asc()
- between()
- bindparam()
- case()
- cast()
- column()
- delete()
- desc()
- except_()
- except_all()
- exists()
- extract()
- insert()
- intersect()
- intersect_all()
- join()
- literal()
- literal_column()
- not_()
- null()
- or_()
- outerjoin()
- select()
- subquery()
- table()
- text()
- union()
- union_all()
- update()
- class AbstractDialect(object)
- class Alias(FromClause)
- class ClauseElement(object)
- class ClauseParameters(dict)
- class ClauseVisitor(object)
- class ColumnCollection(OrderedProperties)
- class ColumnElement(Selectable,_CompareMixin)
- class Compiled(ClauseVisitor)
- class CompoundSelect(_SelectBaseMixin,FromClause)
- class Executor(object)
- class FromClause(Selectable)
- class Join(FromClause)
- class Select(_SelectBaseMixin,FromClause)
- class Selectable(ClauseElement)
- class TableClause(FromClause)
- module sqlalchemy.schema
- class BoundMetaData(MetaData)
- class CheckConstraint(Constraint)
- class Column(SchemaItem,_ColumnClause)
- class ColumnDefault(DefaultGenerator)
- class Constraint(SchemaItem)
- class DefaultGenerator(SchemaItem)
- class DynamicMetaData(MetaData)
- class ForeignKey(SchemaItem)
- class ForeignKeyConstraint(Constraint)
- class Index(SchemaItem)
- class MetaData(SchemaItem)
- class PassiveDefault(DefaultGenerator)
- class PrimaryKeyConstraint(Constraint)
- class SchemaItem(object)
- class SchemaVisitor(ClauseVisitor)
- class Sequence(DefaultGenerator)
- class Table(SchemaItem,TableClause)
- class UniqueConstraint(Constraint)
- module sqlalchemy.types
- class BLOB(Binary)
- class BOOLEAN(Boolean)
- class Binary(TypeEngine)
- class Boolean(TypeEngine)
- class CHAR(String)
- class CLOB(String)
- class DATE(Date)
- class DATETIME(DateTime)
- class DECIMAL(Numeric)
- class Date(TypeEngine)
- class DateTime(TypeEngine)
- class FLOAT(Float)
- class Float(Numeric)
- class INT(Integer)
- class Integer(TypeEngine)
- class NCHAR(Unicode)
- class NullTypeEngine(TypeEngine)
- class Numeric(TypeEngine)
- class PickleType(MutableType,TypeDecorator)
- class SMALLINT(SmallInteger)
- class SmallInteger(Integer)
- class SmallInteger(Integer)
- class String(TypeEngine)
- class TEXT(String)
- class TIME(Time)
- class TIMESTAMP(DateTime)
- class Time(TypeEngine)
- class TypeDecorator(AbstractType)
- class TypeEngine(AbstractType)
- class Unicode(TypeDecorator)
- class VARCHAR(String)
- module sqlalchemy.engine
- Module Functions
- class Connectable(object)
- class Connection(Connectable)
- class ConnectionProvider(object)
- class DefaultRunner(SchemaVisitor)
- class Dialect(AbstractDialect)
- class Engine(Executor,Connectable)
- class ExecutionContext(object)
- class PrefetchingResultProxy(ResultProxy)
- class ResultProxy(object)
- class RowProxy(object)
- class SchemaIterator(SchemaVisitor)
- class Transaction(object)
- module sqlalchemy.engine.url
- module sqlalchemy.orm
- Module Functions
- backref()
- cascade_mappers()
- class_mapper()
- clear_mapper()
- clear_mappers()
- compile_mappers()
- contains_alias()
- contains_eager()
- defer()
- deferred()
- eagerload()
- extension()
- lazyload()
- mapper()
- noload()
- object_mapper()
- object_session()
- polymorphic_union()
- relation()
- synonym()
- undefer()
- class MapperExtension(object)
- class Query(object)
- class Session(object)
- module sqlalchemy.orm.mapper
- module sqlalchemy.orm.query
- module sqlalchemy.orm.session
- module sqlalchemy.pool
- Module Functions
- class AssertionPool(Pool)
- class NullPool(Pool)
- class Pool(object)
- class QueuePool(Pool)
- class SingletonThreadPool(Pool)
- module sqlalchemy.ext.sessioncontext
- module sqlalchemy.mods.threadlocal
- module sqlalchemy.ext.selectresults
- module sqlalchemy.exceptions
- class ArgumentError()
- class AssertionError()
- class CircularDependencyError()
- class CompileError()
- class ConcurrentModificationError()
- class DBAPIError()
- class FlushError()
- class InvalidRequestError()
- class NoSuchColumnError()
- class NoSuchTableError()
- class SQLAlchemyError()
- class SQLError()
- class TimeoutError()
- module sqlalchemy.ext.proxy
- class AutoConnectEngine(BaseProxyEngine)
- class BaseProxyEngine(Executor)
- class ProxyEngine(BaseProxyEngine)
- module sqlalchemy.databases.sqlite
- Module Functions
- class DateTimeMixin(object)
- class PassiveDefault(DefaultGenerator)
- class SLBinary(Binary)
- class SLBoolean(Boolean)
- class SLChar(CHAR)
- class SLDate(DateTimeMixin,Date)
- class SLDateTime(DateTimeMixin,DateTime)
- class SLInteger(Integer)
- class SLNumeric(Numeric)
- class SLSmallInteger(SmallInteger)
- class SLString(String)
- class SLText(TEXT)
- class SLTime(DateTimeMixin,Time)
- class SQLiteCompiler(ANSICompiler)
- class SQLiteDialect(ANSIDialect)
- class SQLiteDialect(ANSIDialect)
- class SQLiteExecutionContext(DefaultExecutionContext)
- class SQLiteIdentifierPreparer(ANSIIdentifierPreparer)
- class SQLiteSchemaDropper(ANSISchemaDropper)
- class SQLiteSchemaGenerator(ANSISchemaGenerator)
- class SingletonThreadPool(Pool)
- module sqlalchemy.databases.postgres
- Module Functions
- class PG1Date(Date)
- class PG1DateTime(DateTime)
- class PG1Time(Time)
- class PG2Date(Date)
- class PG2DateTime(DateTime)
- class PG2Time(Time)
- class PGBigInteger(PGInteger)
- class PGBinary(Binary)
- class PGBoolean(Boolean)
- class PGChar(CHAR)
- class PGCompiler(ANSICompiler)
- class PGDefaultRunner(ANSIDefaultRunner)
- class PGDialect(ANSIDialect)
- class PGDialect(ANSIDialect)
- class PGExecutionContext(DefaultExecutionContext)
- class PGFloat(Float)
- class PGIdentifierPreparer(ANSIIdentifierPreparer)
- class PGInet(TypeEngine)
- class PGInteger(Integer)
- class PGInterval(TypeEngine)
- class PGNumeric(Numeric)
- class PGSchemaDropper(ANSISchemaDropper)
- class PGSchemaGenerator(ANSISchemaGenerator)
- class PGSmallInteger(SmallInteger)
- class PGString(String)
- class PGText(TEXT)
- module sqlalchemy.databases.mysql
- Module Functions
- class MSBigInteger(MSInteger)
- class MSBinary(Binary)
- class MSBoolean(Boolean)
- class MSChar(CHAR)
- class MSDate(Date)
- class MSDateTime(DateTime)
- class MSDecimal(MSNumeric)
- class MSDouble(MSNumeric)
- class MSEnum(MSString)
- class MSFloat(Float)
- class MSInteger(Integer)
- class MSLongText(MSText)
- class MSMediumBlob(MSBinary)
- class MSMediumText(MSText)
- class MSNumeric(Numeric)
- class MSSmallInteger(SmallInteger)
- class MSString(String)
- class MSText(TEXT)
- class MSTime(Time)
- class MSTinyText(MSText)
- class MySQLCompiler(ANSICompiler)
- class MySQLDialect(ANSIDialect)
- class MySQLDialect(ANSIDialect)
- class MySQLExecutionContext(DefaultExecutionContext)
- class MySQLIdentifierPreparer(ANSIIdentifierPreparer)
- class MySQLSchemaDropper(ANSISchemaDropper)
- class MySQLSchemaGenerator(ANSISchemaGenerator)
- class array(object)
- module sqlalchemy.databases.oracle
- Module Functions
- class OracleBinary(Binary)
- class OracleBoolean(Boolean)
- class OracleChar(CHAR)
- class OracleCompiler(ANSICompiler)
- class OracleDateTime(DateTime)
- class OracleDefaultRunner(ANSIDefaultRunner)
- class OracleDialect(ANSIDialect)
- class OracleDialect(ANSIDialect)
- class OracleExecutionContext(DefaultExecutionContext)
- class OracleInteger(Integer)
- class OracleNumeric(Numeric)
- class OracleRaw(Binary)
- class OracleSchemaDropper(ANSISchemaDropper)
- class OracleSchemaGenerator(ANSISchemaGenerator)
- class OracleSmallInteger(SmallInteger)
- class OracleString(String)
- class OracleText(TEXT)
- class OracleTimestamp(DateTime)
- module sqlalchemy.databases.mssql
- Module Functions
- class AdoMSNVarchar(MSNVarchar)
- class AdoMSUnicode(MSUnicode)
- class MSBinary(Binary)
- class MSBoolean(Boolean)
- class MSChar(CHAR)
- class MSDate(Date)
- class MSDateTime(DateTime)
- class MSFloat(Float)
- class MSInteger(Integer)
- class MSNChar(NCHAR)
- class MSNVarchar(MSString)
- class MSNumeric(Numeric)
- class MSSQLCompiler(ANSICompiler)
- class MSSQLDefaultRunner(ANSIDefaultRunner)
- class MSSQLDialect(ANSIDialect)
- class MSSQLDialect(ANSIDialect)
- class MSSQLDialect_adodbapi(MSSQLDialect)
- class MSSQLDialect_pymssql(MSSQLDialect)
- class MSSQLDialect_pyodbc(MSSQLDialect)
- class MSSQLExecutionContext(DefaultExecutionContext)
- class MSSQLIdentifierPreparer(ANSIIdentifierPreparer)
- class MSSQLSchemaDropper(ANSISchemaDropper)
- class MSSQLSchemaGenerator(ANSISchemaGenerator)
- class MSSmallInteger(SmallInteger)
- class MSString(String)
- class MSText(TEXT)
- class MSTinyInteger(Integer)
- class MSUnicode(Unicode)
- module sqlalchemy.databases.firebird
- Module Functions
- class FBBinary(Binary)
- class FBBoolean(Boolean)
- class FBChar(CHAR)
- class FBCompiler(ANSICompiler)
- class FBDate(DateTime)
- class FBDateTime(DateTime)
- class FBDefaultRunner(ANSIDefaultRunner)
- class FBDialect(ANSIDialect)
- class FBDialect(ANSIDialect)
- class FBExecutionContext(DefaultExecutionContext)
- class FBIdentifierPreparer(ANSIIdentifierPreparer)
- class FBInteger(Integer)
- class FBNumeric(Numeric)
- class FBSchemaDropper(ANSISchemaDropper)
- class FBSchemaGenerator(ANSISchemaGenerator)
- class FBSmallInteger(SmallInteger)
- class FBString(String)
- class FBText(TEXT)