diff --git a/docs/database_helpers.rst b/docs/database_helpers.rst new file mode 100644 index 0000000..7a67515 --- /dev/null +++ b/docs/database_helpers.rst @@ -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 diff --git a/docs/index.rst b/docs/index.rst index 7e39ede..a3c7e7f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,5 +13,6 @@ SQLAlchemy-Utils provides custom data types and various utility functions for SQ aggregates decorators generic_relationship - utilities + database_helpers + model_helpers license diff --git a/docs/utilities.rst b/docs/model_helpers.rst similarity index 65% rename from docs/utilities.rst rename to docs/model_helpers.rst index f0a96ff..8942f9b 100644 --- a/docs/utilities.rst +++ b/docs/model_helpers.rst @@ -1,5 +1,5 @@ -Utility functions -================= +Model helpers +============= .. module:: sqlalchemy_utils.functions @@ -28,22 +28,11 @@ identity .. autofunction:: identity -is_indexed_foreign_key -^^^^^^^^^^^^^^^^^^^^^^ - -.. autofunction:: is_indexed_foreign_key - - naturally_equivalent ^^^^^^^^^^^^^^^^^^^^ .. autofunction:: naturally_equivalent -non_indexed_foreign_keys -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. autofunction:: non_indexed_foreign_keys - sort_query ^^^^^^^^^^