File: threeway.html

package info (click to toggle)
sqlalchemy 0.9.8%2Bdfsg-0.1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 23,952 kB
  • ctags: 24,534
  • sloc: python: 152,282; ansic: 1,346; makefile: 257; xml: 17
file content (244 lines) | stat: -rw-r--r-- 17,712 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<!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>
            
    
                examples.join_conditions.threeway
             &mdash;
    SQLAlchemy 0.9 Documentation

        </title>

        
            <!-- begin iterate through SQLA + sphinx environment css_files -->
                <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
                <link rel="stylesheet" href="../../../_static/docs.css" type="text/css" />
                <link rel="stylesheet" href="../../../_static/sphinx_paramlinks.css" type="text/css" />
                <link rel="stylesheet" href="../../../_static/changelog.css" type="text/css" />
            <!-- end iterate through SQLA + sphinx environment css_files -->
        

        

    

    <!-- begin layout.mako headers -->

    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
          URL_ROOT:    '../../../',
          VERSION:     '0.9.8',
          COLLAPSE_MODINDEX: false,
          FILE_SUFFIX: '.html'
      };
    </script>

    <!-- begin iterate through sphinx environment script_files -->
        <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>
    <!-- end iterate through sphinx environment script_files -->

    <script type="text/javascript" src="../../../_static/detectmobile.js"></script>
    <script type="text/javascript" src="../../../_static/init.js"></script>
    <link rel="index" title="Index" href="../../../genindex.html" />
    <link rel="search" title="Search" href="../../../search.html" />
        <link rel="copyright" title="Copyright" href="../../../copyright.html" />
    <link rel="top" title="SQLAlchemy 0.9 Documentation" href="../../../index.html" />
        <link rel="up" title="Module code" href="../../index.html" />
    <!-- end layout.mako headers -->


    </head>
    <body>
        















<div id="docs-container">





<div id="docs-top-navigation-container" class="body-background">
<div id="docs-header">
    <div id="docs-version-header">
        Release: <span class="version-num">0.9.8</span> | Release Date: October 13, 2014
    </div>

    <h1>SQLAlchemy 0.9 Documentation</h1>

</div>
</div>

<div id="docs-body-container">

    <div id="fixed-sidebar" class="">

        <div id="index-nav">
            <form class="search" action="../../../search.html" method="get">
              <input type="text" name="q" size="12" /> <input type="submit" value="Search" />
              <input type="hidden" name="check_keywords" value="yes" />
              <input type="hidden" name="area" value="default" />
            </form>

            <p>
            <a href="../../../index.html">Contents</a> |
            <a href="../../../genindex.html">Index</a>
            </p>

        </div>


    </div>

    

    <div id="docs-body" class="" >
        
<h1>Source code for examples.join_conditions.threeway</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot;Illustrate a &quot;three way join&quot; - where a primary table joins to a remote</span>
<span class="sd">table via an association table, but then the primary table also needs</span>
<span class="sd">to refer to some columns in the remote table directly.</span>

<span class="sd">E.g.::</span>

<span class="sd">    first.first_id      -&gt; second.first_id</span>
<span class="sd">                           second.other_id --&gt; partitioned.other_id</span>
<span class="sd">    first.partition_key ---------------------&gt; partitioned.partition_key</span>

<span class="sd">For a relationship like this, &quot;second&quot; is a lot like a &quot;secondary&quot; table,</span>
<span class="sd">but the mechanics aren&#39;t present within the &quot;secondary&quot; feature to allow</span>
<span class="sd">for the join directly between first and partitioned.  Instead, we</span>
<span class="sd">will derive a selectable from partitioned and second combined together, then</span>
<span class="sd">link first to that derived selectable.</span>

<span class="sd">If we define the derived selectable as::</span>

<span class="sd">    second JOIN partitioned ON second.other_id = partitioned.other_id</span>

<span class="sd">A JOIN from first to this derived selectable is then::</span>

<span class="sd">    first JOIN (second JOIN partitioned</span>
<span class="sd">                ON second.other_id = partitioned.other_id)</span>
<span class="sd">          ON first.first_id = second.first_id AND</span>
<span class="sd">             first.partition_key = partitioned.partition_key</span>

<span class="sd">We will use the &quot;non primary mapper&quot; feature in order to produce this.</span>
<span class="sd">A non primary mapper is essentially an &quot;extra&quot; :func:`.mapper` that we can</span>
<span class="sd">use to associate a particular class with some selectable that is</span>
<span class="sd">not its usual mapped table.   It is used only when called upon within</span>
<span class="sd">a Query (or a :func:`.relationship`).</span>


<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">declarative_base</span>

<span class="n">Base</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span>

<span class="k">class</span> <span class="nc">First</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
    <span class="n">__tablename__</span> <span class="o">=</span> <span class="s">&#39;first&#39;</span>

    <span class="n">first_id</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">Integer</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">partition_key</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">String</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="p">(</span><span class="s">&quot;First(</span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">first_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">partition_key</span><span class="p">))</span>

<span class="k">class</span> <span class="nc">Second</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
    <span class="n">__tablename__</span> <span class="o">=</span> <span class="s">&#39;second&#39;</span>

    <span class="n">first_id</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">Integer</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">other_id</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">Integer</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="k">class</span> <span class="nc">Partitioned</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
    <span class="n">__tablename__</span> <span class="o">=</span> <span class="s">&#39;partitioned&#39;</span>

    <span class="n">other_id</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">Integer</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">partition_key</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">String</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="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="p">(</span><span class="s">&quot;Partitioned(</span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">other_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">partition_key</span><span class="p">))</span>


<span class="n">j</span> <span class="o">=</span> <span class="n">join</span><span class="p">(</span><span class="n">Partitioned</span><span class="p">,</span> <span class="n">Second</span><span class="p">,</span> <span class="n">Partitioned</span><span class="o">.</span><span class="n">other_id</span> <span class="o">==</span> <span class="n">Second</span><span class="o">.</span><span class="n">other_id</span><span class="p">)</span>

<span class="n">partitioned_second</span> <span class="o">=</span> <span class="n">mapper</span><span class="p">(</span><span class="n">Partitioned</span><span class="p">,</span> <span class="n">j</span><span class="p">,</span> <span class="n">non_primary</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">properties</span><span class="o">=</span><span class="p">{</span>
        <span class="c"># note we need to disambiguate columns here - the join()</span>
        <span class="c"># will provide them as j.c.&lt;tablename&gt;_&lt;colname&gt; for access,</span>
        <span class="c"># but they retain their real names in the mapping</span>
        <span class="s">&quot;other_id&quot;</span><span class="p">:</span> <span class="p">[</span><span class="n">j</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">partitioned_other_id</span><span class="p">,</span> <span class="n">j</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">second_other_id</span><span class="p">],</span>
    <span class="p">})</span>

<span class="n">First</span><span class="o">.</span><span class="n">partitioned</span> <span class="o">=</span> <span class="n">relationship</span><span class="p">(</span>
                            <span class="n">partitioned_second</span><span class="p">,</span>
                            <span class="n">primaryjoin</span><span class="o">=</span><span class="n">and_</span><span class="p">(</span>
                                <span class="n">First</span><span class="o">.</span><span class="n">partition_key</span> <span class="o">==</span> <span class="n">partitioned_second</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">partition_key</span><span class="p">,</span>
                                <span class="n">First</span><span class="o">.</span><span class="n">first_id</span> <span class="o">==</span> <span class="n">foreign</span><span class="p">(</span><span class="n">partitioned_second</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">first_id</span><span class="p">)</span>
                            <span class="p">),</span> <span class="n">innerjoin</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>

<span class="c"># when using any database other than SQLite, we will get a nested</span>
<span class="c"># join, e.g. &quot;first JOIN (partitioned JOIN second ON ..) ON ..&quot;.</span>
<span class="c"># On SQLite, SQLAlchemy needs to render a full subquery.</span>
<span class="n">e</span> <span class="o">=</span> <span class="n">create_engine</span><span class="p">(</span><span class="s">&quot;sqlite://&quot;</span><span class="p">,</span> <span class="n">echo</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>

<span class="n">Base</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">create_all</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">Session</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
<span class="n">s</span><span class="o">.</span><span class="n">add_all</span><span class="p">([</span>
    <span class="n">First</span><span class="p">(</span><span class="n">first_id</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">partition_key</span><span class="o">=</span><span class="s">&#39;p1&#39;</span><span class="p">),</span>
    <span class="n">First</span><span class="p">(</span><span class="n">first_id</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">partition_key</span><span class="o">=</span><span class="s">&#39;p1&#39;</span><span class="p">),</span>
    <span class="n">First</span><span class="p">(</span><span class="n">first_id</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">partition_key</span><span class="o">=</span><span class="s">&#39;p2&#39;</span><span class="p">),</span>
    <span class="n">Second</span><span class="p">(</span><span class="n">first_id</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">other_id</span><span class="o">=</span><span class="mi">1</span><span class="p">),</span>
    <span class="n">Second</span><span class="p">(</span><span class="n">first_id</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">other_id</span><span class="o">=</span><span class="mi">1</span><span class="p">),</span>
    <span class="n">Second</span><span class="p">(</span><span class="n">first_id</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">other_id</span><span class="o">=</span><span class="mi">2</span><span class="p">),</span>
    <span class="n">Partitioned</span><span class="p">(</span><span class="n">partition_key</span><span class="o">=</span><span class="s">&#39;p1&#39;</span><span class="p">,</span> <span class="n">other_id</span><span class="o">=</span><span class="mi">1</span><span class="p">),</span>
    <span class="n">Partitioned</span><span class="p">(</span><span class="n">partition_key</span><span class="o">=</span><span class="s">&#39;p1&#39;</span><span class="p">,</span> <span class="n">other_id</span><span class="o">=</span><span class="mi">2</span><span class="p">),</span>
    <span class="n">Partitioned</span><span class="p">(</span><span class="n">partition_key</span><span class="o">=</span><span class="s">&#39;p2&#39;</span><span class="p">,</span> <span class="n">other_id</span><span class="o">=</span><span class="mi">2</span><span class="p">),</span>
<span class="p">])</span>
<span class="n">s</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>

<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">s</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">First</span><span class="p">,</span> <span class="n">Partitioned</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">First</span><span class="o">.</span><span class="n">partitioned</span><span class="p">):</span>
    <span class="k">print</span><span class="p">(</span><span class="n">row</span><span class="p">)</span>

<span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">s</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">First</span><span class="p">):</span>
    <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">f</span><span class="o">.</span><span class="n">partitioned</span><span class="p">:</span>
        <span class="k">print</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">partition_key</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">partition_key</span><span class="p">)</span></pre></div>
    </div>

</div>

<div id="docs-bottom-navigation" class="docs-navigation-links">

    <div id="docs-copyright">
        &copy; <a href="../../../copyright.html">Copyright</a> 2007-2014, the SQLAlchemy authors and contributors.
        Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2b1.
    </div>
</div>

</div>

        
    </body>
</html>