1ALEMBIC(1) User Commands ALEMBIC(1)
2
3
4
6 alembic - manual page for alembic 1.13.0
7
9 usage: -c [-h] [--version] [-c CONFIG] [-n NAME] [-x X] [--raiseerr]
10 [-q]
11
12 {branches,check,current,downgrade,edit,ensure_version,heads,his‐
13 tory,init,list_templates,merge,revision,show,stamp,upgrade} ...
14
15 positional arguments:
16 {branches,check,current,downgrade,edit,ensure_version,heads,his‐
17 tory,init,list_templates,merge,revision,show,stamp,upgrade}
18
19 branches
20 Show current branch points.
21
22 check Check if revision command with autogenerate has pending upgrade
23 ops.
24
25 current
26 Display the current revision for a database.
27
28 downgrade
29 Revert to a previous version.
30
31 edit Edit revision script(s) using $EDITOR.
32
33 ensure_version
34 Create the alembic version table if it doesn't exist already .
35
36 heads Show current available heads in the script directory.
37
38 history
39 List changeset scripts in chronological order.
40
41 init Initialize a new scripts directory.
42
43 list_templates
44 List available templates.
45
46 merge Merge two revisions together. Creates a new migration file.
47
48 revision
49 Create a new revision file.
50
51 show Show the revision(s) denoted by the given symbol.
52
53 stamp 'stamp' the revision table with the given revision; don't run
54 any migrations.
55
56 upgrade
57 Upgrade to a later version.
58
59 options:
60 -h, --help
61 show this help message and exit
62
63 --version
64 show program's version number and exit
65
66 -c CONFIG, --config CONFIG
67 Alternate config file; defaults to value of ALEMBIC_CONFIG envi‐
68 ronment variable, or "alembic.ini"
69
70 -n NAME, --name NAME
71 Name of section in .ini file to use for Alembic config
72
73 -x X Additional arguments consumed by custom env.py scripts, e.g. -x
74 setting1=somesetting -x setting2=somesetting
75
76 --raiseerr
77 Raise a full stack trace on error
78
79 -q, --quiet
80 Do not log to std output.
81
82
83
84alembic 1.13.0 December 2023 ALEMBIC(1)