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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
|
==========
Changelog
==========
.. changelog::
:version: 0.6.0
.. change::
:tags: misc
Source repository has been moved from Mercurial to Git.
.. change::
:tags: bug
Repaired autogenerate rendering of ForeignKeyConstraint
to include use_alter argument, if present.
.. change::
:tags: feature
:pullreq: 35
Added ``-r`` argument to ``alembic history`` command,
allows specification of ``[start]:[end]`` to view
a slice of history. Accepts revision numbers, symbols
"base", "head", a new symbol "current" representing the
current migration, as well as relative ranges for one
side at a time (i.e. ``-r-5:head``, ``-rcurrent:+3``).
Courtesy Atsushi Odagiri for this feature.
.. change::
:tags: feature
:pullreq: 34
:tickets: 55
Source base is now in-place for Python 2.6 through
3.3, without the need for 2to3. Support for Python 2.5
and below has been dropped. Huge thanks to
Hong Minhee for all the effort on this!
.. changelog::
:version: 0.5.0
:released: Thu Apr 4 2013
.. note::
Alembic 0.5.0 now requires at least
version 0.7.3 of SQLAlchemy to run properly.
Support for 0.6 has been dropped.
.. change::
:tags: feature
:tickets: 76
:pullreq: 24
Added ``version_table_schema`` argument
to :meth:`.EnvironmentContext.configure`,
complements the ``version_table`` argument to
set an optional remote schema for the version
table. Courtesy Christian Blume.
.. change::
:tags: bug, postgresql
:tickets: 32
Fixed format of RENAME for table that includes
schema with Postgresql; the schema name shouldn't
be in the "TO" field.
.. change::
:tags: feature
:tickets: 90
Added ``output_encoding`` option to
:meth:`.EnvironmentContext.configure`,
used with ``--sql`` mode to apply an encoding
to the output stream.
.. change::
:tags: feature
:tickets: 93
Added :meth:`.Operations.create_primary_key`
operation, will genenerate an ADD CONSTRAINT
for a primary key.
.. change::
:tags: bug, mssql
:tickets: 109
Fixed bug whereby double quoting would be applied
to target column name during an ``sp_rename``
operation.
.. change::
:tags: bug, sqlite, mysql
:tickets: 112
transactional_ddl flag for SQLite, MySQL dialects
set to False. MySQL doesn't support it,
SQLite does but current pysqlite driver does not.
.. change::
:tags: feature
:pullreq: 30
:tickets: 115
upgrade and downgrade commands will list the
first line of the docstring out next to the
version number. Courtesy Hong Minhee.
.. change::
:tags: feature
:pullreq: 28
Added --head-only option to "alembic current",
will print current version plus the symbol
"(head)" if this version is the head or not.
Courtesy Charles-Axel Dein.
.. change::
:tags: bug
:tickets: 110
Autogenerate will render additional table keyword
arguments like "mysql_engine" and others within
op.create_table().
.. change::
:tags: feature
:tickets: 108
The rendering of any construct during autogenerate
can be customized, in particular to allow special rendering
for user-defined column, constraint subclasses, using new
``render_item`` argument to
:meth:`.EnvironmentContext.configure`.
.. change::
:tags: bug
Fixed bug whereby create_index()
would include in the constraint columns that
are added to all Table objects using events,
externally to the generation of the constraint.
This is the same issue that was fixed for unique
constraints in version 0.3.2.
.. change::
:tags: bug
:pullreq: 27
Worked around a backwards-incompatible regression in Python3.3
regarding argparse; running "alembic" with no arguments
now yields an informative error in py3.3 as with all previous versions.
Courtesy Andrey Antukh.
.. change::
:tags: change
SQLAlchemy 0.6 is no longer supported by Alembic - minimum version is 0.7.3,
full support is as of 0.7.9.
.. change::
:tags: bug
:tickets: 104
A host of argument name changes within migration
operations for consistency. Keyword arguments
will continue to work on the old name for backwards compatibility,
however required positional arguments will not:
:meth:`.Operations.alter_column` - ``name`` -> ``new_column_name`` - old
name will work for backwards compatibility.
:meth:`.Operations.create_index` - ``tablename`` -> ``table_name`` -
argument is positional.
:meth:`.Operations.drop_index` - ``tablename`` -> ``table_name`` - old
name will work for backwards compatibility.
:meth:`.Operations.drop_constraint` - ``tablename`` -> ``table_name`` -
argument is positional.
:meth:`.Operations.drop_constraint` - ``type`` -> ``type_`` - old
name will work for backwards compatibility
.. changelog::
:version: 0.4.2
:released: Fri Jan 11 2013
.. change::
:tags: bug, autogenerate
:tickets: 99
Fixed bug where autogenerate would fail if a Column
to be added to a table made use of the ".key" paramter.
.. change::
:tags: bug, sqlite
:tickets: 98
The "implicit" constraint generated by a
type such as Boolean or Enum will not generate an
ALTER statement when run on SQlite, which does not
support ALTER for the purpose of adding/removing
constraints separate from the column def itself.
While SQLite supports adding a CHECK constraint
at the column level, SQLAlchemy would need modification
to support this.
A warning is emitted indicating this
constraint cannot be added in this scenario.
.. change::
:tags: bug
:tickets: 96
Added a workaround to setup.py to prevent
"NoneType" error from occuring when
"setup.py test" is run.
.. change::
:tags: bug
:tickets: 96
Added an append_constraint() step to each
condition within
test_autogenerate:AutogenRenderTest.test_render_fk_constraint_kwarg
if the SQLAlchemy version is less than 0.8, as ForeignKeyConstraint
does not auto-append prior to 0.8.
.. change::
:tags: feature
:tickets: 96
Added a README.unittests with instructions for running the test
suite fully.
.. changelog::
:version: 0.4.1
:released: Sun Dec 9 2012
.. change::
:tags: bug
:tickets: 92
Added support for autogenerate render of
ForeignKeyConstraint options onupdate,
ondelete, initially, and deferred.
.. change::
:tags: bug
:tickets: 94
Autogenerate will include "autoincrement=False"
in the rendered table metadata
if this flag was set to false on the source
:class:`.Column` object.
.. change::
:tags: feature
:tickets: 66
Explicit error message describing the case
when downgrade --sql is used without specifying
specific start/end versions.
.. change::
:tags: bug
:tickets: 81
Removed erroneous "emit_events" attribute
from operations.create_table() documentation.
.. change::
:tags: bug
:tickets:
Fixed the minute component in file_template
which returned the month part of the create date.
.. changelog::
:version: 0.4.0
:released: Mon Oct 01 2012
.. change::
:tags: feature
:tickets: 33
Support for tables in alternate schemas
has been added fully to all operations, as well as to
the autogenerate feature. When using autogenerate,
specifying the flag include_schemas=True to
Environment.configure() will also cause autogenerate
to scan all schemas located by Inspector.get_schema_names(),
which is supported by *some* (but not all)
SQLAlchemy dialects including Postgresql.
*Enormous* thanks to Bruno Binet for a huge effort
in implementing as well as writing tests. .
.. change::
:tags: feature
:tickets: 70
The command line runner has been organized
into a reusable CommandLine object, so that other
front-ends can re-use the argument parsing built
in.
.. change::
:tags: feature
:tickets: 43
Added "stdout" option to Config, provides
control over where the "print" output of commands like
"history", "init", "current" etc. are sent.
.. change::
:tags: bug
:tickets: 71
Fixed the "multidb" template which was badly out
of date. It now generates revision files using
the configuration to determine the different
upgrade_<xyz>() methods needed as well, instead of
needing to hardcode these. Huge thanks to
BryceLohr for doing the heavy lifting here.
.. change::
:tags: bug
:tickets: 72
Fixed the regexp that was checking for .py files
in the version directory to allow any .py file through.
Previously it was doing some kind of defensive checking,
probably from some early notions of how this directory
works, that was prohibiting various filename patterns
such as those which begin with numbers.
.. change::
:tags: bug
:tickets:
Fixed MySQL rendering for server_default which
didn't work if the server_default was a generated
SQL expression. Courtesy Moriyoshi Koizumi.
.. change::
:tags: feature
:tickets:
Added support for alteration of MySQL
columns that have AUTO_INCREMENT, as well as enabling
this flag. Courtesy Moriyoshi Koizumi.
.. changelog::
:version: 0.3.6
:released: Wed Aug 15 2012
.. change::
:tags: feature
:tickets: 27
Added include_symbol option to
EnvironmentContext.configure(),
specifies a callable which will include/exclude tables
in their entirety from the autogeneration process
based on name.
.. change::
:tags: feature
:tickets: 59
Added year, month, day, hour, minute, second
variables to file_template.
.. change::
:tags: feature
:tickets:
Added 'primary' to the list of constraint types
recognized for MySQL drop_constraint().
.. change::
:tags: feature
:tickets:
Added --sql argument to the "revision" command,
for the use case where the "revision_environment"
config option is being used but SQL access isn't
desired.
.. change::
:tags: bug
:tickets:
Repaired create_foreign_key() for
self-referential foreign keys, which weren't working
at all.
.. change::
:tags: bug
:tickets: 63
'alembic' command reports an informative
error message when the configuration is missing
the 'script_directory' key.
.. change::
:tags: bug
:tickets: 62
Fixes made to the constraints created/dropped
alongside so-called "schema" types such as
Boolean and Enum. The create/drop constraint logic
does not kick in when using a dialect that doesn't
use constraints for these types, such as postgresql,
even when existing_type is specified to
alter_column(). Additionally, the constraints
are not affected if existing_type is passed but
type\_ is not, i.e. there's no net change
in type.
.. change::
:tags: bug
:tickets: 66
Improved error message when specifiying
non-ordered revision identifiers to cover
the case when the "higher" rev is None,
improved message overall.
.. changelog::
:version: 0.3.5
:released: Sun Jul 08 2012
.. change::
:tags: bug
:tickets: 31
Fixed issue whereby reflected server defaults
wouldn't be quoted correctly; uses repr() now.
.. change::
:tags: bug
:tickets: 58
Fixed issue whereby when autogenerate would
render create_table() on the upgrade side for a
table that has a Boolean type, an unnecessary
CheckConstraint() would be generated.
.. change::
:tags: feature
:tickets:
Implemented SQL rendering for
CheckConstraint() within autogenerate upgrade,
including for literal SQL as well as SQL Expression
Language expressions.
.. changelog::
:version: 0.3.4
:released: Sat Jun 02 2012
.. change::
:tags: bug
:tickets:
Fixed command-line bug introduced by the
"revision_environment" feature.
.. changelog::
:version: 0.3.3
:released: Sat Jun 02 2012
.. change::
:tags: feature
:tickets:
New config argument
"revision_environment=true", causes env.py to
be run unconditionally when the "revision" command
is run, to support script.py.mako templates with
dependencies on custom "template_args".
.. change::
:tags: feature
:tickets:
Added "template_args" option to configure()
so that an env.py can add additional arguments
to the template context when running the
"revision" command. This requires either --autogenerate
or the configuration directive "revision_environment=true".
.. change::
:tags: bug
:tickets: 44
Added "type" argument to op.drop_constraint(),
and implemented full constraint drop support for
MySQL. CHECK and undefined raise an error.
MySQL needs the constraint type
in order to emit a DROP CONSTRAINT.
.. change::
:tags: feature
:tickets: 34
Added version_table argument to
EnvironmentContext.configure(), allowing for the
configuration of the version table name.
.. change::
:tags: feature
:tickets:
Added support for "relative" migration
identifiers, i.e. "alembic upgrade +2",
"alembic downgrade -1". Courtesy
Atsushi Odagiri for this feature.
.. change::
:tags: bug
:tickets: 49
Fixed bug whereby directories inside of
the template directories, such as __pycache__
on Pypy, would mistakenly be interpreted as
files which are part of the template.
.. changelog::
:version: 0.3.2
:released: Mon Apr 30 2012
.. change::
:tags: feature
:tickets: 40
Basic support for Oracle added,
courtesy shgoh.
.. change::
:tags: feature
:tickets:
Added support for UniqueConstraint
in autogenerate, courtesy Atsushi Odagiri
.. change::
:tags: bug
:tickets:
Fixed support of schema-qualified
ForeignKey target in column alter operations,
courtesy Alexander Kolov.
.. change::
:tags: bug
:tickets:
Fixed bug whereby create_unique_constraint()
would include in the constraint columns that
are added to all Table objects using events,
externally to the generation of the constraint.
.. changelog::
:version: 0.3.1
:released: Sat Apr 07 2012
.. change::
:tags: bug
:tickets: 41
bulk_insert() fixes:
1. bulk_insert() operation was
not working most likely since the 0.2 series
when used with an engine.
2. Repaired bulk_insert() to complete when
used against a lower-case-t table and executing
with only one set of parameters, working
around SQLAlchemy bug #2461 in this regard.
3. bulk_insert() uses "inline=True" so that phrases
like RETURNING and such don't get invoked for
single-row bulk inserts.
4. bulk_insert() will check that you're passing
a list of dictionaries in, raises TypeError
if not detected.
.. changelog::
:version: 0.3.0
:released: Thu Apr 05 2012
.. change::
:tags: general
:tickets:
The focus of 0.3 is to clean up
and more fully document the public API of Alembic,
including better accessors on the MigrationContext
and ScriptDirectory objects. Methods that are
not considered to be public on these objects have
been underscored, and methods which should be public
have been cleaned up and documented, including:
MigrationContext.get_current_revision()
ScriptDirectory.iterate_revisions()
ScriptDirectory.get_current_head()
ScriptDirectory.get_heads()
ScriptDirectory.get_base()
ScriptDirectory.generate_revision()
.. change::
:tags: feature
:tickets:
Added a bit of autogenerate to the
public API in the form of the function
alembic.autogenerate.compare_metadata.
.. changelog::
:version: 0.2.2
:released: Mon Mar 12 2012
.. change::
:tags: feature
:tickets:
Informative error message when op.XYZ
directives are invoked at module import time.
.. change::
:tags: bug
:tickets: 35
Fixed inappropriate direct call to
util.err() and therefore sys.exit()
when Config failed to locate the
config file within library usage.
.. change::
:tags: bug
:tickets:
Autogenerate will emit CREATE TABLE
and DROP TABLE directives according to
foreign key dependency order.
.. change::
:tags: bug
:tickets:
implement 'tablename' parameter on
drop_index() as this is needed by some
backends.
.. change::
:tags: feature
:tickets:
Added execution_options parameter
to op.execute(), will call execution_options()
on the Connection before executing.
The immediate use case here is to allow
access to the new no_parameters option
in SQLAlchemy 0.7.6, which allows
some DBAPIs (psycopg2, MySQLdb) to allow
percent signs straight through without
escaping, thus providing cross-compatible
operation with DBAPI execution and
static script generation.
.. change::
:tags: bug
:tickets:
setup.py won't install argparse if on
Python 2.7/3.2
.. change::
:tags: feature
:tickets: 29
script_location can be interpreted
by pkg_resources.resource_filename(), if
it is a non-absolute URI that contains
colons. This scheme is the same
one used by Pyramid.
.. change::
:tags: feature
:tickets:
added missing support for
onupdate/ondelete flags for
ForeignKeyConstraint, courtesy Giacomo Bagnoli
.. change::
:tags: bug
:tickets: 30
fixed a regression regarding an autogenerate
error message, as well as various glitches
in the Pylons sample template. The Pylons sample
template requires that you tell it where to
get the Engine from now. courtesy
Marcin Kuzminski
.. change::
:tags: bug
:tickets:
drop_index() ensures a dummy column
is added when it calls "Index", as SQLAlchemy
0.7.6 will warn on index with no column names.
.. changelog::
:version: 0.2.1
:released: Tue Jan 31 2012
.. change::
:tags: bug
:tickets: 26
Fixed the generation of CHECK constraint,
regression from 0.2.0
.. changelog::
:version: 0.2.0
:released: Mon Jan 30 2012
.. change::
:tags: feature
:tickets: 19
API rearrangement allows everything
Alembic does to be represented by contextual
objects, including EnvironmentContext,
MigrationContext, and Operations. Other
libraries and applications can now use
things like "alembic.op" without relying
upon global configuration variables.
The rearrangement was done such that
existing migrations should be OK,
as long as they use the pattern
of "from alembic import context" and
"from alembic import op", as these
are now contextual objects, not modules.
.. change::
:tags: feature
:tickets: 24
The naming of revision files can
now be customized to be some combination
of "rev id" and "slug", the latter of which
is based on the revision message.
By default, the pattern "<rev>_<slug>"
is used for new files. New script files
should include the "revision" variable
for this to work, which is part of
the newer script.py.mako scripts.
.. change::
:tags: bug
:tickets: 25
env.py templates call
connection.close() to better support
programmatic usage of commands; use
NullPool in conjunction with create_engine()
as well so that no connection resources
remain afterwards.
.. change::
:tags: bug
:tickets: 22
fix the config.main() function to honor
the arguments passed, remove no longer used
"scripts/alembic" as setuptools creates this
for us.
.. change::
:tags: bug
:tickets:
Fixed alteration of column type on
MSSQL to not include the keyword "TYPE".
.. change::
:tags: feature
:tickets: 23
Can create alembic.config.Config
with no filename, use set_main_option()
to add values. Also added set_section_option()
which will add sections.
.. changelog::
:version: 0.1.1
:released: Wed Jan 04 2012
.. change::
:tags: bug
:tickets:
Clean up file write operations so that
file handles are closed.
.. change::
:tags: feature
:tickets:
PyPy is supported.
.. change::
:tags: feature
:tickets:
Python 2.5 is supported, needs
__future__.with_statement
.. change::
:tags: bug
:tickets:
Fix autogenerate so that "pass" is
generated between the two comments
if no net migrations were present.
.. change::
:tags: bug
:tickets: 16
Fix autogenerate bug that prevented
correct reflection of a foreign-key
referenced table in the list of "to remove".
.. change::
:tags: bug
:tickets: 17
Fix bug where create_table() didn't
handle self-referential foreign key
correctly
.. change::
:tags: bug
:tickets: 18
Default prefix for autogenerate
directives is "op.", matching the
mako templates.
.. change::
:tags: feature
:tickets: 18
Add alembic_module_prefix argument
to configure() to complement
sqlalchemy_module_prefix.
.. change::
:tags: bug
:tickets: 14
fix quotes not being rendered in
ForeignKeConstraint during
autogenerate
.. changelog::
:version: 0.1.0
:released: Wed Nov 30 2011
.. change::
:tags:
:tickets:
Initial release. Status of features:
.. change::
:tags:
:tickets:
Alembic is used in at least one production
environment, but should still be considered
ALPHA LEVEL SOFTWARE as of this release,
particularly in that many features are expected
to be missing / unimplemented. Major API
changes are not anticipated but for the moment
nothing should be assumed.
The author asks that you *please* report all
issues, missing features, workarounds etc.
to the bugtracker, at
https://bitbucket.org/zzzeek/alembic/issues/new .
.. change::
:tags:
:tickets:
Python 3 is supported and has been tested.
.. change::
:tags:
:tickets:
The "Pylons" and "MultiDB" environment templates
have not been directly tested - these should be
considered to be samples to be modified as
needed. Multiple database support itself
is well tested, however.
.. change::
:tags:
:tickets:
Postgresql and MS SQL Server environments
have been tested for several weeks in a production
environment. In particular, some involved workarounds
were implemented to allow fully-automated dropping
of default- or constraint-holding columns with
SQL Server.
.. change::
:tags:
:tickets:
MySQL support has also been implemented to a
basic degree, including MySQL's awkward style
of modifying columns being accommodated.
.. change::
:tags:
:tickets:
Other database environments not included among
those three have *not* been tested, *at all*. This
includes Firebird, Oracle, Sybase. Adding
support for these backends should be
straightforward. Please report all missing/
incorrect behaviors to the bugtracker! Patches
are welcome here but are optional - please just
indicate the exact format expected by the target
database.
.. change::
:tags:
:tickets:
SQLite, as a backend, has almost no support for
schema alterations to existing databases. The author
would strongly recommend that SQLite not be used in
a migration context - just dump your SQLite database
into an intermediary format, then dump it back
into a new schema. For dev environments, the
dev installer should be building the whole DB from
scratch. Or just use Postgresql, which is a much
better database for non-trivial schemas.
Requests for full ALTER support on SQLite should be
reported to SQLite's bug tracker at
http://www.sqlite.org/src/wiki?name=Bug+Reports,
as Alembic will not be implementing the
"rename the table to a temptable then copy the
data into a new table" workaround.
Note that Alembic will at some point offer an
extensible API so that you can implement commands
like this yourself.
.. change::
:tags:
:tickets:
Well-tested directives include add/drop table, add/drop
column, including support for SQLAlchemy "schema"
types which generate additional CHECK
constraints, i.e. Boolean, Enum. Other directives not
included here have *not* been strongly tested
in production, i.e. rename table, etc.
.. change::
:tags:
:tickets:
Both "online" and "offline" migrations, the latter
being generated SQL scripts to hand off to a DBA,
have been strongly production tested against
Postgresql and SQL Server.
.. change::
:tags:
:tickets:
Modify column type, default status, nullable, is
functional and tested across PG, MSSQL, MySQL,
but not yet widely tested in production usage.
.. change::
:tags:
:tickets:
Many migrations are still outright missing, i.e.
create/add sequences, etc. As a workaround,
execute() can be used for those which are missing,
though posting of tickets for new features/missing
behaviors is strongly encouraged.
.. change::
:tags:
:tickets:
Autogenerate feature is implemented and has been
tested, though only a little bit in a production setting.
In particular, detection of type and server
default changes are optional and are off by default;
they can also be customized by a callable.
Both features work but can have surprises particularly
the disparity between BIT/TINYINT and boolean,
which hasn't yet been worked around, as well as
format changes performed by the database on defaults
when it reports back. When enabled, the PG dialect
will execute the two defaults to be compared to
see if they are equivalent. Other backends may
need to do the same thing.
The autogenerate feature only generates
"candidate" commands which must be hand-tailored
in any case, so is still a useful feature and
is safe to use. Please report missing/broken features
of autogenerate! This will be a great feature and
will also improve SQLAlchemy's reflection services.
.. change::
:tags:
:tickets:
Support for non-ASCII table, column and constraint
names is mostly nonexistent. This is also a
straightforward feature add as SQLAlchemy itself
supports unicode identifiers; Alembic itself will
likely need fixes to logging, column identification
by key, etc. for full support here.
|