Flask-SQLAlchemy
****************

Flask-SQLAlchemy is an extension for Flask that adds support for
SQLAlchemy to your application.  It requires SQLAlchemy 0.8 or higher.
It aims to simplify using SQLAlchemy with Flask by providing useful
defaults and extra helpers that make it easier to accomplish common
tasks.

See the SQLAlchemy documentation to learn how to work with the ORM in
depth.  The following documentation is a brief overview of the most
common tasks, as well as the features specific to Flask-SQLAlchemy.


User's Guide
============

This part of the documentation will show you how to get started in
using Flask-SQLAlchemy with Flask.

* Quickstart

  * A Minimal Application

  * Simple Relationships

  * Road to Enlightenment

* Introduction into Contexts

* Configuration

  * Configuration Keys

  * Connection URI Format

  * Using custom MetaData and naming conventions

  * Timeouts

* Declaring Models

  * Simple Example

  * One-to-Many Relationships

  * Many-to-Many Relationships

* Select, Insert, Delete

  * Inserting Records

  * Deleting Records

  * Querying Records

  * Queries in Views

* Multiple Databases with Binds

  * Example Configuration

  * Creating and Dropping Tables

  * Referring to Binds

* Signalling Support

* Customizing

  * Model Class

  * Query Class


API Reference
=============

If you are looking for information on a specific function, class or
method, this part of the documentation is for you.

* API

  * Configuration

  * Models

  * Sessions

  * Utilities


Additional Notes
================

See Flask's license for legal information governing this project.

* Changelog

  * Version 2.2

  * Version 2.1

  * Version 2.0

  * Version 1.0

  * Version 0.16

  * Version 0.15

  * Version 0.14

  * Version 0.13

  * Version 0.12

  * Version 0.11

  * Version 0.10

  * Version 0.9

  * Version 0.8

  * Version 0.7
