Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated documentation

  • Loading branch information...
commit fea753b49a6fbad99c6da55838b6aa0d9b8eb197 1 parent 7c632e9
@mitsuhiko mitsuhiko authored
Showing with 64 additions and 17 deletions.
  1. +29 −0 CHANGES
  2. +1 −1  MANIFEST.in
  3. +34 −16 docs/index.rst
View
29 CHANGES
@@ -0,0 +1,29 @@
+Changelog
+---------
+
+Here you can see the full list of changes between each Flask-SQLAlchemy
+release.
+
+Version 0.10
+````````````
+
+- Added support for signals.
+- Table names are now automatically set from the class name unless
+ overriden.
+
+Version 0.9
+```````````
+
+- applied changes to pass the Flask extension approval process.
+
+Version 0.8
+```````````
+
+- added a few configuration keys for creating connections.
+- automatically activate connection recycling for MySQL connections.
+- added support for the Flask testing mode.
+
+Version 0.7
+```````````
+
+- Initial public release
View
2  MANIFEST.in
@@ -1,4 +1,4 @@
-include LICENSE *.py
+include LICENSE CHANGES *.py
recursive-include docs *
recursive-exclude docs *.pyc
recursive-exclude docs *.pyo
View
50 docs/index.rst
@@ -87,6 +87,11 @@ And how do you get the data back? Easy as pie:
>>> admin = User.query.filter_by(username='admin').first()
<User u'admin'>
+.. versionchanged:: 0.10
+ The `__tablename__` attribute is now optional. If not defined, the
+ class name (converted to lowercases and camel cased words separated
+ by underscores) is used.
+
Road to Enlightenment
---------------------
@@ -157,6 +162,34 @@ The following configuration values exist for Flask-SQLAlchemy:
``SQLALCHEMY_POOL_TIMEOUT`` and ``SQLALCHEMY_POOL_RECYCLE``
configuration keys were added.
+Signalling Support
+------------------
+
+.. versionadded:: 0.10
+
+Starting with Flask-SQLAlchemy 0.10 you can now connect to signals to be
+notified when certain things happen.
+
+The following two signals exist:
+
+.. data:: models_committed
+
+ This signal is sent when changed models where committed to the
+ database. The sender is the application that emitted the changes
+ and the models and an operation identifier are passed as list of tuples
+ in the form ``(model, operation)`` to the receiver in the `changes`
+ parameter.
+
+ The model is the instance of the model that was sent to the database
+ and the operation is ``'insert'`` when a model was inserted,
+ ``'delete'`` when the model was deleted and ``'update'`` if any
+ of the columns where updated.
+
+.. data:: before_models_committed
+
+ Works exactly the same as :data:`models_committed` but is emitted
+ right before the comitting takes place.
+
API
---
@@ -211,19 +244,4 @@ Utilities
.. autofunction:: get_debug_queries
-Changelog
----------
-
-0.8
-```
-
-- added a few configuration keys for creating connections.
-
-- automatically activate connection recycling for MySQL connections.
-
-- added support for the Flask testing mode.
-
-0.7
-```
-
-- Initial public release
+.. include:: ../CHANGES
Please sign in to comment.
Something went wrong with that request. Please try again.