^^&&^^

Edit File: naming.html

<!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>The Importance of Naming Constraints &mdash; 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="next" title="Running “Batch” Migrations for SQLite and Other Databases" href="batch.html" />
 <link rel="prev" title="Generating SQL Scripts (a.k.a. “Offline Mode”)" href="offline.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="batch.html" title="Running “Batch” Migrations for SQLite and Other Databases"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="offline.html" title="Generating SQL Scripts (a.k.a. “Offline Mode”)"
 accesskey="P">previous</a> |</li>
 <li class="nav-item nav-item-0"><a href="index.html">Alembic 0.8.3 documentation</a> &raquo;</li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <div class="section" id="the-importance-of-naming-constraints">
<h1>The Importance of Naming Constraints<a class="headerlink" href="#the-importance-of-naming-constraints" title="Permalink to this headline">¶</a></h1>
An important topic worth mentioning is that of constraint naming conventions.
As we&#8217;ve proceeded here, we&#8217;ve talked about adding tables and columns, and
we&#8217;ve also hinted at lots of other operations listed in <a class="reference internal" href="ops.html#ops">Operation Reference</a> such as those
which support adding or dropping constraints like foreign keys and unique
constraints. The way these constraints are referred to in migration scripts
is by name, however these names by default are in most cases generated by
the relational database in use, when the constraint is created. For example,
if you emitted two CREATE TABLE statements like this on Postgresql:
<div class="highlight-python"><div class="highlight"><pre>test=&gt; CREATE TABLE user_account (id INTEGER PRIMARY KEY);
CREATE TABLE
test=&gt; CREATE TABLE user_order (
test(&gt; id INTEGER PRIMARY KEY,
test(&gt; user_account_id INTEGER REFERENCES user_account(id));
CREATE TABLE
</pre></div>
</div>
Suppose we wanted to DROP the REFERENCES that we just applied to the
<code class="docutils literal">user_order.user_account_id</code> column, how do we do that? At the prompt,
we&#8217;d use <code class="docutils literal">ALTER TABLE &lt;tablename&gt; DROP CONSTRAINT &lt;constraint_name&gt;</code>, or if
using Alembic we&#8217;d be using <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">Operations.drop_constraint()</code></a>. But both
of those functions need a name - what&#8217;s the name of this constraint?
It does have a name, which in this case we can figure out by looking at the
Postgresql catalog tables:
<div class="highlight-python"><div class="highlight"><pre>test=&gt; SELECT r.conname FROM
test-&gt; pg_catalog.pg_class c JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
test-&gt; JOIN pg_catalog.pg_constraint r ON c.oid = r.conrelid
test-&gt; WHERE c.relname=&#39;user_order&#39; AND r.contype = &#39;f&#39;
test-&gt; ;
 conname
---------------------------------
 user_order_user_account_id_fkey
(1 row)
</pre></div>
</div>
The name above is not something that Alembic or SQLAlchemy created;
<code class="docutils literal">user_order_user_account_id_fkey</code> is a naming scheme used internally by
Postgresql to name constraints that are otherwise not named.
This scheme doesn&#8217;t seem so complicated, and we might want to just use our
knowledge of it so that we know what name to use for our
<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">Operations.drop_constraint()</code></a> call. But is that a good idea? What
if for example we needed our code to run on Oracle as well. OK, certainly
Oracle uses this same scheme, right? Or if not, something similar. Let&#8217;s
check:
<div class="highlight-python"><div class="highlight"><pre>Oracle Database 10g Express Edition Release 10.2.0.1.0 - Production

SQL&gt; CREATE TABLE user_account (id INTEGER PRIMARY KEY);

Table created.

SQL&gt; CREATE TABLE user_order (
  2     id INTEGER PRIMARY KEY,
  3     user_account_id INTEGER REFERENCES user_account(id));

Table created.

SQL&gt; SELECT constraint_name FROM all_constraints WHERE
  2     table_name=&#39;USER_ORDER&#39; AND constraint_type in (&#39;R&#39;);

CONSTRAINT_NAME
-----------------------------------------------------
SYS_C0029334
</pre></div>
</div>
Oh, we can see that is.....much worse. Oracle&#8217;s names are entirely unpredictable
alphanumeric codes, and this will make being able to write migrations
quite tedious, as we&#8217;d need to look up all these names.
The solution to having to look up names is to make your own names. This is
an easy, though tedious thing to do manually. For example, to create our model
in SQLAlchemy ensuring we use names for foreign key constraints would look like:
<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import MetaData, Table, Column, Integer, ForeignKey

meta = MetaData()

user_account = Table(&#39;user_account&#39;, meta,
 Column(&#39;id&#39;, Integer, primary_key=True)
 )

user_order = Table(&#39;user_order&#39;, meta,
 Column(&#39;id&#39;, Integer, primary_key=True),
 Column(&#39;user_order_id&#39;, Integer,
 ForeignKey(&#39;user_account.id&#39;, name=&#39;fk_user_order_id&#39;))
 )
</pre></div>
</div>
Simple enough, though this has some disadvantages. The first is that it&#8217;s tedious;
we need to remember to use a name for every <a class="reference external" href="http://www.sqlalchemy.org/docs/core/constraints.html#sqlalchemy.schema.ForeignKey" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">ForeignKey</code></a> object,
not to mention every <a class="reference external" href="http://www.sqlalchemy.org/docs/core/constraints.html#sqlalchemy.schema.UniqueConstraint" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">UniqueConstraint</code></a>, <a class="reference external" href="http://www.sqlalchemy.org/docs/core/constraints.html#sqlalchemy.schema.CheckConstraint" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">CheckConstraint</code></a>,
<a class="reference external" href="http://www.sqlalchemy.org/docs/core/constraints.html#sqlalchemy.schema.Index" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">Index</code></a>, and maybe even <a class="reference external" href="http://www.sqlalchemy.org/docs/core/constraints.html#sqlalchemy.schema.PrimaryKeyConstraint" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">PrimaryKeyConstraint</code></a>
as well if we wish to be able to alter those too, and beyond all that, all the
names have to be globally unique. Even with all that effort, if we have a naming scheme in mind,
it&#8217;s easy to get it wrong when doing it manually each time.
What&#8217;s worse is that manually naming constraints (and indexes) gets even more
tedious in that we can no longer use convenience features such as the <code class="docutils literal">.unique=True</code>
or <code class="docutils literal">.index=True</code> flag on <a class="reference external" href="http://www.sqlalchemy.org/docs/core/metadata.html#sqlalchemy.schema.Column" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">Column</code></a>:
<div class="highlight-python"><div class="highlight"><pre>user_account = Table(&#39;user_account&#39;, meta,
 Column(&#39;id&#39;, Integer, primary_key=True),
 Column(&#39;name&#39;, String(50), unique=True)
 )
</pre></div>
</div>
Above, the <code class="docutils literal">unique=True</code> flag creates a <a class="reference external" href="http://www.sqlalchemy.org/docs/core/constraints.html#sqlalchemy.schema.UniqueConstraint" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">UniqueConstraint</code></a>, but again,
it&#8217;s not named. If we want to name it, manually we have to forego the usage
of <code class="docutils literal">unique=True</code> and type out the whole constraint:
<div class="highlight-python"><div class="highlight"><pre>user_account = Table(&#39;user_account&#39;, meta,
 Column(&#39;id&#39;, Integer, primary_key=True),
 Column(&#39;name&#39;, String(50)),
 UniqueConstraint(&#39;name&#39;, name=&#39;uq_user_account_name&#39;)
 )
</pre></div>
</div>
There&#8217;s a solution to all this naming work, which is to use an automated
naming convention. For some years, SQLAlchemy has encourgaged the use of
DDL Events in order to create naming schemes. The <a class="reference external" href="http://www.sqlalchemy.org/docs/core/events.html#sqlalchemy.events.DDLEvents.after_parent_attach" title="(in SQLAlchemy v1.0)"><code class="xref py py-meth docutils literal">after_parent_attach()</code></a>
event in particular is the best place to intercept when <a class="reference external" href="http://www.sqlalchemy.org/docs/core/constraints.html#sqlalchemy.schema.Constraint" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">Constraint</code></a>
and <a class="reference external" href="http://www.sqlalchemy.org/docs/core/constraints.html#sqlalchemy.schema.Index" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">Index</code></a> objects are being associated with a parent
<a class="reference external" href="http://www.sqlalchemy.org/docs/core/metadata.html#sqlalchemy.schema.Table" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">Table</code></a> object, and to assign a <code class="docutils literal">.name</code> to the constraint while making
use of the name of the table and associated columns.
But there is also a better way to go, which is to make use of a feature
new in SQLAlchemy 0.9.2 which makes use of the events behind the scenes known as
<code class="xref py py-paramref docutils literal">naming_convention</code>. Here, we can
create a new <a class="reference external" href="http://www.sqlalchemy.org/docs/core/metadata.html#sqlalchemy.schema.MetaData" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">MetaData</code></a> object while passing a dictionary referring
to a naming scheme:
<div class="highlight-python"><div class="highlight"><pre>convention = {
 &quot;ix&quot;: &#39;ix_%(column_0_label)s&#39;,
 &quot;uq&quot;: &quot;uq_%(table_name)s_%(column_0_name)s&quot;,
 &quot;ck&quot;: &quot;ck_%(table_name)s_%(constraint_name)s&quot;,
 &quot;fk&quot;: &quot;fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s&quot;,
 &quot;pk&quot;: &quot;pk_%(table_name)s&quot;
}

metadata = MetaData(naming_convention=convention)
</pre></div>
</div>
If we define our models using a <a class="reference external" href="http://www.sqlalchemy.org/docs/core/metadata.html#sqlalchemy.schema.MetaData" title="(in SQLAlchemy v1.0)"><code class="xref py py-class docutils literal">MetaData</code></a> as above, the given
naming convention dictionary will be used to provide names for all constraints
and indexes.
<div class="section" id="integration-of-naming-conventions-into-operations-autogenerate">
<h2>Integration of Naming Conventions into Operations, Autogenerate<a class="headerlink" href="#integration-of-naming-conventions-into-operations-autogenerate" title="Permalink to this headline">¶</a></h2>
As of Alembic 0.6.4, the naming convention feature is integrated into the
<a class="reference internal" href="ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal">Operations</code></a> object, so that the convention takes effect for any
constraint that is otherwise unnamed. The naming convention is passed to
<a class="reference internal" href="ops.html#alembic.operations.Operations" title="alembic.operations.Operations"><code class="xref py py-class docutils literal">Operations</code></a> using the <code class="xref py py-paramref docutils literal">MigrationsContext.configure.target_metadata</code>
parameter in <code class="docutils literal">env.py</code>, which is normally configured when autogenerate is
used:
<div class="highlight-python"><div class="highlight"><pre># in your application&#39;s model:

meta = MetaData(naming_convention={
 &quot;ix&quot;: &#39;ix_%(column_0_label)s&#39;,
 &quot;uq&quot;: &quot;uq_%(table_name)s_%(column_0_name)s&quot;,
 &quot;ck&quot;: &quot;ck_%(table_name)s_%(constraint_name)s&quot;,
 &quot;fk&quot;: &quot;fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s&quot;,
 &quot;pk&quot;: &quot;pk_%(table_name)s&quot;
 })

# .. in your Alembic env.py:

# add your model&#39;s MetaData object here
# for &#39;autogenerate&#39; support
from myapp import mymodel
target_metadata = mymodel.Base.metadata

# ...

def run_migrations_online():

# ...

context.configure(
 connection=connection,
 target_metadata=target_metadata
 )
</pre></div>
</div>
Above, when we render a directive like the following:
<div class="highlight-python"><div class="highlight"><pre>op.add_column(&#39;sometable&#39;, Column(&#39;q&#39;, Boolean(name=&#39;q_bool&#39;)))
</pre></div>
</div>
The Boolean type will render a CHECK constraint with the name
<code class="docutils literal">&quot;ck_sometable_q_bool&quot;</code>, assuming the backend in use does not support
native boolean types.
We can also use op directives with constraints and not give them a name
at all, if the naming convention doesn&#8217;t require one. The value of
<code class="docutils literal">None</code> will be converted into a name that follows the appopriate naming
conventions:
<div class="highlight-python"><div class="highlight"><pre>def upgrade():
 op.create_unique_constraint(None, &#39;some_table&#39;, &#39;x&#39;)
</pre></div>
</div>
When autogenerate renders constraints in a migration script, it renders them
typically with their completed name. If using at least Alembic 0.6.4 as well
as SQLAlchemy 0.9.4, these will be rendered with a special directive
<a class="reference internal" href="ops.html#alembic.operations.Operations.f" title="alembic.operations.Operations.f"><code class="xref py py-meth docutils literal">Operations.f()</code></a> which denotes that the string has already been
tokenized:
<div class="highlight-python"><div class="highlight"><pre>def upgrade():
 op.create_unique_constraint(op.f(&#39;uq_const_x&#39;), &#39;some_table&#39;, &#39;x&#39;)
</pre></div>
</div>
For more detail on the naming convention feature, see <a class="reference external" href="http://www.sqlalchemy.org/docs/core/constraints.html#constraint-naming-conventions" title="(in SQLAlchemy v1.0)">Configuring Constraint Naming Conventions</a>.
</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="#">The Importance of Naming Constraints</a><ul>
<li><a class="reference internal" href="#integration-of-naming-conventions-into-operations-autogenerate">Integration of Naming Conventions into Operations, Autogenerate</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="offline.html"
 title="previous chapter">Generating SQL Scripts (a.k.a. &#8220;Offline Mode&#8221;)</a>
 <h4>Next topic</h4>
 <a href="batch.html"
 title="next chapter">Running &#8220;Batch&#8221; Migrations for SQLite and Other Databases</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="_sources/naming.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>
 
 Enter search terms or a module, class or function name.
 
</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="batch.html" title="Running “Batch” Migrations for SQLite and Other Databases"
 >next</a> |</li>
 <li class="right" >
 <a href="offline.html" title="Generating SQL Scripts (a.k.a. “Offline Mode”)"
 >previous</a> |</li>
 <li class="nav-item nav-item-0"><a href="index.html">Alembic 0.8.3 documentation</a> &raquo;</li> 
 </ul>
 </div>
 <div class="footer" role="contentinfo">
 &copy; Copyright 2010-2015, Mike Bayer.
 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
 </div>
 </body>
</html>