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

[image]

Flask-SQLAlchemy is an extension for Flask that adds support for
SQLAlchemy to your application.  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.


Requirements
============

+---------------------------+---------------------------+---------------------------+---------------------------+
| Our Version               | Python                    | Flask                     | SQLAlchemy                |
|===========================|===========================|===========================|===========================|
| 2.x                       | 2.7, 3.4+                 | 0.12+                     | 0.8+ or 1.0.10+ w/ Python |
|                           |                           |                           | 3.7                       |
+---------------------------+---------------------------+---------------------------+---------------------------+
| 3.0+ (in dev)             | 2.7, 3.5+                 | 1.0+                      | 1.0+                      |
+---------------------------+---------------------------+---------------------------+---------------------------+


User Guide
==========

* 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

  * "models_committed"

  * "before_models_committed"

* Customizing

  * Model Class

  * Model Mixins

  * Query Class

  * Model Metaclass


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

* API

  * Configuration

  * Models

  * Sessions

  * Utilities


Additional Information
======================

* License

* Changes

  * Version 2.5.1

  * Version 2.5.0

  * Version 2.4.4

  * Version 2.4.3

  * Version 2.4.2

  * Version 2.4.1

  * Version 2.4.0

  * Version 2.3.2

  * Version 2.3.1

  * Version 2.3.0

  * 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
