<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Changelog — Alembic 0.4.2 documentation</title> <link rel="stylesheet" href="_static/nature.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '', VERSION: '0.4.2', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <link rel="top" title="Alembic 0.4.2 documentation" href="index.html" /> <link rel="prev" title="API Details" href="api.html" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="api.html" title="API Details" accesskey="P">previous</a> |</li> <li><a href="index.html">Alembic 0.4.2 documentation</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="changelog"> <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1> <div class="section" id="change-0.4.2"> <h2>0.4.2<a class="headerlink" href="#change-0.4.2" title="Permalink to this headline">¶</a></h2> Released: Fri Jan 11 2013<ul class="simple"> <li><p id="change-0.4.2-0"><span class="target" id="change-8e288b3423caf6e50faff14166eb9aa9"><strong>[autogenerate] [bug] </strong></span>Fixed bug where autogenerate would fail if a Column to be added to a table made use of the ”.key” paramter.<a class="changeset-link reference internal" href="#change-8e288b3423caf6e50faff14166eb9aa9">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/99/">#99</a></p> </p> </li> <li><p id="change-0.4.2-1"><span class="target" id="change-0b0f0a80595b012a46c8ba74572a7af9"><strong>[sqlite] [bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-0b0f0a80595b012a46c8ba74572a7af9">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/98/">#98</a></p> </p> </li> <li><p id="change-0.4.2-2"><span class="target" id="change-4742f7f3fbb5ac041ec51027282c79f8"><strong>[bug] </strong></span>Added a workaround to setup.py to prevent “NoneType” error from occuring when “setup.py test” is run.<a class="changeset-link reference internal" href="#change-4742f7f3fbb5ac041ec51027282c79f8">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/96/">#96</a></p> </p> </li> <li><p id="change-0.4.2-3"><span class="target" id="change-260cdd03a36e28159f727294588566d5"><strong>[bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-260cdd03a36e28159f727294588566d5">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/96/">#96</a></p> </p> </li> <li><p id="change-0.4.2-4"><span class="target" id="change-a96aa94592c57be4e2fd7988c6cb8067"><strong>[feature] </strong></span>Added a README.unittests with instructions for running the test suite fully.<a class="changeset-link reference internal" href="#change-a96aa94592c57be4e2fd7988c6cb8067">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/96/">#96</a></p> </p> </li> </ul> </div> <div class="section" id="change-0.4.1"> <h2>0.4.1<a class="headerlink" href="#change-0.4.1" title="Permalink to this headline">¶</a></h2> Released: Sun Dec 9 2012<ul class="simple"> <li><p id="change-0.4.1-0"><span class="target" id="change-e377f2b9ddf06f8bc8ede8dca3a77382"><strong>[bug] </strong></span>Added support for autogenerate render of ForeignKeyConstraint options onupdate, ondelete, initially, and deferred.<a class="changeset-link reference internal" href="#change-e377f2b9ddf06f8bc8ede8dca3a77382">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/92/">#92</a></p> </p> </li> <li><p id="change-0.4.1-1"><span class="target" id="change-4964e8a6ecb0c601b447d6ba685f3363"><strong>[bug] </strong></span>Autogenerate will include “autoincrement=False” in the rendered table metadata if this flag was set to false on the source <tt class="xref py py-class docutils literal"><span class="pre">Column</span></tt> object.<a class="changeset-link reference internal" href="#change-4964e8a6ecb0c601b447d6ba685f3363">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/94/">#94</a></p> </p> </li> <li><p id="change-0.4.1-2"><span class="target" id="change-314a879971a183090705ebe351f0f5b9"><strong>[feature] </strong></span>Explicit error message describing the case when downgrade –sql is used without specifying specific start/end versions.<a class="changeset-link reference internal" href="#change-314a879971a183090705ebe351f0f5b9">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/66/">#66</a></p> </p> </li> <li><p id="change-0.4.1-3"><span class="target" id="change-1635ebce55cc066b99b2c9744833a487"><strong>[bug] </strong></span>Removed erroneous “emit_events” attribute from operations.create_table() documentation.<a class="changeset-link reference internal" href="#change-1635ebce55cc066b99b2c9744833a487">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/81/">#81</a></p> </p> </li> <li><p id="change-0.4.1-4"><span class="target" id="change-27c5d81d343db54381e645a02d272644"><strong>[bug] </strong></span>Fixed the minute component in file_template which returned the month part of the create date.<a class="changeset-link reference internal" href="#change-27c5d81d343db54381e645a02d272644">(link)</a><p></p> </p> </li> </ul> </div> <div class="section" id="change-0.4.0"> <h2>0.4.0<a class="headerlink" href="#change-0.4.0" title="Permalink to this headline">¶</a></h2> Released: Mon Oct 01 2012<ul class="simple"> <li><p id="change-0.4.0-0"><span class="target" id="change-f538c1fee088a24ee358a2f980aa6b8d"><strong>[feature] </strong></span>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 <em>some</em> (but not all) SQLAlchemy dialects including Postgresql. <em>Enormous</em> thanks to Bruno Binet for a huge effort in implementing as well as writing tests. .<a class="changeset-link reference internal" href="#change-f538c1fee088a24ee358a2f980aa6b8d">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/33/">#33</a></p> </p> </li> <li><p id="change-0.4.0-1"><span class="target" id="change-0eaf8afea96414aba40280320842f168"><strong>[feature] </strong></span>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.<a class="changeset-link reference internal" href="#change-0eaf8afea96414aba40280320842f168">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/70/">#70</a></p> </p> </li> <li><p id="change-0.4.0-2"><span class="target" id="change-eb2b96933fa7f7514b0b6cd50b1f995a"><strong>[feature] </strong></span>Added “stdout” option to Config, provides control over where the “print” output of commands like “history”, “init”, “current” etc. are sent.<a class="changeset-link reference internal" href="#change-eb2b96933fa7f7514b0b6cd50b1f995a">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/43/">#43</a></p> </p> </li> <li><p id="change-0.4.0-3"><span class="target" id="change-6cd9b797fde02214e62b49c137366db4"><strong>[bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-6cd9b797fde02214e62b49c137366db4">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/71/">#71</a></p> </p> </li> <li><p id="change-0.4.0-4"><span class="target" id="change-b4115959bba73c5bb1d866ddf6da9728"><strong>[bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-b4115959bba73c5bb1d866ddf6da9728">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/72/">#72</a></p> </p> </li> <li><p id="change-0.4.0-5"><span class="target" id="change-a5638e1287d63ef983cdf2c7ddc5418b"><strong>[bug] </strong></span>Fixed MySQL rendering for server_default which didn’t work if the server_default was a generated SQL expression. Courtesy Moriyoshi Koizumi.<a class="changeset-link reference internal" href="#change-a5638e1287d63ef983cdf2c7ddc5418b">(link)</a><p></p> </p> </li> <li><p id="change-0.4.0-6"><span class="target" id="change-6607a7bfa870e5d4f9f7188b37e3da61"><strong>[feature] </strong></span>Added support for alteration of MySQL columns that have AUTO_INCREMENT, as well as enabling this flag. Courtesy Moriyoshi Koizumi.<a class="changeset-link reference internal" href="#change-6607a7bfa870e5d4f9f7188b37e3da61">(link)</a><p></p> </p> </li> </ul> </div> <div class="section" id="change-0.3.6"> <h2>0.3.6<a class="headerlink" href="#change-0.3.6" title="Permalink to this headline">¶</a></h2> Released: Wed Aug 15 2012<ul class="simple"> <li><p id="change-0.3.6-0"><span class="target" id="change-6c0a32778558736a44572224a1354680"><strong>[feature] </strong></span>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.<a class="changeset-link reference internal" href="#change-6c0a32778558736a44572224a1354680">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/27/">#27</a></p> </p> </li> <li><p id="change-0.3.6-1"><span class="target" id="change-6de283d19cc10a47807b4552070caa13"><strong>[feature] </strong></span>Added year, month, day, hour, minute, second variables to file_template.<a class="changeset-link reference internal" href="#change-6de283d19cc10a47807b4552070caa13">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/59/">#59</a></p> </p> </li> <li><p id="change-0.3.6-2"><span class="target" id="change-737f0410679d94c4cad4f92b609749f8"><strong>[feature] </strong></span>Added ‘primary’ to the list of constraint types recognized for MySQL drop_constraint().<a class="changeset-link reference internal" href="#change-737f0410679d94c4cad4f92b609749f8">(link)</a><p></p> </p> </li> <li><p id="change-0.3.6-3"><span class="target" id="change-d27d93f703a189a7bd6c071b523851c5"><strong>[feature] </strong></span>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.<a class="changeset-link reference internal" href="#change-d27d93f703a189a7bd6c071b523851c5">(link)</a><p></p> </p> </li> <li><p id="change-0.3.6-4"><span class="target" id="change-a15bf06ad8a0cd56f827eff690619dfd"><strong>[bug] </strong></span>Repaired create_foreign_key() for self-referential foreign keys, which weren’t working at all.<a class="changeset-link reference internal" href="#change-a15bf06ad8a0cd56f827eff690619dfd">(link)</a><p></p> </p> </li> <li><p id="change-0.3.6-5"><span class="target" id="change-058401218a17438021148daa33bc73f7"><strong>[bug] </strong></span>‘alembic’ command reports an informative error message when the configuration is missing the ‘script_directory’ key.<a class="changeset-link reference internal" href="#change-058401218a17438021148daa33bc73f7">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/63/">#63</a></p> </p> </li> <li><p id="change-0.3.6-6"><span class="target" id="change-49004a76d6a8a8b7f8c646c698b2c19d"><strong>[bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-49004a76d6a8a8b7f8c646c698b2c19d">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/62/">#62</a></p> </p> </li> <li><p id="change-0.3.6-7"><span class="target" id="change-e540eff26b145a5d8c45be05c33f7ab5"><strong>[bug] </strong></span>Improved error message when specifiying non-ordered revision identifiers to cover the case when the “higher” rev is None, improved message overall.<a class="changeset-link reference internal" href="#change-e540eff26b145a5d8c45be05c33f7ab5">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/66/">#66</a></p> </p> </li> </ul> </div> <div class="section" id="change-0.3.5"> <h2>0.3.5<a class="headerlink" href="#change-0.3.5" title="Permalink to this headline">¶</a></h2> Released: Sun Jul 08 2012<ul class="simple"> <li><p id="change-0.3.5-0"><span class="target" id="change-cb1aa380e3665dc47c5b1c62ce19fecc"><strong>[bug] </strong></span>Fixed issue whereby reflected server defaults wouldn’t be quoted correctly; uses repr() now.<a class="changeset-link reference internal" href="#change-cb1aa380e3665dc47c5b1c62ce19fecc">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/31/">#31</a></p> </p> </li> <li><p id="change-0.3.5-1"><span class="target" id="change-e16f2cfd80e6e87decab07eda670d92d"><strong>[bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-e16f2cfd80e6e87decab07eda670d92d">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/58/">#58</a></p> </p> </li> <li><p id="change-0.3.5-2"><span class="target" id="change-18962033c1a8d57fcfafa9242f9f6753"><strong>[feature] </strong></span>Implemented SQL rendering for CheckConstraint() within autogenerate upgrade, including for literal SQL as well as SQL Expression Language expressions.<a class="changeset-link reference internal" href="#change-18962033c1a8d57fcfafa9242f9f6753">(link)</a><p></p> </p> </li> </ul> </div> <div class="section" id="change-0.3.4"> <h2>0.3.4<a class="headerlink" href="#change-0.3.4" title="Permalink to this headline">¶</a></h2> Released: Sat Jun 02 2012<ul class="simple"> <li><p id="change-0.3.4-0"><span class="target" id="change-b16fb95f05e60c4389b1a18f4315fc09"><strong>[bug] </strong></span>Fixed command-line bug introduced by the “revision_environment” feature.<a class="changeset-link reference internal" href="#change-b16fb95f05e60c4389b1a18f4315fc09">(link)</a><p></p> </p> </li> </ul> </div> <div class="section" id="change-0.3.3"> <h2>0.3.3<a class="headerlink" href="#change-0.3.3" title="Permalink to this headline">¶</a></h2> Released: Sat Jun 02 2012<ul class="simple"> <li><p id="change-0.3.3-0"><span class="target" id="change-afe925da998e963f24f548d0d2055e78"><strong>[feature] </strong></span>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”.<a class="changeset-link reference internal" href="#change-afe925da998e963f24f548d0d2055e78">(link)</a><p></p> </p> </li> <li><p id="change-0.3.3-1"><span class="target" id="change-b2926a492749d173ca699b0c51eeb7f4"><strong>[feature] </strong></span>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”.<a class="changeset-link reference internal" href="#change-b2926a492749d173ca699b0c51eeb7f4">(link)</a><p></p> </p> </li> <li><p id="change-0.3.3-2"><span class="target" id="change-9807ade69f5109f49c4786e7db7068c0"><strong>[bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-9807ade69f5109f49c4786e7db7068c0">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/44/">#44</a></p> </p> </li> <li><p id="change-0.3.3-3"><span class="target" id="change-56d4a3bf14e60601a11d00428cda5285"><strong>[feature] </strong></span>Added version_table argument to EnvironmentContext.configure(), allowing for the configuration of the version table name.<a class="changeset-link reference internal" href="#change-56d4a3bf14e60601a11d00428cda5285">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/34/">#34</a></p> </p> </li> <li><p id="change-0.3.3-4"><span class="target" id="change-3c8e33d81a940bad9cc98e4e606fd3d8"><strong>[feature] </strong></span>Added support for “relative” migration identifiers, i.e. “alembic upgrade +2”, “alembic downgrade -1”. Courtesy Atsushi Odagiri for this feature.<a class="changeset-link reference internal" href="#change-3c8e33d81a940bad9cc98e4e606fd3d8">(link)</a><p></p> </p> </li> <li><p id="change-0.3.3-5"><span class="target" id="change-0989706a0bfeac95d3c13407ab1ecb92"><strong>[bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-0989706a0bfeac95d3c13407ab1ecb92">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/49/">#49</a></p> </p> </li> </ul> </div> <div class="section" id="change-0.3.2"> <h2>0.3.2<a class="headerlink" href="#change-0.3.2" title="Permalink to this headline">¶</a></h2> Released: Mon Apr 30 2012<ul class="simple"> <li><p id="change-0.3.2-0"><strong>[feature] </strong>Basic support for Oracle added, courtesy shgoh.<p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/40/">#40</a></p> </p> </li> <li><p id="change-0.3.2-1"><span class="target" id="change-4e5e84fd5774b3752e48d58d00ad7283"><strong>[feature] </strong></span>Added support for UniqueConstraint in autogenerate, courtesy Atsushi Odagiri<a class="changeset-link reference internal" href="#change-4e5e84fd5774b3752e48d58d00ad7283">(link)</a><p></p> </p> </li> <li><p id="change-0.3.2-2"><span class="target" id="change-c11c909210774655ce2b4a1f8ba2db1d"><strong>[bug] </strong></span>Fixed support of schema-qualified ForeignKey target in column alter operations, courtesy Alexander Kolov.<a class="changeset-link reference internal" href="#change-c11c909210774655ce2b4a1f8ba2db1d">(link)</a><p></p> </p> </li> <li><p id="change-0.3.2-3"><span class="target" id="change-2fd7c1f140b5c1b6fcac3d28e7e18778"><strong>[bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-2fd7c1f140b5c1b6fcac3d28e7e18778">(link)</a><p></p> </p> </li> </ul> </div> <div class="section" id="change-0.3.1"> <h2>0.3.1<a class="headerlink" href="#change-0.3.1" title="Permalink to this headline">¶</a></h2> Released: Sat Apr 07 2012<ul class="simple"> <li><p id="change-0.3.1-0"><span class="target" id="change-c1c9dad7340090d0e02ae5a12eed7c89"><strong>[bug] </strong></span>bulk_insert() fixes:<blockquote> <div><ol class="arabic"> <li>bulk_insert() operation was not working most likely since the 0.2 series when used with an engine.</li> <li>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.</li> <li>bulk_insert() uses “inline=True” so that phrases like RETURNING and such don’t get invoked for single-row bulk inserts.</li> <li>bulk_insert() will check that you’re passing a list of dictionaries in, raises TypeError if not detected.</li> </ol> </div></blockquote> <a class="changeset-link reference internal" href="#change-c1c9dad7340090d0e02ae5a12eed7c89">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/41/">#41</a></p> </p> </li> </ul> </div> <div class="section" id="change-0.3.0"> <h2>0.3.0<a class="headerlink" href="#change-0.3.0" title="Permalink to this headline">¶</a></h2> Released: Thu Apr 05 2012<ul class="simple"> <li><p id="change-0.3.0-0"><span class="target" id="change-fe4347d814e4a1c5e348a0f5b74693da"><strong>[general] </strong></span>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:<blockquote> <div>MigrationContext.get_current_revision() ScriptDirectory.iterate_revisions() ScriptDirectory.get_current_head() ScriptDirectory.get_heads() ScriptDirectory.get_base() ScriptDirectory.generate_revision()</div></blockquote> <a class="changeset-link reference internal" href="#change-fe4347d814e4a1c5e348a0f5b74693da">(link)</a><p></p> </p> </li> <li><p id="change-0.3.0-1"><span class="target" id="change-8627c89ba508deb4d6a27f0870bb0926"><strong>[feature] </strong></span>Added a bit of autogenerate to the public API in the form of the function alembic.autogenerate.compare_metadata.<a class="changeset-link reference internal" href="#change-8627c89ba508deb4d6a27f0870bb0926">(link)</a><p></p> </p> </li> </ul> </div> <div class="section" id="change-0.2.2"> <h2>0.2.2<a class="headerlink" href="#change-0.2.2" title="Permalink to this headline">¶</a></h2> Released: Mon Mar 12 2012<ul class="simple"> <li><p id="change-0.2.2-0"><span class="target" id="change-25f59a8123ff1e2bb44042930eae89b4"><strong>[feature] </strong></span>Informative error message when op.XYZ directives are invoked at module import time.<a class="changeset-link reference internal" href="#change-25f59a8123ff1e2bb44042930eae89b4">(link)</a><p></p> </p> </li> <li><p id="change-0.2.2-1"><span class="target" id="change-a62a15a28bf70f9fdfb3ff5ee3903cc5"><strong>[bug] </strong></span>Fixed inappropriate direct call to util.err() and therefore sys.exit() when Config failed to locate the config file within library usage.<a class="changeset-link reference internal" href="#change-a62a15a28bf70f9fdfb3ff5ee3903cc5">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/35/">#35</a></p> </p> </li> <li><p id="change-0.2.2-2"><span class="target" id="change-9211d1f25baba5912c562f61717d6864"><strong>[bug] </strong></span>Autogenerate will emit CREATE TABLE and DROP TABLE directives according to foreign key dependency order.<a class="changeset-link reference internal" href="#change-9211d1f25baba5912c562f61717d6864">(link)</a><p></p> </p> </li> <li><p id="change-0.2.2-3"><span class="target" id="change-6c45a5b581723eb645ed9a0a0dd46add"><strong>[bug] </strong></span>implement ‘tablename’ parameter on drop_index() as this is needed by some backends.<a class="changeset-link reference internal" href="#change-6c45a5b581723eb645ed9a0a0dd46add">(link)</a><p></p> </p> </li> <li><p id="change-0.2.2-4"><span class="target" id="change-d9773acc4303a5e1a300eb6c15ab33be"><strong>[feature] </strong></span>Added execution_options parameter to op.execute(), will call execution_options() on the Connection before executing.<p>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.</p> <a class="changeset-link reference internal" href="#change-d9773acc4303a5e1a300eb6c15ab33be">(link)</a><p></p> </p> </li> <li><p id="change-0.2.2-5"><span class="target" id="change-d27feac94d918cdd6f8f4158d1ee5a30"><strong>[bug] </strong></span>setup.py won’t install argparse if on Python 2.7/3.2<a class="changeset-link reference internal" href="#change-d27feac94d918cdd6f8f4158d1ee5a30">(link)</a><p></p> </p> </li> <li><p id="change-0.2.2-6"><span class="target" id="change-871bf20cf92b016ea8671097e535c81f"><strong>[feature] </strong></span>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.<a class="changeset-link reference internal" href="#change-871bf20cf92b016ea8671097e535c81f">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/29/">#29</a></p> </p> </li> <li><p id="change-0.2.2-7"><span class="target" id="change-4c0b58dbf3b3839038c9739192343507"><strong>[feature] </strong></span>added missing support for onupdate/ondelete flags for ForeignKeyConstraint, courtesy Giacomo Bagnoli<a class="changeset-link reference internal" href="#change-4c0b58dbf3b3839038c9739192343507">(link)</a><p></p> </p> </li> <li><p id="change-0.2.2-8"><span class="target" id="change-cd93628a5cb555644afb4d1cadda1219"><strong>[bug] </strong></span>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<a class="changeset-link reference internal" href="#change-cd93628a5cb555644afb4d1cadda1219">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/30/">#30</a></p> </p> </li> <li><p id="change-0.2.2-9"><span class="target" id="change-b60ba15ccd6dff212392595aad6b0c46"><strong>[bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-b60ba15ccd6dff212392595aad6b0c46">(link)</a><p></p> </p> </li> </ul> </div> <div class="section" id="change-0.2.1"> <h2>0.2.1<a class="headerlink" href="#change-0.2.1" title="Permalink to this headline">¶</a></h2> Released: Tue Jan 31 2012<ul class="simple"> <li><p id="change-0.2.1-0"><span class="target" id="change-fd069f4e10b5b132ef8e996846a33752"><strong>[bug] </strong></span>Fixed the generation of CHECK constraint, regression from 0.2.0<a class="changeset-link reference internal" href="#change-fd069f4e10b5b132ef8e996846a33752">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/26/">#26</a></p> </p> </li> </ul> </div> <div class="section" id="change-0.2.0"> <h2>0.2.0<a class="headerlink" href="#change-0.2.0" title="Permalink to this headline">¶</a></h2> Released: Mon Jan 30 2012<ul class="simple"> <li><p id="change-0.2.0-0"><span class="target" id="change-ad7f1027b57e6a1613465ac609d1f55f"><strong>[feature] </strong></span>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.<a class="changeset-link reference internal" href="#change-ad7f1027b57e6a1613465ac609d1f55f">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/19/">#19</a></p> </p> </li> <li><p id="change-0.2.0-1"><span class="target" id="change-94e47c3bb10f4bfc6c0e484b58f7948d"><strong>[feature] </strong></span>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.<a class="changeset-link reference internal" href="#change-94e47c3bb10f4bfc6c0e484b58f7948d">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/24/">#24</a></p> </p> </li> <li><p id="change-0.2.0-2"><span class="target" id="change-64d5ec6418f7c0126199dfc02aa733f9"><strong>[bug] </strong></span>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.<a class="changeset-link reference internal" href="#change-64d5ec6418f7c0126199dfc02aa733f9">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/25/">#25</a></p> </p> </li> <li><p id="change-0.2.0-3"><span class="target" id="change-e0d56eb1424aeb9d20d628b042bf44f6"><strong>[bug] </strong></span>fix the config.main() function to honor the arguments passed, remove no longer used “scripts/alembic” as setuptools creates this for us.<a class="changeset-link reference internal" href="#change-e0d56eb1424aeb9d20d628b042bf44f6">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/22/">#22</a></p> </p> </li> <li><p id="change-0.2.0-4"><span class="target" id="change-c466a1eaa4210cfcb1804f043608559b"><strong>[bug] </strong></span>Fixed alteration of column type on MSSQL to not include the keyword “TYPE”.<a class="changeset-link reference internal" href="#change-c466a1eaa4210cfcb1804f043608559b">(link)</a><p></p> </p> </li> <li><p id="change-0.2.0-5"><span class="target" id="change-3cb02cf88ae5d36882c8335b305b0c6e"><strong>[feature] </strong></span>Can create alembic.config.Config with no filename, use set_main_option() to add values. Also added set_section_option() which will add sections.<a class="changeset-link reference internal" href="#change-3cb02cf88ae5d36882c8335b305b0c6e">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/23/">#23</a></p> </p> </li> </ul> </div> <div class="section" id="change-0.1.1"> <h2>0.1.1<a class="headerlink" href="#change-0.1.1" title="Permalink to this headline">¶</a></h2> Released: Wed Jan 04 2012<ul class="simple"> <li><p id="change-0.1.1-0"><span class="target" id="change-7b4f7ac474ebd82425dfb17a2cc355ce"><strong>[bug] </strong></span>Clean up file write operations so that file handles are closed.<a class="changeset-link reference internal" href="#change-7b4f7ac474ebd82425dfb17a2cc355ce">(link)</a><p></p> </p> </li> <li><p id="change-0.1.1-1"><strong>[feature] </strong>PyPy is supported.<p></p> </p> </li> <li><p id="change-0.1.1-2"><span class="target" id="change-5c8e56bf16b10f201954d022500c5549"><strong>[feature] </strong></span>Python 2.5 is supported, needs __future__.with_statement<a class="changeset-link reference internal" href="#change-5c8e56bf16b10f201954d022500c5549">(link)</a><p></p> </p> </li> <li><p id="change-0.1.1-3"><span class="target" id="change-80504e7c036a1de0d824596945e47120"><strong>[bug] </strong></span>Fix autogenerate so that “pass” is generated between the two comments if no net migrations were present.<a class="changeset-link reference internal" href="#change-80504e7c036a1de0d824596945e47120">(link)</a><p></p> </p> </li> <li><p id="change-0.1.1-4"><span class="target" id="change-c12521608a69d3ee77940eefeee06586"><strong>[bug] </strong></span>Fix autogenerate bug that prevented correct reflection of a foreign-key referenced table in the list of “to remove”.<a class="changeset-link reference internal" href="#change-c12521608a69d3ee77940eefeee06586">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/16/">#16</a></p> </p> </li> <li><p id="change-0.1.1-5"><span class="target" id="change-a251c23eefd892f2f47b8ef7d6dc277f"><strong>[bug] </strong></span>Fix bug where create_table() didn’t handle self-referential foreign key correctly<a class="changeset-link reference internal" href="#change-a251c23eefd892f2f47b8ef7d6dc277f">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/17/">#17</a></p> </p> </li> <li><p id="change-0.1.1-6"><span class="target" id="change-e866189612390f83a9f327e481d4092a"><strong>[bug] </strong></span>Default prefix for autogenerate directives is “op.”, matching the mako templates.<a class="changeset-link reference internal" href="#change-e866189612390f83a9f327e481d4092a">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/18/">#18</a></p> </p> </li> <li><p id="change-0.1.1-7"><span class="target" id="change-0446b920d0354906bd25c6e162923445"><strong>[feature] </strong></span>Add alembic_module_prefix argument to configure() to complement sqlalchemy_module_prefix.<a class="changeset-link reference internal" href="#change-0446b920d0354906bd25c6e162923445">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/18/">#18</a></p> </p> </li> <li><p id="change-0.1.1-8"><span class="target" id="change-b98b71e5f9df24d82ad9024805784138"><strong>[bug] </strong></span>fix quotes not being rendered in ForeignKeConstraint during autogenerate<a class="changeset-link reference internal" href="#change-b98b71e5f9df24d82ad9024805784138">(link)</a><p> <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issue/14/">#14</a></p> </p> </li> </ul> </div> <div class="section" id="change-0.1.0"> <h2>0.1.0<a class="headerlink" href="#change-0.1.0" title="Permalink to this headline">¶</a></h2> Released: Wed Nov 30 2011<ul class="simple"> <li><p id="change-0.1.0-0">Initial release. Status of features:<p></p> </p> </li> <li><p id="change-0.1.0-1"><span class="target" id="change-06c55769f03b44611118d6f5e6e79de0"></span>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.<p>The author asks that you <em>please</em> report all issues, missing features, workarounds etc. to the bugtracker, at <a class="reference external" href="https://bitbucket.org/zzzeek/alembic/issues/new">https://bitbucket.org/zzzeek/alembic/issues/new</a> .</p> <a class="changeset-link reference internal" href="#change-06c55769f03b44611118d6f5e6e79de0">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-2">Python 3 is supported and has been tested.<p></p> </p> </li> <li><p id="change-0.1.0-3"><span class="target" id="change-ee8d4bac242a4448302ed2bcd5720453"></span>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.<a class="changeset-link reference internal" href="#change-ee8d4bac242a4448302ed2bcd5720453">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-4"><span class="target" id="change-8018793bf563a351115e96a8fd572284"></span>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.<a class="changeset-link reference internal" href="#change-8018793bf563a351115e96a8fd572284">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-5"><span class="target" id="change-a8a2e5faf08dc32900bfc8de87c2ef94"></span>MySQL support has also been implemented to a basic degree, including MySQL’s awkward style of modifying columns being accommodated.<a class="changeset-link reference internal" href="#change-a8a2e5faf08dc32900bfc8de87c2ef94">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-6"><span class="target" id="change-c1bbbec57687a2b31cc4d1baabd0c73f"></span>Other database environments not included among those three have <em>not</em> been tested, <em>at all</em>. 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.<a class="changeset-link reference internal" href="#change-c1bbbec57687a2b31cc4d1baabd0c73f">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-7"><span class="target" id="change-6c099a09d049aaf27d9ef848a16f7436"></span>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 <a class="reference external" href="http://www.sqlite.org/src/wiki?name=Bug+Reports">http://www.sqlite.org/src/wiki?name=Bug+Reports</a>, 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.<a class="changeset-link reference internal" href="#change-6c099a09d049aaf27d9ef848a16f7436">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-8"><span class="target" id="change-28a29b62732a24486397a1fd91225065"></span>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 <em>not</em> been strongly tested in production, i.e. rename table, etc.<a class="changeset-link reference internal" href="#change-28a29b62732a24486397a1fd91225065">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-9"><span class="target" id="change-3946370989b199b017c0ddfea3d03ebe"></span>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.<a class="changeset-link reference internal" href="#change-3946370989b199b017c0ddfea3d03ebe">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-10"><span class="target" id="change-f92029c4aa81af6b310f4f011c301b83"></span>Modify column type, default status, nullable, is functional and tested across PG, MSSQL, MySQL, but not yet widely tested in production usage.<a class="changeset-link reference internal" href="#change-f92029c4aa81af6b310f4f011c301b83">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-11"><span class="target" id="change-dbc16777f11863d47562988f84044860"></span>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.<a class="changeset-link reference internal" href="#change-dbc16777f11863d47562988f84044860">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-12"><span class="target" id="change-a3836cae7a69e2ca210c9acc730e0820"></span>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.<p>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.</p> <a class="changeset-link reference internal" href="#change-a3836cae7a69e2ca210c9acc730e0820">(link)</a><p></p> </p> </li> <li><p id="change-0.1.0-13"><span class="target" id="change-2a8ad4eca39b4c4825181b3ba362a9d7"></span>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.<a class="changeset-link reference internal" href="#change-2a8ad4eca39b4c4825181b3ba362a9d7">(link)</a><p></p> </p> </li> </ul> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Changelog</a><ul> <li><a class="reference internal" href="#change-0.4.2">0.4.2</a></li> <li><a class="reference internal" href="#change-0.4.1">0.4.1</a></li> <li><a class="reference internal" href="#change-0.4.0">0.4.0</a></li> <li><a class="reference internal" href="#change-0.3.6">0.3.6</a></li> <li><a class="reference internal" href="#change-0.3.5">0.3.5</a></li> <li><a class="reference internal" href="#change-0.3.4">0.3.4</a></li> <li><a class="reference internal" href="#change-0.3.3">0.3.3</a></li> <li><a class="reference internal" href="#change-0.3.2">0.3.2</a></li> <li><a class="reference internal" href="#change-0.3.1">0.3.1</a></li> <li><a class="reference internal" href="#change-0.3.0">0.3.0</a></li> <li><a class="reference internal" href="#change-0.2.2">0.2.2</a></li> <li><a class="reference internal" href="#change-0.2.1">0.2.1</a></li> <li><a class="reference internal" href="#change-0.2.0">0.2.0</a></li> <li><a class="reference internal" href="#change-0.1.1">0.1.1</a></li> <li><a class="reference internal" href="#change-0.1.0">0.1.0</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="api.html" title="previous chapter">API Details</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/changelog.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="api.html" title="API Details" >previous</a> |</li> <li><a href="index.html">Alembic 0.4.2 documentation</a> »</li> </ul> </div> <div class="footer"> © Copyright 2010-2013, Mike Bayer. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>