openstack/deb-python-sqlalchemy-utils
Code Issues Proposed changes

Split utitilies to model helpers and database helpers in docs

Browse Source
This commit is contained in:
Konsta Vesterinen
2013-11-13 08:12:27 +02:00
parent 0dd7c159eb
commit 6682076376
3 changed files with 51 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/database_helpers.rst Normal file
View File

@@ -0,0 +1,47 @@
Database helpers
================
.. module:: sqlalchemy_utils.functions
is_indexed_foreign_key
^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: is_indexed_foreign_key
non_indexed_foreign_keys
^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: non_indexed_foreign_keys
database_exists
^^^^^^^^^^^^^^^
.. autofunction:: database_exists
create_database
^^^^^^^^^^^^^^^
.. autofunction:: create_database
drop_database
^^^^^^^^^^^^^^
.. autofunction:: drop_database
render_expression
^^^^^^^^^^^^^^^^^
.. autofunction:: render_expression
render_statement
^^^^^^^^^^^^^^^^
.. autofunction:: render_statement

3
docs/index.rst
View File

@@ -13,5 +13,6 @@ SQLAlchemy-Utils provides custom data types and various utility functions for SQ
aggregates aggregates
decorators decorators
generic_relationship generic_relationship
utilities database_helpers
model_helpers
license license

15
docs/utilities.rst → docs/model_helpers.rst
View File

@@ -1,5 +1,5 @@
Utility functions Model helpers
================= =============
.. module:: sqlalchemy_utils.functions .. module:: sqlalchemy_utils.functions
@@ -28,22 +28,11 @@ identity
.. autofunction:: identity .. autofunction:: identity
is_indexed_foreign_key
^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: is_indexed_foreign_key
naturally_equivalent naturally_equivalent
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
.. autofunction:: naturally_equivalent .. autofunction:: naturally_equivalent
non_indexed_foreign_keys
^^^^^^^^^^^^^^^^^^^^^^^^
.. autofunction:: non_indexed_foreign_keys
sort_query sort_query
^^^^^^^^^^ ^^^^^^^^^^