api.rst 6.4 KB
Newer Older
chrisw's avatar
chrisw committed
1 2
Module :mod:`migrate.changeset` -- Schema changes
=================================================
3

4
Module :mod:`migrate.changeset` -- Schema migration API
chrisw's avatar
chrisw committed
5
-------------------------------------------------------
6

7 8 9 10
.. automodule:: migrate.changeset
   :members:
   :synopsis: Database changeset management

11 12
Module :mod:`ansisql <migrate.changeset.ansisql>` -- Standard SQL implementation
------------------------------------------------------------------------------------
13 14 15

.. automodule:: migrate.changeset.ansisql
   :members:
16
   :member-order: groupwise
17 18
   :synopsis: Standard SQL implementation for altering database schemas

19 20
Module :mod:`constraint <migrate.changeset.constraint>` -- Constraint schema migration API
---------------------------------------------------------------------------------------------
21 22 23

.. automodule:: migrate.changeset.constraint
   :members:
24
   :inherited-members:
25 26
   :show-inheritance:
   :member-order: groupwise
27 28
   :synopsis: Standalone schema constraint objects

29 30
Module :mod:`databases <migrate.changeset.databases>` -- Database specific schema migration
-----------------------------------------------------------------------------------------------
31 32 33 34 35

.. automodule:: migrate.changeset.databases
   :members:
   :synopsis: Database specific changeset implementations

36 37
.. _mysql-d:

38
Module :mod:`mysql <migrate.changeset.databases.mysql>`
chrisw's avatar
chrisw committed
39
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40

41

42 43 44 45
.. automodule:: migrate.changeset.databases.mysql
   :members:
   :synopsis: MySQL database specific changeset implementations

46 47 48
.. _firebird-d:

Module :mod:`firebird <migrate.changeset.databases.firebird>`
chrisw's avatar
chrisw committed
49
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50 51 52 53 54 55


.. automodule:: migrate.changeset.databases.firebird
   :members:
   :synopsis: Firebird database specific changeset implementations

56 57
.. _oracle-d:

58
Module :mod:`oracle <migrate.changeset.databases.oracle>`
chrisw's avatar
chrisw committed
59
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60

61

62 63 64 65
.. automodule:: migrate.changeset.databases.oracle
   :members:
   :synopsis: Oracle database specific changeset implementations

66 67
.. _postgres-d:

68
Module :mod:`postgres <migrate.changeset.databases.postgres>`
chrisw's avatar
chrisw committed
69
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70 71 72 73 74

.. automodule:: migrate.changeset.databases.postgres
   :members:
   :synopsis: PostgreSQL database specific changeset implementations

75 76 77
.. _sqlite-d:

Module :mod:`sqlite <migrate.changeset.databases.sqlite>`
chrisw's avatar
chrisw committed
78
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79 80 81 82 83 84

.. automodule:: migrate.changeset.databases.sqlite
   :members:
   :synopsis: SQLite database specific changeset implementations

Module :mod:`visitor <migrate.changeset.databases.visitor>`
chrisw's avatar
chrisw committed
85
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86 87 88 89

.. automodule:: migrate.changeset.databases.visitor
   :members:

90
Module :mod:`schema <migrate.changeset.schema>` -- Additional API to SQLAlchemy for migrations
chrisw's avatar
chrisw committed
91
----------------------------------------------------------------------------------------------
92 93 94 95 96

.. automodule:: migrate.changeset.schema
   :members:
   :synopsis: Schema changeset handling functions

iElectric's avatar
iElectric committed
97

98 99
Module :mod:`migrate.versioning` -- Database versioning and repository management
==================================================================================
100 101 102 103

.. automodule:: migrate.versioning
   :members:
   :synopsis: Database version and repository management
104

iElectric's avatar
iElectric committed
105 106
.. _versioning-api:

107
Module :mod:`api <migrate.versioning.api>` -- Python API commands
chrisw's avatar
chrisw committed
108
-----------------------------------------------------------------
109 110

.. automodule:: migrate.versioning.api
iElectric's avatar
iElectric committed
111
   :members:
112 113 114
   :synopsis: External API for :mod:`migrate.versioning`


115 116
Module :mod:`genmodel <migrate.versioning.genmodel>` -- ORM Model generator
-------------------------------------------------------------------------------------
117 118 119 120 121

.. automodule:: migrate.versioning.genmodel
   :members:
   :synopsis: Python database model generator and differencer

122 123
Module :mod:`pathed <migrate.versioning.pathed>` -- Path utilities
----------------------------------------------------------------------------
124 125 126 127

.. automodule:: migrate.versioning.pathed
   :members:
   :synopsis: File/Directory handling class
128

129 130
Module :mod:`repository <migrate.versioning.repository>` -- Repository management
-------------------------------------------------------------------------------------
131 132 133 134

.. automodule:: migrate.versioning.repository
   :members:
   :synopsis: SQLAlchemy migrate repository management
135
   :member-order: groupwise
136

137 138
Module :mod:`schema <migrate.versioning.schema>` -- Migration upgrade/downgrade
----------------------------------------------------------------------------------
139 140 141

.. automodule:: migrate.versioning.schema
   :members:
142
   :member-order: groupwise
143 144
   :synopsis: Database schema management

145 146
Module :mod:`schemadiff <migrate.versioning.schemadiff>` -- ORM Model differencing
-------------------------------------------------------------------------------------
iElectric's avatar
iElectric committed
147

148
.. automodule:: migrate.versioning.schemadiff
iElectric's avatar
iElectric committed
149
   :members:
150
   :synopsis: Database schema and model differencing
iElectric's avatar
iElectric committed
151

152 153
Module :mod:`script <migrate.versioning.script>` -- Script actions
--------------------------------------------------------------------
154 155 156

.. automodule:: migrate.versioning.script.base
   :synopsis: Script utilities
157
   :member-order: groupwise
158 159 160 161
   :members:

.. automodule:: migrate.versioning.script.py
   :members:
162
   :member-order: groupwise
163 164 165 166 167
   :inherited-members:
   :show-inheritance:

.. automodule:: migrate.versioning.script.sql
   :members:
168
   :member-order: groupwise
169 170 171
   :show-inheritance:
   :inherited-members:

172 173
Module :mod:`shell <migrate.versioning.shell>` -- CLI interface
------------------------------------------------------------------
174 175 176 177 178

.. automodule:: migrate.versioning.shell
   :members:
   :synopsis: Shell commands

179 180
Module :mod:`util <migrate.versioning.util>` -- Various utility functions
--------------------------------------------------------------------------
iElectric's avatar
iElectric committed
181 182 183 184 185

.. automodule:: migrate.versioning.util
   :members:
   :synopsis: Utility functions

186 187
Module :mod:`version <migrate.versioning.version>` -- Versioning management
-----------------------------------------------------------------------------
188

189
.. automodule:: migrate.versioning.version
190
   :members:
191
   :member-order: groupwise
192
   :synopsis: Version management
chrisw's avatar
chrisw committed
193 194 195 196 197 198 199 200

Module :mod:`exceptions <migrate.exceptions>` -- Exception definitions
======================================================================

.. automodule:: migrate.exceptions
   :members:
   :synopsis: Migrate exception classes