~ubuntu-branches/debian/sid/sqlalchemy/sid

« back to all changes in this revision

Viewing changes to doc/core/selectable.html

  • Committer: Package Import Robot
  • Author(s): Piotr Ożarowski
  • Date: 2014-06-27 20:17:13 UTC
  • mfrom: (1.4.28)
  • Revision ID: package-import@ubuntu.com-20140627201713-g6p1kq8q1qenztrv
Tags: 0.9.6-1
* New upstream release
* Remove Python 3.X build tag files, thanks to Matthias Urlichs for the
  patch (closes: #747852)
* python-fdb isn't in the Debian archive yet so default dialect for firebird://
  URLs is changed to obsolete kinterbasdb, thanks to Russell Stuart for the
  patch (closes: #752145)

Show diffs side-by-side

added added

removed removed

Lines of Context:
32
32
    <script type="text/javascript">
33
33
      var DOCUMENTATION_OPTIONS = {
34
34
          URL_ROOT:    '../',
35
 
          VERSION:     '0.9.4',
 
35
          VERSION:     '0.9.6',
36
36
          COLLAPSE_MODINDEX: false,
37
37
          FILE_SUFFIX: '.html'
38
38
      };
44
44
        <script type="text/javascript" src="../_static/doctools.js"></script>
45
45
    <!-- end iterate through sphinx environment script_files -->
46
46
 
 
47
    <script type="text/javascript" src="../_static/detectmobile.js"></script>
47
48
    <script type="text/javascript" src="../_static/init.js"></script>
48
49
    <link rel="index" title="Index" href="../genindex.html" />
49
50
    <link rel="search" title="Search" href="../search.html" />
69
70
 
70
71
 
71
72
 
 
73
 
72
74
<div id="docs-container">
73
75
 
74
76
 
75
77
 
76
78
 
 
79
 
 
80
<div id="docs-top-navigation-container" class="body-background">
77
81
<div id="docs-header">
 
82
    <div id="docs-version-header">
 
83
        Release: <span class="version-num">0.9.6</span> | Release Date: June 23, 2014
 
84
    </div>
 
85
 
78
86
    <h1>SQLAlchemy 0.9 Documentation</h1>
79
87
 
80
 
    <div id="docs-search">
81
 
    Search:
82
 
    <form class="search" action="../search.html" method="get">
83
 
      <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
84
 
      <input type="hidden" name="check_keywords" value="yes" />
85
 
      <input type="hidden" name="area" value="default" />
86
 
    </form>
87
 
    </div>
88
 
 
89
 
    <div id="docs-version-header">
90
 
        Release: <span class="version-num">0.9.4</span> | Release Date: March 28, 2014
91
 
 
92
 
 
93
 
    </div>
94
 
 
95
 
</div>
96
 
 
97
 
<div id="docs-top-navigation">
98
 
    <div id="docs-top-page-control" class="docs-navigation-links">
 
88
</div>
 
89
</div>
 
90
 
 
91
<div id="docs-body-container">
 
92
 
 
93
    <div id="fixed-sidebar" class="withsidebar">
 
94
 
 
95
 
 
96
        <div id="docs-sidebar-popout">
 
97
            <h3><a href="../index.html">SQLAlchemy 0.9 Documentation</a></h3>
 
98
 
 
99
            <p id="sidebar-paginate">
 
100
                    <a href="expression_api.html" title="SQL Statements and Expressions API">Up</a> |
 
101
 
 
102
                    <a href="sqlelement.html" title="Column Elements and Expressions">Prev</a> |
 
103
                    <a href="dml.html" title="Insert, Updates, Deletes">Next</a>
 
104
            </p>
 
105
 
 
106
            <p id="sidebar-topnav">
 
107
                <a href="../index.html">Contents</a> |
 
108
                <a href="../genindex.html">Index</a>
 
109
            </p>
 
110
 
 
111
            <div id="sidebar-search">
 
112
                <form class="search" action="../search.html" method="get">
 
113
                  <input type="text" name="q" size="12" /> <input type="submit" value="Search" />
 
114
                  <input type="hidden" name="check_keywords" value="yes" />
 
115
                  <input type="hidden" name="area" value="default" />
 
116
                </form>
 
117
            </div>
 
118
 
 
119
        </div>
 
120
 
 
121
        <div id="docs-sidebar">
 
122
 
 
123
        <h3><a href="#">            
 
124
                Selectables, Tables, FROM objects
 
125
            
 
126
        </a></h3>
99
127
        <ul>
100
 
            <li>Prev:
101
 
            <a href="sqlelement.html" title="previous chapter">Column Elements and Expressions</a>
102
 
            </li>
103
 
            <li>Next:
104
 
            <a href="dml.html" title="next chapter">Insert, Updates, Deletes</a>
105
 
            </li>
106
 
 
107
 
        <li>
108
 
            <a href="../contents.html">Table of Contents</a> |
109
 
            <a href="../genindex.html">Index</a>
110
 
            | <a href="../_sources/core/selectable.txt">view source
111
 
        </li>
112
 
        </ul>
113
 
    </div>
114
 
 
115
 
    <div id="docs-navigation-banner">
116
 
        <a href="../index.html">SQLAlchemy 0.9 Documentation</a>
117
 
                » <a href="index.html" title="SQLAlchemy Core">SQLAlchemy Core</a>
118
 
                » <a href="expression_api.html" title="SQL Statements and Expressions API">SQL Statements and Expressions API</a>
119
 
        » 
120
 
                Selectables, Tables, FROM objects
121
 
            
122
 
 
123
 
        <h2>
124
 
            
125
 
                Selectables, Tables, FROM objects
126
 
            
127
 
        </h2>
128
 
    </div>
129
 
 
130
 
</div>
131
 
 
132
 
<div id="docs-body-container">
133
 
 
134
 
    <div id="docs-sidebar">
135
 
    <h3><a href="../index.html">Table of Contents</a></h3>
136
 
    <ul>
137
128
<li><a class="reference internal" href="#">Selectables, Tables, FROM objects</a></li>
138
129
</ul>
139
130
 
140
131
 
141
 
    <h4>Previous Topic</h4>
142
 
    <p>
143
 
    <a href="sqlelement.html" title="previous chapter">Column Elements and Expressions</a>
144
 
    </p>
145
 
    <h4>Next Topic</h4>
146
 
    <p>
147
 
    <a href="dml.html" title="next chapter">Insert, Updates, Deletes</a>
148
 
    </p>
149
 
 
150
 
 
151
 
    <h4>Quick Search</h4>
152
 
    <p>
153
 
    <form class="search" action="../search.html" method="get">
154
 
      <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
155
 
      <input type="hidden" name="check_keywords" value="yes" />
156
 
      <input type="hidden" name="area" value="default" />
157
 
    </form>
158
 
    </p>
 
132
 
 
133
 
 
134
        </div>
159
135
 
160
136
    </div>
161
137
 
 
138
    
 
139
 
162
140
    <div id="docs-body" class="withsidebar" >
163
141
        
164
142
<div class="section" id="selectables-tables-from-objects">
401
379
Use this parameter to explicitly specify &#8220;from&#8221; objects which are not
402
380
automatically locatable. This could include
403
381
<a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal"><span class="pre">Table</span></tt></a> objects that aren&#8217;t otherwise present,
404
 
or <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal"><span class="pre">Join</span></tt></a> objects whose presence will supercede that of the
 
382
or <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal"><span class="pre">Join</span></tt></a> objects whose presence will supersede that of the
405
383
<a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal"><span class="pre">Table</span></tt></a> objects already located in the other
406
384
clauses.</li>
407
385
<li><span class="target" id="sqlalchemy.sql.expression.select.params.autocommit"></span><strong>autocommit</strong><a class="paramlink headerlink reference internal" href="#sqlalchemy.sql.expression.select.params.autocommit">¶</a> &#8211; Deprecated.  Use .execution_options(autocommit=&lt;True|False&gt;)
652
630
VALUES clause. This typically refers to Sequence execution but may
653
631
also refer to any server-side default generation function
654
632
associated with a primary key <cite>Column</cite>.</li>
 
633
<li><span class="target" id="sqlalchemy.sql.expression.Alias.compile.params.compile_kwargs"></span><strong>compile_kwargs</strong><a class="paramlink headerlink reference internal" href="#sqlalchemy.sql.expression.Alias.compile.params.compile_kwargs">¶</a> &#8211; <p>optional dictionary of additional parameters
 
634
that will be passed through to the compiler within all &#8220;visit&#8221;
 
635
methods.  This allows any custom flag to be passed through to
 
636
a custom compilation construct, for example.  It is also used
 
637
for the case of passing the <tt class="docutils literal"><span class="pre">literal_binds</span></tt> flag through:</p>
 
638
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy.sql</span> <span class="kn">import</span> <span class="n">table</span><span class="p">,</span> <span class="n">column</span><span class="p">,</span> <span class="n">select</span>
 
639
 
 
640
<span class="n">t</span> <span class="o">=</span> <span class="n">table</span><span class="p">(</span><span class="s">&#39;t&#39;</span><span class="p">,</span> <span class="n">column</span><span class="p">(</span><span class="s">&#39;x&#39;</span><span class="p">))</span>
 
641
 
 
642
<span class="n">s</span> <span class="o">=</span> <span class="n">select</span><span class="p">([</span><span class="n">t</span><span class="p">])</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">x</span> <span class="o">==</span> <span class="mi">5</span><span class="p">)</span>
 
643
 
 
644
<span class="k">print</span> <span class="n">s</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">compile_kwargs</span><span class="o">=</span><span class="p">{</span><span class="s">&quot;literal_binds&quot;</span><span class="p">:</span> <span class="bp">True</span><span class="p">})</span></pre></div>
 
645
</div>
 
646
<div class="versionadded">
 
647
<p><span>New in version 0.9.0.</span></p>
 
648
</div>
 
649
</li>
655
650
</ul>
656
651
</td>
657
652
</tr>
658
653
</tbody>
659
654
</table>
 
655
<div class="admonition seealso">
 
656
<p class="first admonition-title">See also</p>
 
657
<p class="last"><a class="reference internal" href="../faq.html#faq-sql-expression-string"><em>How do I render SQL expressions as strings, possibly with bound parameters inlined?</em></a></p>
 
658
</div>
660
659
</dd></dl>
661
660
 
662
661
<dl class="method">
1046
1045
VALUES clause. This typically refers to Sequence execution but may
1047
1046
also refer to any server-side default generation function
1048
1047
associated with a primary key <cite>Column</cite>.</li>
 
1048
<li><span class="target" id="sqlalchemy.sql.expression.CompoundSelect.compile.params.compile_kwargs"></span><strong>compile_kwargs</strong><a class="paramlink headerlink reference internal" href="#sqlalchemy.sql.expression.CompoundSelect.compile.params.compile_kwargs">¶</a> &#8211; <p>optional dictionary of additional parameters
 
1049
that will be passed through to the compiler within all &#8220;visit&#8221;
 
1050
methods.  This allows any custom flag to be passed through to
 
1051
a custom compilation construct, for example.  It is also used
 
1052
for the case of passing the <tt class="docutils literal"><span class="pre">literal_binds</span></tt> flag through:</p>
 
1053
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy.sql</span> <span class="kn">import</span> <span class="n">table</span><span class="p">,</span> <span class="n">column</span><span class="p">,</span> <span class="n">select</span>
 
1054
 
 
1055
<span class="n">t</span> <span class="o">=</span> <span class="n">table</span><span class="p">(</span><span class="s">&#39;t&#39;</span><span class="p">,</span> <span class="n">column</span><span class="p">(</span><span class="s">&#39;x&#39;</span><span class="p">))</span>
 
1056
 
 
1057
<span class="n">s</span> <span class="o">=</span> <span class="n">select</span><span class="p">([</span><span class="n">t</span><span class="p">])</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">x</span> <span class="o">==</span> <span class="mi">5</span><span class="p">)</span>
 
1058
 
 
1059
<span class="k">print</span> <span class="n">s</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">compile_kwargs</span><span class="o">=</span><span class="p">{</span><span class="s">&quot;literal_binds&quot;</span><span class="p">:</span> <span class="bp">True</span><span class="p">})</span></pre></div>
 
1060
</div>
 
1061
<div class="versionadded">
 
1062
<p><span>New in version 0.9.0.</span></p>
 
1063
</div>
 
1064
</li>
1049
1065
</ul>
1050
1066
</td>
1051
1067
</tr>
1052
1068
</tbody>
1053
1069
</table>
 
1070
<div class="admonition seealso">
 
1071
<p class="first admonition-title">See also</p>
 
1072
<p class="last"><a class="reference internal" href="../faq.html#faq-sql-expression-string"><em>How do I render SQL expressions as strings, possibly with bound parameters inlined?</em></a></p>
 
1073
</div>
1054
1074
</dd></dl>
1055
1075
 
1056
1076
<dl class="method">
1202
1222
<span class="n">parts_alias</span> <span class="o">=</span> <span class="n">parts</span><span class="o">.</span><span class="n">alias</span><span class="p">()</span>
1203
1223
<span class="n">included_parts</span> <span class="o">=</span> <span class="n">included_parts</span><span class="o">.</span><span class="n">union_all</span><span class="p">(</span>
1204
1224
    <span class="n">select</span><span class="p">([</span>
 
1225
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
1205
1226
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="p">,</span>
1206
 
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
1207
1227
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">quantity</span>
1208
1228
    <span class="p">])</span><span class="o">.</span>
1209
1229
        <span class="n">where</span><span class="p">(</span><span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="o">==</span><span class="n">incl_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">)</span>
1213
1233
            <span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
1214
1234
            <span class="n">func</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">quantity</span><span class="p">)</span><span class="o">.</span>
1215
1235
              <span class="n">label</span><span class="p">(</span><span class="s">&#39;total_quantity&#39;</span><span class="p">)</span>
1216
 
        <span class="p">])</span><span class="o">.</span>                    <span class="n">select_from</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">parts</span><span class="p">,</span>
1217
 
                    <span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="o">==</span><span class="n">parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="p">))</span><span class="o">.</span>\
 
1236
        <span class="p">])</span><span class="o">.</span>\
1218
1237
        <span class="n">group_by</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">)</span>
1219
1238
 
1220
1239
<span class="n">result</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">statement</span><span class="p">)</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span></pre></div>
1620
1639
VALUES clause. This typically refers to Sequence execution but may
1621
1640
also refer to any server-side default generation function
1622
1641
associated with a primary key <cite>Column</cite>.</li>
 
1642
<li><span class="target" id="sqlalchemy.sql.expression.CTE.compile.params.compile_kwargs"></span><strong>compile_kwargs</strong><a class="paramlink headerlink reference internal" href="#sqlalchemy.sql.expression.CTE.compile.params.compile_kwargs">¶</a> &#8211; <p>optional dictionary of additional parameters
 
1643
that will be passed through to the compiler within all &#8220;visit&#8221;
 
1644
methods.  This allows any custom flag to be passed through to
 
1645
a custom compilation construct, for example.  It is also used
 
1646
for the case of passing the <tt class="docutils literal"><span class="pre">literal_binds</span></tt> flag through:</p>
 
1647
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy.sql</span> <span class="kn">import</span> <span class="n">table</span><span class="p">,</span> <span class="n">column</span><span class="p">,</span> <span class="n">select</span>
 
1648
 
 
1649
<span class="n">t</span> <span class="o">=</span> <span class="n">table</span><span class="p">(</span><span class="s">&#39;t&#39;</span><span class="p">,</span> <span class="n">column</span><span class="p">(</span><span class="s">&#39;x&#39;</span><span class="p">))</span>
 
1650
 
 
1651
<span class="n">s</span> <span class="o">=</span> <span class="n">select</span><span class="p">([</span><span class="n">t</span><span class="p">])</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">x</span> <span class="o">==</span> <span class="mi">5</span><span class="p">)</span>
 
1652
 
 
1653
<span class="k">print</span> <span class="n">s</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">compile_kwargs</span><span class="o">=</span><span class="p">{</span><span class="s">&quot;literal_binds&quot;</span><span class="p">:</span> <span class="bp">True</span><span class="p">})</span></pre></div>
 
1654
</div>
 
1655
<div class="versionadded">
 
1656
<p><span>New in version 0.9.0.</span></p>
 
1657
</div>
 
1658
</li>
1623
1659
</ul>
1624
1660
</td>
1625
1661
</tr>
1626
1662
</tbody>
1627
1663
</table>
 
1664
<div class="admonition seealso">
 
1665
<p class="first admonition-title">See also</p>
 
1666
<p class="last"><a class="reference internal" href="../faq.html#faq-sql-expression-string"><em>How do I render SQL expressions as strings, possibly with bound parameters inlined?</em></a></p>
 
1667
</div>
1628
1668
</dd></dl>
1629
1669
 
1630
1670
<dl class="method">
2305
2345
VALUES clause. This typically refers to Sequence execution but may
2306
2346
also refer to any server-side default generation function
2307
2347
associated with a primary key <cite>Column</cite>.</li>
 
2348
<li><span class="target" id="sqlalchemy.sql.expression.GenerativeSelect.compile.params.compile_kwargs"></span><strong>compile_kwargs</strong><a class="paramlink headerlink reference internal" href="#sqlalchemy.sql.expression.GenerativeSelect.compile.params.compile_kwargs">¶</a> &#8211; <p>optional dictionary of additional parameters
 
2349
that will be passed through to the compiler within all &#8220;visit&#8221;
 
2350
methods.  This allows any custom flag to be passed through to
 
2351
a custom compilation construct, for example.  It is also used
 
2352
for the case of passing the <tt class="docutils literal"><span class="pre">literal_binds</span></tt> flag through:</p>
 
2353
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy.sql</span> <span class="kn">import</span> <span class="n">table</span><span class="p">,</span> <span class="n">column</span><span class="p">,</span> <span class="n">select</span>
 
2354
 
 
2355
<span class="n">t</span> <span class="o">=</span> <span class="n">table</span><span class="p">(</span><span class="s">&#39;t&#39;</span><span class="p">,</span> <span class="n">column</span><span class="p">(</span><span class="s">&#39;x&#39;</span><span class="p">))</span>
 
2356
 
 
2357
<span class="n">s</span> <span class="o">=</span> <span class="n">select</span><span class="p">([</span><span class="n">t</span><span class="p">])</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">x</span> <span class="o">==</span> <span class="mi">5</span><span class="p">)</span>
 
2358
 
 
2359
<span class="k">print</span> <span class="n">s</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">compile_kwargs</span><span class="o">=</span><span class="p">{</span><span class="s">&quot;literal_binds&quot;</span><span class="p">:</span> <span class="bp">True</span><span class="p">})</span></pre></div>
 
2360
</div>
 
2361
<div class="versionadded">
 
2362
<p><span>New in version 0.9.0.</span></p>
 
2363
</div>
 
2364
</li>
2308
2365
</ul>
2309
2366
</td>
2310
2367
</tr>
2311
2368
</tbody>
2312
2369
</table>
 
2370
<div class="admonition seealso">
 
2371
<p class="first admonition-title">See also</p>
 
2372
<p class="last"><a class="reference internal" href="../faq.html#faq-sql-expression-string"><em>How do I render SQL expressions as strings, possibly with bound parameters inlined?</em></a></p>
 
2373
</div>
2313
2374
</dd></dl>
2314
2375
 
2315
2376
<dl class="method">
2461
2522
<span class="n">parts_alias</span> <span class="o">=</span> <span class="n">parts</span><span class="o">.</span><span class="n">alias</span><span class="p">()</span>
2462
2523
<span class="n">included_parts</span> <span class="o">=</span> <span class="n">included_parts</span><span class="o">.</span><span class="n">union_all</span><span class="p">(</span>
2463
2524
    <span class="n">select</span><span class="p">([</span>
 
2525
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
2464
2526
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="p">,</span>
2465
 
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
2466
2527
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">quantity</span>
2467
2528
    <span class="p">])</span><span class="o">.</span>
2468
2529
        <span class="n">where</span><span class="p">(</span><span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="o">==</span><span class="n">incl_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">)</span>
2472
2533
            <span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
2473
2534
            <span class="n">func</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">quantity</span><span class="p">)</span><span class="o">.</span>
2474
2535
              <span class="n">label</span><span class="p">(</span><span class="s">&#39;total_quantity&#39;</span><span class="p">)</span>
2475
 
        <span class="p">])</span><span class="o">.</span>                    <span class="n">select_from</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">parts</span><span class="p">,</span>
2476
 
                    <span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="o">==</span><span class="n">parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="p">))</span><span class="o">.</span>\
 
2536
        <span class="p">])</span><span class="o">.</span>\
2477
2537
        <span class="n">group_by</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">)</span>
2478
2538
 
2479
2539
<span class="n">result</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">statement</span><span class="p">)</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span></pre></div>
3065
3125
VALUES clause. This typically refers to Sequence execution but may
3066
3126
also refer to any server-side default generation function
3067
3127
associated with a primary key <cite>Column</cite>.</li>
 
3128
<li><span class="target" id="sqlalchemy.sql.expression.Join.compile.params.compile_kwargs"></span><strong>compile_kwargs</strong><a class="paramlink headerlink reference internal" href="#sqlalchemy.sql.expression.Join.compile.params.compile_kwargs">¶</a> &#8211; <p>optional dictionary of additional parameters
 
3129
that will be passed through to the compiler within all &#8220;visit&#8221;
 
3130
methods.  This allows any custom flag to be passed through to
 
3131
a custom compilation construct, for example.  It is also used
 
3132
for the case of passing the <tt class="docutils literal"><span class="pre">literal_binds</span></tt> flag through:</p>
 
3133
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy.sql</span> <span class="kn">import</span> <span class="n">table</span><span class="p">,</span> <span class="n">column</span><span class="p">,</span> <span class="n">select</span>
 
3134
 
 
3135
<span class="n">t</span> <span class="o">=</span> <span class="n">table</span><span class="p">(</span><span class="s">&#39;t&#39;</span><span class="p">,</span> <span class="n">column</span><span class="p">(</span><span class="s">&#39;x&#39;</span><span class="p">))</span>
 
3136
 
 
3137
<span class="n">s</span> <span class="o">=</span> <span class="n">select</span><span class="p">([</span><span class="n">t</span><span class="p">])</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">x</span> <span class="o">==</span> <span class="mi">5</span><span class="p">)</span>
 
3138
 
 
3139
<span class="k">print</span> <span class="n">s</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">compile_kwargs</span><span class="o">=</span><span class="p">{</span><span class="s">&quot;literal_binds&quot;</span><span class="p">:</span> <span class="bp">True</span><span class="p">})</span></pre></div>
 
3140
</div>
 
3141
<div class="versionadded">
 
3142
<p><span>New in version 0.9.0.</span></p>
 
3143
</div>
 
3144
</li>
3068
3145
</ul>
3069
3146
</td>
3070
3147
</tr>
3071
3148
</tbody>
3072
3149
</table>
 
3150
<div class="admonition seealso">
 
3151
<p class="first admonition-title">See also</p>
 
3152
<p class="last"><a class="reference internal" href="../faq.html#faq-sql-expression-string"><em>How do I render SQL expressions as strings, possibly with bound parameters inlined?</em></a></p>
 
3153
</div>
3073
3154
</dd></dl>
3074
3155
 
3075
3156
<dl class="method">
3524
3605
VALUES clause. This typically refers to Sequence execution but may
3525
3606
also refer to any server-side default generation function
3526
3607
associated with a primary key <cite>Column</cite>.</li>
 
3608
<li><span class="target" id="sqlalchemy.sql.expression.Select.compile.params.compile_kwargs"></span><strong>compile_kwargs</strong><a class="paramlink headerlink reference internal" href="#sqlalchemy.sql.expression.Select.compile.params.compile_kwargs">¶</a> &#8211; <p>optional dictionary of additional parameters
 
3609
that will be passed through to the compiler within all &#8220;visit&#8221;
 
3610
methods.  This allows any custom flag to be passed through to
 
3611
a custom compilation construct, for example.  It is also used
 
3612
for the case of passing the <tt class="docutils literal"><span class="pre">literal_binds</span></tt> flag through:</p>
 
3613
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy.sql</span> <span class="kn">import</span> <span class="n">table</span><span class="p">,</span> <span class="n">column</span><span class="p">,</span> <span class="n">select</span>
 
3614
 
 
3615
<span class="n">t</span> <span class="o">=</span> <span class="n">table</span><span class="p">(</span><span class="s">&#39;t&#39;</span><span class="p">,</span> <span class="n">column</span><span class="p">(</span><span class="s">&#39;x&#39;</span><span class="p">))</span>
 
3616
 
 
3617
<span class="n">s</span> <span class="o">=</span> <span class="n">select</span><span class="p">([</span><span class="n">t</span><span class="p">])</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">x</span> <span class="o">==</span> <span class="mi">5</span><span class="p">)</span>
 
3618
 
 
3619
<span class="k">print</span> <span class="n">s</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">compile_kwargs</span><span class="o">=</span><span class="p">{</span><span class="s">&quot;literal_binds&quot;</span><span class="p">:</span> <span class="bp">True</span><span class="p">})</span></pre></div>
 
3620
</div>
 
3621
<div class="versionadded">
 
3622
<p><span>New in version 0.9.0.</span></p>
 
3623
</div>
 
3624
</li>
3527
3625
</ul>
3528
3626
</td>
3529
3627
</tr>
3530
3628
</tbody>
3531
3629
</table>
 
3630
<div class="admonition seealso">
 
3631
<p class="first admonition-title">See also</p>
 
3632
<p class="last"><a class="reference internal" href="../faq.html#faq-sql-expression-string"><em>How do I render SQL expressions as strings, possibly with bound parameters inlined?</em></a></p>
 
3633
</div>
3532
3634
</dd></dl>
3533
3635
 
3534
3636
<dl class="method">
3783
3885
<span class="n">parts_alias</span> <span class="o">=</span> <span class="n">parts</span><span class="o">.</span><span class="n">alias</span><span class="p">()</span>
3784
3886
<span class="n">included_parts</span> <span class="o">=</span> <span class="n">included_parts</span><span class="o">.</span><span class="n">union_all</span><span class="p">(</span>
3785
3887
    <span class="n">select</span><span class="p">([</span>
 
3888
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
3786
3889
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="p">,</span>
3787
 
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
3788
3890
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">quantity</span>
3789
3891
    <span class="p">])</span><span class="o">.</span>
3790
3892
        <span class="n">where</span><span class="p">(</span><span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="o">==</span><span class="n">incl_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">)</span>
3794
3896
            <span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
3795
3897
            <span class="n">func</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">quantity</span><span class="p">)</span><span class="o">.</span>
3796
3898
              <span class="n">label</span><span class="p">(</span><span class="s">&#39;total_quantity&#39;</span><span class="p">)</span>
3797
 
        <span class="p">])</span><span class="o">.</span>                    <span class="n">select_from</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">parts</span><span class="p">,</span>
3798
 
                    <span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="o">==</span><span class="n">parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="p">))</span><span class="o">.</span>\
 
3899
        <span class="p">])</span><span class="o">.</span>\
3799
3900
        <span class="n">group_by</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">)</span>
3800
3901
 
3801
3902
<span class="n">result</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">statement</span><span class="p">)</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span></pre></div>
4567
4668
<span class="n">parts_alias</span> <span class="o">=</span> <span class="n">parts</span><span class="o">.</span><span class="n">alias</span><span class="p">()</span>
4568
4669
<span class="n">included_parts</span> <span class="o">=</span> <span class="n">included_parts</span><span class="o">.</span><span class="n">union_all</span><span class="p">(</span>
4569
4670
    <span class="n">select</span><span class="p">([</span>
 
4671
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
4570
4672
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="p">,</span>
4571
 
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
4572
4673
        <span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">quantity</span>
4573
4674
    <span class="p">])</span><span class="o">.</span>
4574
4675
        <span class="n">where</span><span class="p">(</span><span class="n">parts_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="o">==</span><span class="n">incl_alias</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">)</span>
4578
4679
            <span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">,</span>
4579
4680
            <span class="n">func</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">quantity</span><span class="p">)</span><span class="o">.</span>
4580
4681
              <span class="n">label</span><span class="p">(</span><span class="s">&#39;total_quantity&#39;</span><span class="p">)</span>
4581
 
        <span class="p">])</span><span class="o">.</span>                    <span class="n">select_from</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">parts</span><span class="p">,</span>
4582
 
                    <span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="o">==</span><span class="n">parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">part</span><span class="p">))</span><span class="o">.</span>\
 
4682
        <span class="p">])</span><span class="o">.</span>\
4583
4683
        <span class="n">group_by</span><span class="p">(</span><span class="n">included_parts</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">sub_part</span><span class="p">)</span>
4584
4684
 
4585
4685
<span class="n">result</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">statement</span><span class="p">)</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span></pre></div>
4719
4819
VALUES clause. This typically refers to Sequence execution but may
4720
4820
also refer to any server-side default generation function
4721
4821
associated with a primary key <cite>Column</cite>.</li>
 
4822
<li><span class="target" id="sqlalchemy.sql.expression.TableClause.compile.params.compile_kwargs"></span><strong>compile_kwargs</strong><a class="paramlink headerlink reference internal" href="#sqlalchemy.sql.expression.TableClause.compile.params.compile_kwargs">¶</a> &#8211; <p>optional dictionary of additional parameters
 
4823
that will be passed through to the compiler within all &#8220;visit&#8221;
 
4824
methods.  This allows any custom flag to be passed through to
 
4825
a custom compilation construct, for example.  It is also used
 
4826
for the case of passing the <tt class="docutils literal"><span class="pre">literal_binds</span></tt> flag through:</p>
 
4827
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sqlalchemy.sql</span> <span class="kn">import</span> <span class="n">table</span><span class="p">,</span> <span class="n">column</span><span class="p">,</span> <span class="n">select</span>
 
4828
 
 
4829
<span class="n">t</span> <span class="o">=</span> <span class="n">table</span><span class="p">(</span><span class="s">&#39;t&#39;</span><span class="p">,</span> <span class="n">column</span><span class="p">(</span><span class="s">&#39;x&#39;</span><span class="p">))</span>
 
4830
 
 
4831
<span class="n">s</span> <span class="o">=</span> <span class="n">select</span><span class="p">([</span><span class="n">t</span><span class="p">])</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">x</span> <span class="o">==</span> <span class="mi">5</span><span class="p">)</span>
 
4832
 
 
4833
<span class="k">print</span> <span class="n">s</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">compile_kwargs</span><span class="o">=</span><span class="p">{</span><span class="s">&quot;literal_binds&quot;</span><span class="p">:</span> <span class="bp">True</span><span class="p">})</span></pre></div>
 
4834
</div>
 
4835
<div class="versionadded">
 
4836
<p><span>New in version 0.9.0.</span></p>
 
4837
</div>
 
4838
</li>
4722
4839
</ul>
4723
4840
</td>
4724
4841
</tr>
4725
4842
</tbody>
4726
4843
</table>
 
4844
<div class="admonition seealso">
 
4845
<p class="first admonition-title">See also</p>
 
4846
<p class="last"><a class="reference internal" href="../faq.html#faq-sql-expression-string"><em>How do I render SQL expressions as strings, possibly with bound parameters inlined?</em></a></p>
 
4847
</div>
4727
4848
</dd></dl>
4728
4849
 
4729
4850
<dl class="method">