summaryrefslogtreecommitdiff
path: root/doc/source/api.rst
blob: 6d5a54efee6a2cb60577ca3bb9146c99b2cbdaf8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
Module :mod:`migrate.changeset` -- Schema changes
=================================================

Module :mod:`migrate.changeset` -- Schema migration API
-------------------------------------------------------

.. automodule:: migrate.changeset
   :members:
   :synopsis: Database changeset management

Module :mod:`ansisql <migrate.changeset.ansisql>` -- Standard SQL implementation
------------------------------------------------------------------------------------

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

Module :mod:`constraint <migrate.changeset.constraint>` -- Constraint schema migration API
---------------------------------------------------------------------------------------------

.. automodule:: migrate.changeset.constraint
   :members:
   :inherited-members:
   :show-inheritance:
   :member-order: groupwise
   :synopsis: Standalone schema constraint objects

Module :mod:`databases <migrate.changeset.databases>` -- Database specific schema migration
-----------------------------------------------------------------------------------------------

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

.. _mysql-d:

Module :mod:`mysql <migrate.changeset.databases.mysql>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. automodule:: migrate.changeset.databases.mysql
   :members:
   :synopsis: MySQL database specific changeset implementations

.. _firebird-d:

Module :mod:`firebird <migrate.changeset.databases.firebird>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


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

.. _oracle-d:

Module :mod:`oracle <migrate.changeset.databases.oracle>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. automodule:: migrate.changeset.databases.oracle
   :members:
   :synopsis: Oracle database specific changeset implementations

.. _postgres-d:

Module :mod:`postgres <migrate.changeset.databases.postgres>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

.. _sqlite-d:

Module :mod:`sqlite <migrate.changeset.databases.sqlite>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

Module :mod:`visitor <migrate.changeset.databases.visitor>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

Module :mod:`schema <migrate.changeset.schema>` -- Additional API to SQLAlchemy for migrations
----------------------------------------------------------------------------------------------

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


Module :mod:`migrate.versioning` -- Database versioning and repository management
==================================================================================

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

.. _versioning-api:

Module :mod:`api <migrate.versioning.api>` -- Python API commands
-----------------------------------------------------------------

.. automodule:: migrate.versioning.api
   :members:
   :synopsis: External API for :mod:`migrate.versioning`


Module :mod:`genmodel <migrate.versioning.genmodel>` -- ORM Model generator
-------------------------------------------------------------------------------------

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

Module :mod:`pathed <migrate.versioning.pathed>` -- Path utilities
----------------------------------------------------------------------------

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

Module :mod:`repository <migrate.versioning.repository>` -- Repository management
-------------------------------------------------------------------------------------

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

Module :mod:`schema <migrate.versioning.schema>` -- Migration upgrade/downgrade
----------------------------------------------------------------------------------

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

Module :mod:`schemadiff <migrate.versioning.schemadiff>` -- ORM Model differencing
-------------------------------------------------------------------------------------

.. automodule:: migrate.versioning.schemadiff
   :members:
   :synopsis: Database schema and model differencing

Module :mod:`script <migrate.versioning.script>` -- Script actions
--------------------------------------------------------------------

.. automodule:: migrate.versioning.script.base
   :synopsis: Script utilities
   :member-order: groupwise
   :members:

.. automodule:: migrate.versioning.script.py
   :members:
   :member-order: groupwise
   :inherited-members:
   :show-inheritance:

.. automodule:: migrate.versioning.script.sql
   :members:
   :member-order: groupwise
   :show-inheritance:
   :inherited-members:

Module :mod:`shell <migrate.versioning.shell>` -- CLI interface
------------------------------------------------------------------

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

Module :mod:`util <migrate.versioning.util>` -- Various utility functions
--------------------------------------------------------------------------

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

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

.. automodule:: migrate.versioning.version
   :members:
   :member-order: groupwise
   :synopsis: Version management

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

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