.. _overview_toplevel: ======================= Overview / Installation ======================= Overview ======== The SQLAlchemy SQL Toolkit and Object Relational Mapper is a comprehensive set of tools for working with databases and Python. It has several distinct areas of functionality which can be used individually or combined together. Its major API components, all public-facing, are illustrated below:: +-----------------------------------------------------------+ | Object Relational Mapper (ORM) | +-----------------------------------------------------------+ +---------+ +------------------------------------+ +--------+ | | | SQL Expression Language | | | | | +------------------------------------+ | | | +-----------------------+ +--------------+ | | Dialect/Execution | | Schema Management | +---------------------------------+ +-----------------------+ +----------------------+ +----------------------------------+ | Connection Pooling | | Types | +----------------------+ +----------------------------------+ Above, the two most significant front-facing portions of SQLAlchemy are the **Object Relational Mapper** and the **SQL Expression Language**. These are two separate toolkits, one building off the other. SQL Expressions can be used independently of the ORM. When using the ORM, the SQL Expression language is used to establish object-relational configurations as well as in querying. Tutorials ========= * :ref:`ormtutorial_toplevel` - This describes the richest feature of SQLAlchemy, its object relational mapper. If you want to work with higher-level SQL which is constructed automatically for you, as well as management of Python objects, proceed to this tutorial. * :ref:`sqlexpression_toplevel` - The core of SQLAlchemy is its SQL expression language. The SQL Expression Language is a toolkit all its own, independent of the ORM package, which can be used to construct manipulable SQL expressions which can be programmatically constructed, modified, and executed, returning cursor-like result sets. It's a lot more lightweight than the ORM and is appropriate for higher scaling SQL operations. It's also heavily present within the ORM's public facing API, so advanced ORM users will want to master this language as well. Main Documentation ================== * :ref:`datamapping_toplevel` - A comprehensive walkthrough of major ORM patterns and techniques. * :ref:`session_toplevel` - A detailed description of SQLAlchemy's Session object * :ref:`engines_toplevel` - Describes SQLAlchemy's database-connection facilities, including connection documentation and working with connections and transactions. * :ref:`metadata_toplevel` - All about schema management using ``MetaData`` and ``Table`` objects; reading database schemas into your application, creating and dropping tables, constraints, defaults, sequences, indexes. * :ref:`pooling_toplevel` - Further detail about SQLAlchemy's connection pool library. * :ref:`types` - Datatypes included with SQLAlchemy, their functions, as well as how to create your own types. * :ref:`plugins` - Included addons for SQLAlchemy API Reference ============= An organized section of all SQLAlchemy APIs is at :ref:`api_reference_toplevel`. Installing SQLAlchemy ====================== Installing SQLAlchemy from scratch is most easily achieved with `setuptools `_. Assuming it's installed, just run this from the command-line: .. sourcecode:: none # easy_install SQLAlchemy This command will download the latest version of SQLAlchemy from the `Python Cheese Shop `_ and install it to your system. * `setuptools `_ * `install setuptools `_ * `pypi `_ Otherwise, you can install from the distribution using the ``setup.py`` script: .. sourcecode:: none # python setup.py install Installing a Database API ========================== SQLAlchemy is designed to operate with a `DB-API `_ implementation built for a particular database, and includes support for the most popular databases. The current list is at :ref:`supported_dbapis`. Checking the Installed SQLAlchemy Version ========================================= This documentation covers SQLAlchemy version 0.5. If you're working on a system that already has SQLAlchemy installed, check the version from your Python prompt like this: .. sourcecode:: python+sql >>> import sqlalchemy >>> sqlalchemy.__version__ # doctest: +SKIP 0.5.0 0.4 to 0.5 Migration ===================== Notes on what's changed from 0.4 to 0.5 is available on the SQLAlchemy wiki at `05Migration `_.