ok
Mini Shell
<!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>Operation Directives — Alembic 0.8.3 documentation</title>
<link rel="stylesheet" href="../_static/nature_override.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/changelog.css" type="text/css" />
<link rel="stylesheet" href="../_static/sphinx_paramlinks.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.8.3',
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.8.3 documentation" href="../index.html" />
<link rel="up" title="API Details" href="index.html" />
<link rel="next" title="Autogeneration" href="autogenerate.html" />
<link rel="prev" title="Commands" href="commands.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<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="autogenerate.html" title="Autogeneration"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="commands.html" title="Commands"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Alembic 0.8.3 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Details</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="operation-directives">
<span id="alembic-operations-toplevel"></span><h1>Operation Directives<a class="headerlink" href="#operation-directives" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">this section discusses the <strong>internal API of Alembic</strong> as regards
the internal system of defining migration operation directives.
This section is only useful for developers who wish to extend the
capabilities of Alembic. For end-user guidance on Alembic migration
operations, please see <a class="reference internal" href="../ops.html#ops"><span>Operation Reference</span></a>.</p>
</div>
<p>Within migration scripts, actual database migration operations are handled
via an instance of <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a>. The <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class
lists out available migration operations that are linked to a
<a class="reference internal" href="runtime.html#alembic.runtime.migration.MigrationContext" title="alembic.runtime.migration.MigrationContext"><code class="xref py py-class docutils literal"><span class="pre">MigrationContext</span></code></a>, which communicates instructions originated
by the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> object into SQL that is sent to a database or SQL
output stream.</p>
<p>Most methods on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class are generated dynamically
using a “plugin” system, described in the next section
<a class="reference internal" href="#operation-plugins"><span>Operation Plugins</span></a>. Additionally, when Alembic migration scripts
actually run, the methods on the current <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> object are
proxied out to the <code class="docutils literal"><span class="pre">alembic.op</span></code> module, so that they are available
using module-style access.</p>
<p>For an overview of how to use an <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> object directly
in programs, as well as for reference to the standard operation methods
as well as “batch” methods, see <a class="reference internal" href="../ops.html#ops"><span>Operation Reference</span></a>.</p>
<div class="section" id="operation-plugins">
<span id="id1"></span><h2>Operation Plugins<a class="headerlink" href="#operation-plugins" title="Permalink to this headline">¶</a></h2>
<p>The Operations object is extensible using a plugin system. This system
allows one to add new <code class="docutils literal"><span class="pre">op.<some_operation></span></code> methods at runtime. The
steps to use this system are to first create a subclass of
<a class="reference internal" href="../ops.html#alembic.operations.MigrateOperation" title="alembic.operations.MigrateOperation"><code class="xref py py-class docutils literal"><span class="pre">MigrateOperation</span></code></a>, register it using the <a class="reference internal" href="../ops.html#alembic.operations.Operations.register_operation" title="alembic.operations.Operations.register_operation"><code class="xref py py-meth docutils literal"><span class="pre">Operations.register_operation()</span></code></a>
class decorator, then build a default “implementation” function which is
established using the <a class="reference internal" href="../ops.html#alembic.operations.Operations.implementation_for" title="alembic.operations.Operations.implementation_for"><code class="xref py py-meth docutils literal"><span class="pre">Operations.implementation_for()</span></code></a> decorator.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.8.0: </span>- the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class is now an
open namespace that is extensible via the creation of new
<a class="reference internal" href="../ops.html#alembic.operations.MigrateOperation" title="alembic.operations.MigrateOperation"><code class="xref py py-class docutils literal"><span class="pre">MigrateOperation</span></code></a> subclasses.</p>
</div>
<p>Below we illustrate a very simple operation <code class="docutils literal"><span class="pre">CreateSequenceOp</span></code> which
will implement a new method <code class="docutils literal"><span class="pre">op.create_sequence()</span></code> for use in
migration scripts:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">alembic.operations</span> <span class="kn">import</span> <span class="n">Operations</span><span class="p">,</span> <span class="n">MigrateOperation</span>
<span class="nd">@Operations.register_operation</span><span class="p">(</span><span class="s">"create_sequence"</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">CreateSequenceOp</span><span class="p">(</span><span class="n">MigrateOperation</span><span class="p">):</span>
<span class="sd">"""Create a SEQUENCE."""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sequence_name</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sequence_name</span> <span class="o">=</span> <span class="n">sequence_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="n">schema</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">create_sequence</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">operations</span><span class="p">,</span> <span class="n">sequence_name</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="sd">"""Issue a "CREATE SEQUENCE" instruction."""</span>
<span class="n">op</span> <span class="o">=</span> <span class="n">CreateSequenceOp</span><span class="p">(</span><span class="n">sequence_name</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
<span class="k">return</span> <span class="n">operations</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span><span class="n">op</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">reverse</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c"># only needed to support autogenerate</span>
<span class="k">return</span> <span class="n">DropSequenceOp</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sequence_name</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">schema</span><span class="p">)</span>
<span class="nd">@Operations.register_operation</span><span class="p">(</span><span class="s">"drop_sequence"</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">DropSequenceOp</span><span class="p">(</span><span class="n">MigrateOperation</span><span class="p">):</span>
<span class="sd">"""Drop a SEQUENCE."""</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sequence_name</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sequence_name</span> <span class="o">=</span> <span class="n">sequence_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="n">schema</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">drop_sequence</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">operations</span><span class="p">,</span> <span class="n">sequence_name</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="sd">"""Issue a "DROP SEQUENCE" instruction."""</span>
<span class="n">op</span> <span class="o">=</span> <span class="n">DropSequenceOp</span><span class="p">(</span><span class="n">sequence_name</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
<span class="k">return</span> <span class="n">operations</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span><span class="n">op</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">reverse</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c"># only needed to support autogenerate</span>
<span class="k">return</span> <span class="n">CreateSequenceOp</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sequence_name</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">schema</span><span class="p">)</span>
</pre></div>
</div>
<p>Above, the <code class="docutils literal"><span class="pre">CreateSequenceOp</span></code> and <code class="docutils literal"><span class="pre">DropSequenceOp</span></code> classes represent
new operations that will
be available as <code class="docutils literal"><span class="pre">op.create_sequence()</span></code> and <code class="docutils literal"><span class="pre">op.drop_sequence()</span></code>.
The reason the operations
are represented as stateful classes is so that an operation and a specific
set of arguments can be represented generically; the state can then correspond
to different kinds of operations, such as invoking the instruction against
a database, or autogenerating Python code for the operation into a
script.</p>
<p>In order to establish the migrate-script behavior of the new operations,
we use the <a class="reference internal" href="../ops.html#alembic.operations.Operations.implementation_for" title="alembic.operations.Operations.implementation_for"><code class="xref py py-meth docutils literal"><span class="pre">Operations.implementation_for()</span></code></a> decorator:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="nd">@Operations.implementation_for</span><span class="p">(</span><span class="n">CreateSequenceOp</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">create_sequence</span><span class="p">(</span><span class="n">operations</span><span class="p">,</span> <span class="n">operation</span><span class="p">):</span>
<span class="k">if</span> <span class="n">operation</span><span class="o">.</span><span class="n">schema</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">.</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">operation</span><span class="o">.</span><span class="n">schema</span><span class="p">,</span> <span class="n">operation</span><span class="o">.</span><span class="n">sequence_name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">operation</span><span class="o">.</span><span class="n">sequence_name</span>
<span class="n">operations</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"CREATE SEQUENCE </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
<span class="nd">@Operations.implementation_for</span><span class="p">(</span><span class="n">DropSequenceOp</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">drop_sequence</span><span class="p">(</span><span class="n">operations</span><span class="p">,</span> <span class="n">operation</span><span class="p">):</span>
<span class="k">if</span> <span class="n">operation</span><span class="o">.</span><span class="n">schema</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">.</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">operation</span><span class="o">.</span><span class="n">schema</span><span class="p">,</span> <span class="n">operation</span><span class="o">.</span><span class="n">sequence_name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">operation</span><span class="o">.</span><span class="n">sequence_name</span>
<span class="n">operations</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"DROP SEQUENCE </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
</pre></div>
</div>
<p>Above, we use the simplest possible technique of invoking our DDL, which
is just to call <a class="reference internal" href="../ops.html#alembic.operations.Operations.execute" title="alembic.operations.Operations.execute"><code class="xref py py-meth docutils literal"><span class="pre">Operations.execute()</span></code></a> with literal SQL. If this is
all a custom operation needs, then this is fine. However, options for
more comprehensive support include building out a custom SQL construct,
as documented at <a class="reference external" href="http://www.sqlalchemy.org/docs/core/compiler.html#sqlalchemy-ext-compiler-toplevel" title="(in SQLAlchemy v1.0)"><span>Custom SQL Constructs and Compilation Extension</span></a>.</p>
<p>With the above two steps, a migration script can now use new methods
<code class="docutils literal"><span class="pre">op.create_sequence()</span></code> and <code class="docutils literal"><span class="pre">op.drop_sequence()</span></code> that will proxy to
our object as a classmethod:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">upgrade</span><span class="p">():</span>
<span class="n">op</span><span class="o">.</span><span class="n">create_sequence</span><span class="p">(</span><span class="s">"my_sequence"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">downgrade</span><span class="p">():</span>
<span class="n">op</span><span class="o">.</span><span class="n">drop_sequence</span><span class="p">(</span><span class="s">"my_sequence"</span><span class="p">)</span>
</pre></div>
</div>
<p>The registration of new operations only needs to occur in time for the
<code class="docutils literal"><span class="pre">env.py</span></code> script to invoke <a class="reference internal" href="runtime.html#alembic.runtime.migration.MigrationContext.run_migrations" title="alembic.runtime.migration.MigrationContext.run_migrations"><code class="xref py py-meth docutils literal"><span class="pre">MigrationContext.run_migrations()</span></code></a>;
within the module level of the <code class="docutils literal"><span class="pre">env.py</span></code> script is sufficient.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="autogenerate.html#autogen-custom-ops"><span>Autogenerating Custom Operation Directives</span></a> - how to add autogenerate support to
custom operations.</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.8: </span>- the migration operations available via the
<a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class as well as the <code class="docutils literal"><span class="pre">alembic.op</span></code> namespace
is now extensible using a plugin system.</p>
</div>
</div>
<div class="section" id="built-in-operation-objects">
<span id="operation-objects"></span><h2>Built-in Operation Objects<a class="headerlink" href="#built-in-operation-objects" title="Permalink to this headline">¶</a></h2>
<p>The migration operations present on <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> are themselves
delivered via operation objects that represent an operation and its
arguments. All operations descend from the <a class="reference internal" href="../ops.html#alembic.operations.MigrateOperation" title="alembic.operations.MigrateOperation"><code class="xref py py-class docutils literal"><span class="pre">MigrateOperation</span></code></a>
class, and are registered with the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class using
the <a class="reference internal" href="../ops.html#alembic.operations.Operations.register_operation" title="alembic.operations.Operations.register_operation"><code class="xref py py-meth docutils literal"><span class="pre">Operations.register_operation()</span></code></a> class decorator. The
<a class="reference internal" href="../ops.html#alembic.operations.MigrateOperation" title="alembic.operations.MigrateOperation"><code class="xref py py-class docutils literal"><span class="pre">MigrateOperation</span></code></a> objects also serve as the basis for how the
autogenerate system renders new migration scripts.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p><a class="reference internal" href="#operation-plugins"><span>Operation Plugins</span></a></p>
<p class="last"><a class="reference internal" href="autogenerate.html#customizing-revision"><span>Customizing Revision Generation</span></a></p>
</div>
<p>The built-in operation objects are listed below.</p>
<span class="target" id="module-alembic.operations.ops"><span id="alembic-operations-ops-toplevel"></span></span><dl class="class">
<dt id="alembic.operations.ops.AddColumnOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">AddColumnOp</code><span class="sig-paren">(</span><em>table_name</em>, <em>column</em>, <em>schema=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.AddColumnOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent an add column operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.AddColumnOp.add_column">
<em class="property">classmethod </em><code class="descname">add_column</code><span class="sig-paren">(</span><em>operations</em>, <em>table_name</em>, <em>column</em>, <em>schema=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.AddColumnOp.add_column" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.add_column" title="alembic.operations.Operations.add_column"><code class="xref py py-meth docutils literal"><span class="pre">Operations.add_column()</span></code></a> method.</p>
</dd></dl>
<dl class="classmethod">
<dt id="alembic.operations.ops.AddColumnOp.batch_add_column">
<em class="property">classmethod </em><code class="descname">batch_add_column</code><span class="sig-paren">(</span><em>operations</em>, <em>column</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.AddColumnOp.batch_add_column" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations" title="alembic.operations.BatchOperations"><code class="xref py py-class docutils literal"><span class="pre">BatchOperations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations.add_column" title="alembic.operations.BatchOperations.add_column"><code class="xref py py-meth docutils literal"><span class="pre">BatchOperations.add_column()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.AddConstraintOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">AddConstraintOp</code><a class="headerlink" href="#alembic.operations.ops.AddConstraintOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent an add constraint operation.</p>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.AlterColumnOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">AlterColumnOp</code><span class="sig-paren">(</span><em>table_name</em>, <em>column_name</em>, <em>schema=None</em>, <em>existing_type=None</em>, <em>existing_server_default=False</em>, <em>existing_nullable=None</em>, <em>modify_nullable=None</em>, <em>modify_server_default=False</em>, <em>modify_name=None</em>, <em>modify_type=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.AlterColumnOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent an alter column operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.AlterColumnOp.alter_column">
<em class="property">classmethod </em><code class="descname">alter_column</code><span class="sig-paren">(</span><em>operations</em>, <em>table_name</em>, <em>column_name</em>, <em>nullable=None</em>, <em>server_default=False</em>, <em>new_column_name=None</em>, <em>type_=None</em>, <em>existing_type=None</em>, <em>existing_server_default=False</em>, <em>existing_nullable=None</em>, <em>schema=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.AlterColumnOp.alter_column" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.alter_column" title="alembic.operations.Operations.alter_column"><code class="xref py py-meth docutils literal"><span class="pre">Operations.alter_column()</span></code></a> method.</p>
</dd></dl>
<dl class="classmethod">
<dt id="alembic.operations.ops.AlterColumnOp.batch_alter_column">
<em class="property">classmethod </em><code class="descname">batch_alter_column</code><span class="sig-paren">(</span><em>operations</em>, <em>column_name</em>, <em>nullable=None</em>, <em>server_default=False</em>, <em>new_column_name=None</em>, <em>type_=None</em>, <em>existing_type=None</em>, <em>existing_server_default=False</em>, <em>existing_nullable=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.AlterColumnOp.batch_alter_column" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations" title="alembic.operations.BatchOperations"><code class="xref py py-class docutils literal"><span class="pre">BatchOperations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations.alter_column" title="alembic.operations.BatchOperations.alter_column"><code class="xref py py-meth docutils literal"><span class="pre">BatchOperations.alter_column()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.AlterTableOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">AlterTableOp</code><span class="sig-paren">(</span><em>table_name</em>, <em>schema=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.AlterTableOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent an alter table operation.</p>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.BulkInsertOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">BulkInsertOp</code><span class="sig-paren">(</span><em>table</em>, <em>rows</em>, <em>multiinsert=True</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.BulkInsertOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a bulk insert operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.BulkInsertOp.bulk_insert">
<em class="property">classmethod </em><code class="descname">bulk_insert</code><span class="sig-paren">(</span><em>operations</em>, <em>table</em>, <em>rows</em>, <em>multiinsert=True</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.BulkInsertOp.bulk_insert" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.bulk_insert" title="alembic.operations.Operations.bulk_insert"><code class="xref py py-meth docutils literal"><span class="pre">Operations.bulk_insert()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.CreateCheckConstraintOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">CreateCheckConstraintOp</code><span class="sig-paren">(</span><em>constraint_name</em>, <em>table_name</em>, <em>condition</em>, <em>schema=None</em>, <em>_orig_constraint=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateCheckConstraintOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a create check constraint operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreateCheckConstraintOp.batch_create_check_constraint">
<em class="property">classmethod </em><code class="descname">batch_create_check_constraint</code><span class="sig-paren">(</span><em>operations</em>, <em>constraint_name</em>, <em>condition</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateCheckConstraintOp.batch_create_check_constraint" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations" title="alembic.operations.BatchOperations"><code class="xref py py-class docutils literal"><span class="pre">BatchOperations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations.create_check_constraint" title="alembic.operations.BatchOperations.create_check_constraint"><code class="xref py py-meth docutils literal"><span class="pre">BatchOperations.create_check_constraint()</span></code></a> method.</p>
</dd></dl>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreateCheckConstraintOp.create_check_constraint">
<em class="property">classmethod </em><code class="descname">create_check_constraint</code><span class="sig-paren">(</span><em>operations</em>, <em>constraint_name</em>, <em>table_name</em>, <em>condition</em>, <em>schema=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateCheckConstraintOp.create_check_constraint" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.create_check_constraint" title="alembic.operations.Operations.create_check_constraint"><code class="xref py py-meth docutils literal"><span class="pre">Operations.create_check_constraint()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.CreateForeignKeyOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">CreateForeignKeyOp</code><span class="sig-paren">(</span><em>constraint_name</em>, <em>source_table</em>, <em>referent_table</em>, <em>local_cols</em>, <em>remote_cols</em>, <em>_orig_constraint=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateForeignKeyOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a create foreign key constraint operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreateForeignKeyOp.batch_create_foreign_key">
<em class="property">classmethod </em><code class="descname">batch_create_foreign_key</code><span class="sig-paren">(</span><em>operations</em>, <em>constraint_name</em>, <em>referent_table</em>, <em>local_cols</em>, <em>remote_cols</em>, <em>referent_schema=None</em>, <em>onupdate=None</em>, <em>ondelete=None</em>, <em>deferrable=None</em>, <em>initially=None</em>, <em>match=None</em>, <em>**dialect_kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateForeignKeyOp.batch_create_foreign_key" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations" title="alembic.operations.BatchOperations"><code class="xref py py-class docutils literal"><span class="pre">BatchOperations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations.create_foreign_key" title="alembic.operations.BatchOperations.create_foreign_key"><code class="xref py py-meth docutils literal"><span class="pre">BatchOperations.create_foreign_key()</span></code></a> method.</p>
</dd></dl>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreateForeignKeyOp.create_foreign_key">
<em class="property">classmethod </em><code class="descname">create_foreign_key</code><span class="sig-paren">(</span><em>operations</em>, <em>constraint_name</em>, <em>source_table</em>, <em>referent_table</em>, <em>local_cols</em>, <em>remote_cols</em>, <em>onupdate=None</em>, <em>ondelete=None</em>, <em>deferrable=None</em>, <em>initially=None</em>, <em>match=None</em>, <em>source_schema=None</em>, <em>referent_schema=None</em>, <em>**dialect_kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateForeignKeyOp.create_foreign_key" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.create_foreign_key" title="alembic.operations.Operations.create_foreign_key"><code class="xref py py-meth docutils literal"><span class="pre">Operations.create_foreign_key()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.CreateIndexOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">CreateIndexOp</code><span class="sig-paren">(</span><em>index_name</em>, <em>table_name</em>, <em>columns</em>, <em>schema=None</em>, <em>unique=False</em>, <em>_orig_index=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateIndexOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a create index operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreateIndexOp.batch_create_index">
<em class="property">classmethod </em><code class="descname">batch_create_index</code><span class="sig-paren">(</span><em>operations</em>, <em>index_name</em>, <em>columns</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateIndexOp.batch_create_index" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations" title="alembic.operations.BatchOperations"><code class="xref py py-class docutils literal"><span class="pre">BatchOperations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations.create_index" title="alembic.operations.BatchOperations.create_index"><code class="xref py py-meth docutils literal"><span class="pre">BatchOperations.create_index()</span></code></a> method.</p>
</dd></dl>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreateIndexOp.create_index">
<em class="property">classmethod </em><code class="descname">create_index</code><span class="sig-paren">(</span><em>operations</em>, <em>index_name</em>, <em>table_name</em>, <em>columns</em>, <em>schema=None</em>, <em>unique=False</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateIndexOp.create_index" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.create_index" title="alembic.operations.Operations.create_index"><code class="xref py py-meth docutils literal"><span class="pre">Operations.create_index()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.CreatePrimaryKeyOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">CreatePrimaryKeyOp</code><span class="sig-paren">(</span><em>constraint_name</em>, <em>table_name</em>, <em>columns</em>, <em>schema=None</em>, <em>_orig_constraint=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreatePrimaryKeyOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a create primary key operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreatePrimaryKeyOp.batch_create_primary_key">
<em class="property">classmethod </em><code class="descname">batch_create_primary_key</code><span class="sig-paren">(</span><em>operations</em>, <em>constraint_name</em>, <em>columns</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreatePrimaryKeyOp.batch_create_primary_key" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations" title="alembic.operations.BatchOperations"><code class="xref py py-class docutils literal"><span class="pre">BatchOperations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations.create_primary_key" title="alembic.operations.BatchOperations.create_primary_key"><code class="xref py py-meth docutils literal"><span class="pre">BatchOperations.create_primary_key()</span></code></a> method.</p>
</dd></dl>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreatePrimaryKeyOp.create_primary_key">
<em class="property">classmethod </em><code class="descname">create_primary_key</code><span class="sig-paren">(</span><em>operations</em>, <em>constraint_name</em>, <em>table_name</em>, <em>columns</em>, <em>schema=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreatePrimaryKeyOp.create_primary_key" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.create_primary_key" title="alembic.operations.Operations.create_primary_key"><code class="xref py py-meth docutils literal"><span class="pre">Operations.create_primary_key()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.CreateTableOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">CreateTableOp</code><span class="sig-paren">(</span><em>table_name</em>, <em>columns</em>, <em>schema=None</em>, <em>_orig_table=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateTableOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a create table operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreateTableOp.create_table">
<em class="property">classmethod </em><code class="descname">create_table</code><span class="sig-paren">(</span><em>operations</em>, <em>table_name</em>, <em>*columns</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateTableOp.create_table" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.create_table" title="alembic.operations.Operations.create_table"><code class="xref py py-meth docutils literal"><span class="pre">Operations.create_table()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.CreateUniqueConstraintOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">CreateUniqueConstraintOp</code><span class="sig-paren">(</span><em>constraint_name</em>, <em>table_name</em>, <em>columns</em>, <em>schema=None</em>, <em>_orig_constraint=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateUniqueConstraintOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a create unique constraint operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreateUniqueConstraintOp.batch_create_unique_constraint">
<em class="property">classmethod </em><code class="descname">batch_create_unique_constraint</code><span class="sig-paren">(</span><em>operations</em>, <em>constraint_name</em>, <em>columns</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateUniqueConstraintOp.batch_create_unique_constraint" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations" title="alembic.operations.BatchOperations"><code class="xref py py-class docutils literal"><span class="pre">BatchOperations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations.create_unique_constraint" title="alembic.operations.BatchOperations.create_unique_constraint"><code class="xref py py-meth docutils literal"><span class="pre">BatchOperations.create_unique_constraint()</span></code></a> method.</p>
</dd></dl>
<dl class="classmethod">
<dt id="alembic.operations.ops.CreateUniqueConstraintOp.create_unique_constraint">
<em class="property">classmethod </em><code class="descname">create_unique_constraint</code><span class="sig-paren">(</span><em>operations</em>, <em>constraint_name</em>, <em>table_name</em>, <em>columns</em>, <em>schema=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.CreateUniqueConstraintOp.create_unique_constraint" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.create_unique_constraint" title="alembic.operations.Operations.create_unique_constraint"><code class="xref py py-meth docutils literal"><span class="pre">Operations.create_unique_constraint()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.DowngradeOps">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">DowngradeOps</code><span class="sig-paren">(</span><em>ops=()</em>, <em>downgrade_token='downgrades'</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DowngradeOps" title="Permalink to this definition">¶</a></dt>
<dd><p>contains a sequence of operations that would apply to the
‘downgrade’ stream of a script.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="autogenerate.html#customizing-revision"><span>Customizing Revision Generation</span></a></p>
</div>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.DropColumnOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">DropColumnOp</code><span class="sig-paren">(</span><em>table_name</em>, <em>column_name</em>, <em>schema=None</em>, <em>_orig_column=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropColumnOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a drop column operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.DropColumnOp.batch_drop_column">
<em class="property">classmethod </em><code class="descname">batch_drop_column</code><span class="sig-paren">(</span><em>operations</em>, <em>column_name</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropColumnOp.batch_drop_column" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations" title="alembic.operations.BatchOperations"><code class="xref py py-class docutils literal"><span class="pre">BatchOperations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations.drop_column" title="alembic.operations.BatchOperations.drop_column"><code class="xref py py-meth docutils literal"><span class="pre">BatchOperations.drop_column()</span></code></a> method.</p>
</dd></dl>
<dl class="classmethod">
<dt id="alembic.operations.ops.DropColumnOp.drop_column">
<em class="property">classmethod </em><code class="descname">drop_column</code><span class="sig-paren">(</span><em>operations</em>, <em>table_name</em>, <em>column_name</em>, <em>schema=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropColumnOp.drop_column" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.drop_column" title="alembic.operations.Operations.drop_column"><code class="xref py py-meth docutils literal"><span class="pre">Operations.drop_column()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.DropConstraintOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">DropConstraintOp</code><span class="sig-paren">(</span><em>constraint_name</em>, <em>table_name</em>, <em>type_=None</em>, <em>schema=None</em>, <em>_orig_constraint=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropConstraintOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a drop constraint operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.DropConstraintOp.batch_drop_constraint">
<em class="property">classmethod </em><code class="descname">batch_drop_constraint</code><span class="sig-paren">(</span><em>operations</em>, <em>constraint_name</em>, <em>type_=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropConstraintOp.batch_drop_constraint" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations" title="alembic.operations.BatchOperations"><code class="xref py py-class docutils literal"><span class="pre">BatchOperations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations.drop_constraint" title="alembic.operations.BatchOperations.drop_constraint"><code class="xref py py-meth docutils literal"><span class="pre">BatchOperations.drop_constraint()</span></code></a> method.</p>
</dd></dl>
<dl class="classmethod">
<dt id="alembic.operations.ops.DropConstraintOp.drop_constraint">
<em class="property">classmethod </em><code class="descname">drop_constraint</code><span class="sig-paren">(</span><em>operations</em>, <em>constraint_name</em>, <em>table_name</em>, <em>type_=None</em>, <em>schema=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropConstraintOp.drop_constraint" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.drop_constraint" title="alembic.operations.Operations.drop_constraint"><code class="xref py py-meth docutils literal"><span class="pre">Operations.drop_constraint()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.DropIndexOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">DropIndexOp</code><span class="sig-paren">(</span><em>index_name</em>, <em>table_name=None</em>, <em>schema=None</em>, <em>_orig_index=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropIndexOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a drop index operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.DropIndexOp.batch_drop_index">
<em class="property">classmethod </em><code class="descname">batch_drop_index</code><span class="sig-paren">(</span><em>operations</em>, <em>index_name</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropIndexOp.batch_drop_index" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations" title="alembic.operations.BatchOperations"><code class="xref py py-class docutils literal"><span class="pre">BatchOperations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.BatchOperations.drop_index" title="alembic.operations.BatchOperations.drop_index"><code class="xref py py-meth docutils literal"><span class="pre">BatchOperations.drop_index()</span></code></a> method.</p>
</dd></dl>
<dl class="classmethod">
<dt id="alembic.operations.ops.DropIndexOp.drop_index">
<em class="property">classmethod </em><code class="descname">drop_index</code><span class="sig-paren">(</span><em>operations</em>, <em>index_name</em>, <em>table_name=None</em>, <em>schema=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropIndexOp.drop_index" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.drop_index" title="alembic.operations.Operations.drop_index"><code class="xref py py-meth docutils literal"><span class="pre">Operations.drop_index()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.DropTableOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">DropTableOp</code><span class="sig-paren">(</span><em>table_name</em>, <em>schema=None</em>, <em>table_kw=None</em>, <em>_orig_table=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropTableOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a drop table operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.DropTableOp.drop_table">
<em class="property">classmethod </em><code class="descname">drop_table</code><span class="sig-paren">(</span><em>operations</em>, <em>table_name</em>, <em>schema=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.DropTableOp.drop_table" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.drop_table" title="alembic.operations.Operations.drop_table"><code class="xref py py-meth docutils literal"><span class="pre">Operations.drop_table()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.ExecuteSQLOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">ExecuteSQLOp</code><span class="sig-paren">(</span><em>sqltext</em>, <em>execution_options=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.ExecuteSQLOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent an execute SQL operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.ExecuteSQLOp.execute">
<em class="property">classmethod </em><code class="descname">execute</code><span class="sig-paren">(</span><em>operations</em>, <em>sqltext</em>, <em>execution_options=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.ExecuteSQLOp.execute" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.execute" title="alembic.operations.Operations.execute"><code class="xref py py-meth docutils literal"><span class="pre">Operations.execute()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.MigrateOperation">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">MigrateOperation</code><a class="headerlink" href="#alembic.operations.ops.MigrateOperation" title="Permalink to this definition">¶</a></dt>
<dd><p>base class for migration command and organization objects.</p>
<p>This system is part of the operation extensibility API.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.8.0.</span></p>
</div>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p><a class="reference internal" href="#operation-objects"><span>Built-in Operation Objects</span></a></p>
<p><a class="reference internal" href="#operation-plugins"><span>Operation Plugins</span></a></p>
<p class="last"><a class="reference internal" href="autogenerate.html#customizing-revision"><span>Customizing Revision Generation</span></a></p>
</div>
<dl class="attribute">
<dt id="alembic.operations.ops.MigrateOperation.info">
<code class="descname">info</code><a class="headerlink" href="#alembic.operations.ops.MigrateOperation.info" title="Permalink to this definition">¶</a></dt>
<dd><p>A dictionary that may be used to store arbitrary information
along with this <a class="reference internal" href="#alembic.operations.ops.MigrateOperation" title="alembic.operations.ops.MigrateOperation"><code class="xref py py-class docutils literal"><span class="pre">MigrateOperation</span></code></a> object.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.MigrationScript">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">MigrationScript</code><span class="sig-paren">(</span><em>rev_id</em>, <em>upgrade_ops</em>, <em>downgrade_ops</em>, <em>message=None</em>, <em>imports=set([])</em>, <em>head=None</em>, <em>splice=None</em>, <em>branch_label=None</em>, <em>version_path=None</em>, <em>depends_on=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.MigrationScript" title="Permalink to this definition">¶</a></dt>
<dd><p>represents a migration script.</p>
<p>E.g. when autogenerate encounters this object, this corresponds to the
production of an actual script file.</p>
<p>A normal <a class="reference internal" href="#alembic.operations.ops.MigrationScript" title="alembic.operations.ops.MigrationScript"><code class="xref py py-class docutils literal"><span class="pre">MigrationScript</span></code></a> object would contain a single
<a class="reference internal" href="#alembic.operations.ops.UpgradeOps" title="alembic.operations.ops.UpgradeOps"><code class="xref py py-class docutils literal"><span class="pre">UpgradeOps</span></code></a> and a single <a class="reference internal" href="#alembic.operations.ops.DowngradeOps" title="alembic.operations.ops.DowngradeOps"><code class="xref py py-class docutils literal"><span class="pre">DowngradeOps</span></code></a> directive.
These are accessible via the <code class="docutils literal"><span class="pre">.upgrade_ops</span></code> and <code class="docutils literal"><span class="pre">.downgrade_ops</span></code>
attributes.</p>
<p>In the case of an autogenerate operation that runs multiple times,
such as the multiple database example in the “multidb” template,
the <code class="docutils literal"><span class="pre">.upgrade_ops</span></code> and <code class="docutils literal"><span class="pre">.downgrade_ops</span></code> attributes are disabled,
and instead these objects should be accessed via the <code class="docutils literal"><span class="pre">.upgrade_ops_list</span></code>
and <code class="docutils literal"><span class="pre">.downgrade_ops_list</span></code> list-based attributes. These latter
attributes are always available at the very least as single-element lists.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 0.8.1: </span>the <code class="docutils literal"><span class="pre">.upgrade_ops</span></code> and <code class="docutils literal"><span class="pre">.downgrade_ops</span></code>
attributes should be accessed via the <code class="docutils literal"><span class="pre">.upgrade_ops_list</span></code>
and <code class="docutils literal"><span class="pre">.downgrade_ops_list</span></code> attributes if multiple autogenerate
passes proceed on the same <a class="reference internal" href="#alembic.operations.ops.MigrationScript" title="alembic.operations.ops.MigrationScript"><code class="xref py py-class docutils literal"><span class="pre">MigrationScript</span></code></a> object.</p>
</div>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="autogenerate.html#customizing-revision"><span>Customizing Revision Generation</span></a></p>
</div>
<dl class="attribute">
<dt id="alembic.operations.ops.MigrationScript.downgrade_ops">
<code class="descname">downgrade_ops</code><a class="headerlink" href="#alembic.operations.ops.MigrationScript.downgrade_ops" title="Permalink to this definition">¶</a></dt>
<dd><p>An instance of <a class="reference internal" href="#alembic.operations.ops.DowngradeOps" title="alembic.operations.ops.DowngradeOps"><code class="xref py py-class docutils literal"><span class="pre">DowngradeOps</span></code></a>.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#alembic.operations.ops.MigrationScript.downgrade_ops_list" title="alembic.operations.ops.MigrationScript.downgrade_ops_list"><code class="xref py py-attr docutils literal"><span class="pre">MigrationScript.downgrade_ops_list</span></code></a></p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="alembic.operations.ops.MigrationScript.downgrade_ops_list">
<code class="descname">downgrade_ops_list</code><a class="headerlink" href="#alembic.operations.ops.MigrationScript.downgrade_ops_list" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of <a class="reference internal" href="#alembic.operations.ops.DowngradeOps" title="alembic.operations.ops.DowngradeOps"><code class="xref py py-class docutils literal"><span class="pre">DowngradeOps</span></code></a> instances.</p>
<p>This is used in place of the <a class="reference internal" href="#alembic.operations.ops.MigrationScript.downgrade_ops" title="alembic.operations.ops.MigrationScript.downgrade_ops"><code class="xref py py-attr docutils literal"><span class="pre">MigrationScript.downgrade_ops</span></code></a>
attribute when dealing with a revision operation that does
multiple autogenerate passes.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.8.1.</span></p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="alembic.operations.ops.MigrationScript.upgrade_ops">
<code class="descname">upgrade_ops</code><a class="headerlink" href="#alembic.operations.ops.MigrationScript.upgrade_ops" title="Permalink to this definition">¶</a></dt>
<dd><p>An instance of <a class="reference internal" href="#alembic.operations.ops.UpgradeOps" title="alembic.operations.ops.UpgradeOps"><code class="xref py py-class docutils literal"><span class="pre">UpgradeOps</span></code></a>.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#alembic.operations.ops.MigrationScript.upgrade_ops_list" title="alembic.operations.ops.MigrationScript.upgrade_ops_list"><code class="xref py py-attr docutils literal"><span class="pre">MigrationScript.upgrade_ops_list</span></code></a></p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="alembic.operations.ops.MigrationScript.upgrade_ops_list">
<code class="descname">upgrade_ops_list</code><a class="headerlink" href="#alembic.operations.ops.MigrationScript.upgrade_ops_list" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of <a class="reference internal" href="#alembic.operations.ops.UpgradeOps" title="alembic.operations.ops.UpgradeOps"><code class="xref py py-class docutils literal"><span class="pre">UpgradeOps</span></code></a> instances.</p>
<p>This is used in place of the <a class="reference internal" href="#alembic.operations.ops.MigrationScript.upgrade_ops" title="alembic.operations.ops.MigrationScript.upgrade_ops"><code class="xref py py-attr docutils literal"><span class="pre">MigrationScript.upgrade_ops</span></code></a>
attribute when dealing with a revision operation that does
multiple autogenerate passes.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.8.1.</span></p>
</div>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.ModifyTableOps">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">ModifyTableOps</code><span class="sig-paren">(</span><em>table_name</em>, <em>ops</em>, <em>schema=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.ModifyTableOps" title="Permalink to this definition">¶</a></dt>
<dd><p>Contains a sequence of operations that all apply to a single Table.</p>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.OpContainer">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">OpContainer</code><span class="sig-paren">(</span><em>ops=()</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.OpContainer" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a sequence of operations operation.</p>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.RenameTableOp">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">RenameTableOp</code><span class="sig-paren">(</span><em>old_table_name</em>, <em>new_table_name</em>, <em>schema=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.RenameTableOp" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a rename table operation.</p>
<dl class="classmethod">
<dt id="alembic.operations.ops.RenameTableOp.rename_table">
<em class="property">classmethod </em><code class="descname">rename_table</code><span class="sig-paren">(</span><em>operations</em>, <em>old_table_name</em>, <em>new_table_name</em>, <em>schema=None</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.RenameTableOp.rename_table" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is proxied on the <a class="reference internal" href="../ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal"><span class="pre">Operations</span></code></a> class, via the <a class="reference internal" href="../ops.html#alembic.operations.Operations.rename_table" title="alembic.operations.Operations.rename_table"><code class="xref py py-meth docutils literal"><span class="pre">Operations.rename_table()</span></code></a> method.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="alembic.operations.ops.UpgradeOps">
<em class="property">class </em><code class="descclassname">alembic.operations.ops.</code><code class="descname">UpgradeOps</code><span class="sig-paren">(</span><em>ops=()</em>, <em>upgrade_token='upgrades'</em><span class="sig-paren">)</span><a class="headerlink" href="#alembic.operations.ops.UpgradeOps" title="Permalink to this definition">¶</a></dt>
<dd><p>contains a sequence of operations that would apply to the
‘upgrade’ stream of a script.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="autogenerate.html#customizing-revision"><span>Customizing Revision Generation</span></a></p>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Operation Directives</a><ul>
<li><a class="reference internal" href="#operation-plugins">Operation Plugins</a></li>
<li><a class="reference internal" href="#built-in-operation-objects">Built-in Operation Objects</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="commands.html"
title="previous chapter">Commands</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="autogenerate.html"
title="next chapter">Autogeneration</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/operations.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<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" role="navigation" aria-label="related navigation">
<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="autogenerate.html" title="Autogeneration"
>next</a> |</li>
<li class="right" >
<a href="commands.html" title="Commands"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Alembic 0.8.3 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >API Details</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2010-2015, Mike Bayer.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
</html>
Zerion Mini Shell 1.0