blob: ef442342caab79ce2a9c6f4b492bc5124fb10ea1 (
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
|
===========
API Details
===========
This section describes some key functions used within the migration process, particularly those referenced within
a migration environment's ``env.py`` file.
env.py Directives
=================
.. autofunction:: sqlalchemy.engine.engine_from_config
.. autofunction:: alembic.context.configure
.. autofunction:: alembic.context.get_context
.. autofunction:: alembic.context.execute
.. autofunction:: alembic.context.requires_connection
.. autofunction:: alembic.context.run_migrations
Internals
=========
.. currentmodule:: alembic.command
Commands
--------
Alembic commands are all represented by functions in the :mod:`alembic.command`
package. They all accept the same style of usage, being sent
the :class:`~.alembic.config.Config` object as the first argument.
.. automodule:: alembic.command
:members:
:undoc-members:
Misc
----
.. automodule:: alembic.config
:members:
:undoc-members:
.. automodule:: alembic.script
:members:
:undoc-members:
DDL Internals
-------------
.. automodule:: alembic.ddl
:members:
:undoc-members:
.. automodule:: alembic.ddl.base
: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:
|
