summaryrefslogtreecommitdiff
path: root/docs/build/api/ddl.rst
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2015-07-03 13:10:41 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2015-07-03 13:10:41 -0400
commit0e43247da4cfd2d829ee4b350e336364cb8a7ec1 (patch)
treeb98e97333832e8db5f3c983f42771a2c15936ccc /docs/build/api/ddl.rst
parent5ccc81701c08a482efa4b7080ca88608fd237130 (diff)
downloadalembic-0e43247da4cfd2d829ee4b350e336364cb8a7ec1.tar.gz
- squash merge of ticket_302 branch
- The internal system for Alembic operations has been reworked to now build upon an extensible system of operation objects. New operations can be added to the ``op.`` namespace, including that they are available in custom autogenerate schemes. fixes #302 - The internal system for autogenerate been reworked to build upon the extensible system of operation objects present in #302. A new customization hook process_revision_directives is added to allow manipulation of the autogen stream. Fixes #301
Diffstat (limited to 'docs/build/api/ddl.rst')
-rw-r--r--docs/build/api/ddl.rst56
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/build/api/ddl.rst b/docs/build/api/ddl.rst
new file mode 100644
index 0000000..2d114c8
--- /dev/null
+++ b/docs/build/api/ddl.rst
@@ -0,0 +1,56 @@
+.. _alembic.ddl.toplevel:
+
+=============
+DDL Internals
+=============
+
+These are some of the constructs used to generate migration
+instructions. The APIs here build off of the :class:`sqlalchemy.schema.DDLElement`
+and :ref:`sqlalchemy.ext.compiler_toplevel` systems.
+
+For programmatic usage of Alembic's migration directives, the easiest
+route is to use the higher level functions given by :ref:`alembic.operations.toplevel`.
+
+.. automodule:: alembic.ddl
+ :members:
+ :undoc-members:
+
+.. automodule:: alembic.ddl.base
+ :members:
+ :undoc-members:
+
+.. automodule:: alembic.ddl.impl
+ :members:
+ :undoc-members:
+
+MySQL
+=============
+
+.. automodule:: alembic.ddl.mysql
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+MS-SQL
+=============
+
+.. automodule:: alembic.ddl.mssql
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Postgresql
+=============
+
+.. automodule:: alembic.ddl.postgresql
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+SQLite
+=============
+
+.. automodule:: alembic.ddl.sqlite
+ :members:
+ :undoc-members:
+ :show-inheritance: