<!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>One-to-one relationships — Django 1.4.20 documentation</title> <link rel="stylesheet" href="../../../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../../', VERSION: '1.4.20', 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="Django 1.4.20 documentation" href="../../../index.html" /> <link rel="up" title="Examples of model relationship API usage" href="index.html" /> <link rel="next" title="Handling HTTP requests" href="../../http/index.html" /> <link rel="prev" title="Many-to-one relationships" href="many_to_one.html" /> <script type="text/javascript" src="../../../templatebuiltins.js"></script> <script type="text/javascript"> (function($) { if (!django_template_builtins) { // templatebuiltins.js missing, do nothing. return; } $(document).ready(function() { // Hyperlink Django template tags and filters var base = "../../../ref/templates/builtins.html"; if (base == "#") { // Special case for builtins.html itself base = ""; } // Tags are keywords, class '.k' $("div.highlight\\-html\\+django span.k").each(function(i, elem) { var tagname = $(elem).text(); if ($.inArray(tagname, django_template_builtins.ttags) != -1) { var fragment = tagname.replace(/_/, '-'); $(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>"); } }); // Filters are functions, class '.nf' $("div.highlight\\-html\\+django span.nf").each(function(i, elem) { var filtername = $(elem).text(); if ($.inArray(filtername, django_template_builtins.tfilters) != -1) { var fragment = filtername.replace(/_/, '-'); $(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>"); } }); }); })(jQuery); </script> </head> <body> <div class="document"> <div id="custom-doc" class="yui-t6"> <div id="hd"> <h1><a href="../../../index.html">Django 1.4.20 documentation</a></h1> <div id="global-nav"> <a title="Home page" href="../../../index.html">Home</a> | <a title="Table of contents" href="../../../contents.html">Table of contents</a> | <a title="Global index" href="../../../genindex.html">Index</a> | <a title="Module index" href="../../../py-modindex.html">Modules</a> </div> <div class="nav"> « <a href="many_to_one.html" title="Many-to-one relationships">previous</a> | <a href="../../index.html" title="Using Django" accesskey="U">up</a> | <a href="../../http/index.html" title="Handling HTTP requests">next</a> »</div> </div> <div id="bd"> <div id="yui-main"> <div class="yui-b"> <div class="yui-g" id="topics-db-examples-one_to_one"> <div class="section" id="s-one-to-one-relationships"> <span id="one-to-one-relationships"></span><h1>One-to-one relationships<a class="headerlink" href="#one-to-one-relationships" title="Permalink to this headline">ΒΆ</a></h1> <p>To define a one-to-one relationship, use <a class="reference internal" href="../../../ref/models/fields.html#ref-onetoone"><em>OneToOneField</em></a>.</p> <p>In this example, a <tt class="docutils literal"><span class="pre">Place</span></tt> optionally can be a <tt class="docutils literal"><span class="pre">Restaurant</span></tt>:</p> <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">django.db</span> <span class="kn">import</span> <span class="n">models</span><span class="p">,</span> <span class="n">transaction</span><span class="p">,</span> <span class="n">IntegrityError</span> <span class="k">class</span> <span class="nc">Place</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span> <span class="n">name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">50</span><span class="p">)</span> <span class="n">address</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">80</span><span class="p">)</span> <span class="k">def</span> <span class="nf">__unicode__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">return</span> <span class="s">u"</span><span class="si">%s</span><span class="s"> the place"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="k">class</span> <span class="nc">Restaurant</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span> <span class="n">place</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">OneToOneField</span><span class="p">(</span><span class="n">Place</span><span class="p">,</span> <span class="n">primary_key</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> <span class="n">serves_hot_dogs</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">BooleanField</span><span class="p">()</span> <span class="n">serves_pizza</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">BooleanField</span><span class="p">()</span> <span class="k">def</span> <span class="nf">__unicode__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">return</span> <span class="s">u"</span><span class="si">%s</span><span class="s"> the restaurant"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">place</span><span class="o">.</span><span class="n">name</span> <span class="k">class</span> <span class="nc">Waiter</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span> <span class="n">restaurant</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ForeignKey</span><span class="p">(</span><span class="n">Restaurant</span><span class="p">)</span> <span class="n">name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">50</span><span class="p">)</span> <span class="k">def</span> <span class="nf">__unicode__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> <span class="k">return</span> <span class="s">u"</span><span class="si">%s</span><span class="s"> the waiter at </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">restaurant</span><span class="p">)</span> </pre></div> </div> <p>What follows are examples of operations that can be performed using the Python API facilities.</p> <p>Create a couple of Places:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">p1</span> <span class="o">=</span> <span class="n">Place</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'Demon Dogs'</span><span class="p">,</span> <span class="n">address</span><span class="o">=</span><span class="s">'944 W. Fullerton'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">p1</span><span class="o">.</span><span class="n">save</span><span class="p">()</span> <span class="gp">>>> </span><span class="n">p2</span> <span class="o">=</span> <span class="n">Place</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'Ace Hardware'</span><span class="p">,</span> <span class="n">address</span><span class="o">=</span><span class="s">'1013 N. Ashland'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">p2</span><span class="o">.</span><span class="n">save</span><span class="p">()</span> </pre></div> </div> <p>Create a Restaurant. Pass the ID of the “parent” object as this object’s ID:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">Restaurant</span><span class="p">(</span><span class="n">place</span><span class="o">=</span><span class="n">p1</span><span class="p">,</span> <span class="n">serves_hot_dogs</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">serves_pizza</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">save</span><span class="p">()</span> </pre></div> </div> <p>A Restaurant can access its place:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">place</span> <span class="go"><Place: Demon Dogs the place></span> </pre></div> </div> <p>A Place can access its restaurant, if available:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">p1</span><span class="o">.</span><span class="n">restaurant</span> <span class="go"><Restaurant: Demon Dogs the restaurant></span> </pre></div> </div> <p>p2 doesn’t have an associated restaurant:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">p2</span><span class="o">.</span><span class="n">restaurant</span> <span class="gt">Traceback (most recent call last):</span> <span class="o">...</span> <span class="gr">DoesNotExist</span>: <span class="n">Restaurant matching query does not exist.</span> </pre></div> </div> <p>Set the place using assignment notation. Because place is the primary key on Restaurant, the save will create a new restaurant:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">place</span> <span class="o">=</span> <span class="n">p2</span> <span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">save</span><span class="p">()</span> <span class="gp">>>> </span><span class="n">p2</span><span class="o">.</span><span class="n">restaurant</span> <span class="go"><Restaurant: Ace Hardware the restaurant></span> <span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">place</span> <span class="go"><Place: Ace Hardware the place></span> </pre></div> </div> <p>Set the place back again, using assignment in the reverse direction:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">p1</span><span class="o">.</span><span class="n">restaurant</span> <span class="o">=</span> <span class="n">r</span> <span class="gp">>>> </span><span class="n">p1</span><span class="o">.</span><span class="n">restaurant</span> <span class="go"><Restaurant: Demon Dogs the restaurant></span> </pre></div> </div> <p>Restaurant.objects.all() just returns the Restaurants, not the Places. Note that there are two restaurants - Ace Hardware the Restaurant was created in the call to r.place = p2:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">Restaurant</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">all</span><span class="p">()</span> <span class="go">[<Restaurant: Demon Dogs the restaurant>, <Restaurant: Ace Hardware the restaurant>]</span> </pre></div> </div> <p>Place.objects.all() returns all Places, regardless of whether they have Restaurants:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">Place</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">order_by</span><span class="p">(</span><span class="s">'name'</span><span class="p">)</span> <span class="go">[<Place: Ace Hardware the place>, <Place: Demon Dogs the place>]</span> </pre></div> </div> <p>You can query the models using <a class="reference internal" href="../queries.html#lookups-that-span-relationships"><em>lookups across relationships</em></a>:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">Restaurant</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">place</span><span class="o">=</span><span class="n">p1</span><span class="p">)</span> <span class="go"><Restaurant: Demon Dogs the restaurant></span> <span class="gp">>>> </span><span class="n">Restaurant</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">place__pk</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="go"><Restaurant: Demon Dogs the restaurant></span> <span class="gp">>>> </span><span class="n">Restaurant</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">place__name__startswith</span><span class="o">=</span><span class="s">"Demon"</span><span class="p">)</span> <span class="go">[<Restaurant: Demon Dogs the restaurant>]</span> <span class="gp">>>> </span><span class="n">Restaurant</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">place__address__contains</span><span class="o">=</span><span class="s">"Ashland"</span><span class="p">)</span> <span class="go">[<Restaurant: Demon Dogs the restaurant>]</span> </pre></div> </div> <p>This of course works in reverse:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">Place</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">pk</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> <span class="go"><Place: Demon Dogs the place></span> <span class="gp">>>> </span><span class="n">Place</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">restaurant__place__exact</span><span class="o">=</span><span class="n">p1</span><span class="p">)</span> <span class="go"><Place: Demon Dogs the place></span> <span class="gp">>>> </span><span class="n">Place</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">restaurant</span><span class="o">=</span><span class="n">r</span><span class="p">)</span> <span class="go"><Place: Demon Dogs the place></span> <span class="gp">>>> </span><span class="n">Place</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">restaurant__place__name__startswith</span><span class="o">=</span><span class="s">"Demon"</span><span class="p">)</span> <span class="go"><Place: Demon Dogs the place></span> </pre></div> </div> <p>Add a Waiter to the Restaurant:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">w</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">waiter_set</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'Joe'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">w</span><span class="o">.</span><span class="n">save</span><span class="p">()</span> <span class="gp">>>> </span><span class="n">w</span> <span class="go"><Waiter: Joe the waiter at Demon Dogs the restaurant></span> </pre></div> </div> <p>Query the waiters:</p> <div class="highlight-pycon"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">Waiter</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">restaurant__place</span><span class="o">=</span><span class="n">p1</span><span class="p">)</span> <span class="go">[<Waiter: Joe the waiter at Demon Dogs the restaurant>]</span> <span class="gp">>>> </span><span class="n">Waiter</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">restaurant__place__name__startswith</span><span class="o">=</span><span class="s">"Demon"</span><span class="p">)</span> <span class="go">[<Waiter: Joe the waiter at Demon Dogs the restaurant>]</span> </pre></div> </div> </div> </div> </div> </div> <div class="yui-b" id="sidebar"> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3>Browse</h3> <ul> <li>Prev: <a href="many_to_one.html">Many-to-one relationships</a></li> <li>Next: <a href="../../http/index.html">Handling HTTP requests</a></li> </ul> <h3>You are here:</h3> <ul> <li> <a href="../../../index.html">Django 1.4.20 documentation</a> <ul><li><a href="../../index.html">Using Django</a> <ul><li><a href="../index.html">Models and databases</a> <ul><li><a href="index.html">Examples of model relationship API usage</a> <ul><li>One-to-one relationships</li></ul> </li></ul></li></ul></li></ul> </li> </ul> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../../_sources/topics/db/examples/one_to_one.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> <h3>Last update:</h3> <p class="topless">Mar 19, 2015</p> </div> </div> <div id="ft"> <div class="nav"> « <a href="many_to_one.html" title="Many-to-one relationships">previous</a> | <a href="../../index.html" title="Using Django" accesskey="U">up</a> | <a href="../../http/index.html" title="Handling HTTP requests">next</a> »</div> </div> </div> <div class="clearer"></div> </div> </body> </html>