~ubuntu-branches/debian/jessie/sqlalchemy/jessie : revision 35

1

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

2

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

3

4

5

<head>

6

7

8

<title>

9

10

11

Selectables, Tables, FROM objects

12

—

13

SQLAlchemy 0.8 Documentation

14

15

</title>

16

17

18

19

20

21

var DOCUMENTATION_OPTIONS = {

22

URL_ROOT: '../',

23

VERSION: '0.8.3',

24

COLLAPSE_MODINDEX: false,

25

FILE_SUFFIX: '.html'

26

};

27

</script>

28

29

30

31

32

33

34

35

36

37

38

39

40

</head>

41

<body>

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

<h1>SQLAlchemy 0.8 Documentation</h1>

59

60

61

Search:

62

63

64

65

66

</form>

67

</div>

68

69

70

Release: 0.8.3 | Release Date: October 26, 2013

71

72

73

</div>

74

75

</div>

76

77

78

79

<ul>

80

<li>Prev:

81

<a href="sqlelement.html" title="previous chapter">Column Elements and Expressions</a>

82

</li>

83

<li>Next:

84

<a href="dml.html" title="next chapter">Insert, Updates, Deletes</a>

85

</li>

86

87

<li>

88

<a href="../contents.html">Table of Contents</a> |

89

<a href="../genindex.html">Index</a>

90

| <a href="../_sources/core/selectable.txt">view source

91

</li>

92

</ul>

93

</div>

94

95

96

<a href="../index.html">SQLAlchemy 0.8 Documentation</a>

97

» <a href="index.html" title="SQLAlchemy Core">SQLAlchemy Core</a>

98

» <a href="expression_api.html" title="SQL Statements and Expressions API">SQL Statements and Expressions API</a>

99

»

100

Selectables, Tables, FROM objects

101

102

103

<h2>

104

105

Selectables, Tables, FROM objects

106

107

</h2>

108

</div>

109

110

</div>

111

112

113

114

115

<h3><a href="../index.html">Table of Contents</a></h3>

116

<ul>

117

<li><a class="reference internal" href="#">Selectables, Tables, FROM objects</a></li>

118

</ul>

119

120

121

<h4>Previous Topic</h4>

122

123

<a href="sqlelement.html" title="previous chapter">Column Elements and Expressions</a>

124

125

<h4>Next Topic</h4>

126

127

<a href="dml.html" title="next chapter">Insert, Updates, Deletes</a>

128

129

130

131

<h4>Quick Search</h4>

132

133

134

135

136

137

</form>

138

139

140

</div>

141

142

143

144

145

<h1>Selectables, Tables, FROM objects<a class="headerlink" href="#selectables-tables-from-objects" title="Permalink to this headline">¶</a></h1>

146

The term “selectable” refers to any object that rows can be selected from;

147

in SQLAlchemy, these objects descend from <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> and their

148

distinguishing feature is their <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.c" title="sqlalchemy.sql.expression.FromClause.c"><tt class="xref py py-attr docutils literal">FromClause.c</tt></a> attribute, which is

149

a namespace of all the columns contained within the FROM clause (these

150

elements are themselves <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> subclasses).

151

152

153

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">alias</tt><big>(</big>selectable, name=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.alias" title="Permalink to this definition">¶</a></dt>

154

<dd>Return an <a class="reference internal" href="#sqlalchemy.sql.expression.Alias" title="sqlalchemy.sql.expression.Alias"><tt class="xref py py-class docutils literal">Alias</tt></a> object.

155

An <a class="reference internal" href="#sqlalchemy.sql.expression.Alias" title="sqlalchemy.sql.expression.Alias"><tt class="xref py py-class docutils literal">Alias</tt></a> represents any <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>

156

with an alternate name assigned within SQL, typically using the <tt class="docutils literal">AS</tt>

157

clause when generated, e.g. <tt class="docutils literal">SELECT * FROM table AS aliasname</tt>.

158

Similar functionality is available via the

159

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.alias" title="sqlalchemy.sql.expression.FromClause.alias"><tt class="xref py py-meth docutils literal">alias()</tt></a> method

160

available on all <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> subclasses.

161

When an <a class="reference internal" href="#sqlalchemy.sql.expression.Alias" title="sqlalchemy.sql.expression.Alias"><tt class="xref py py-class docutils literal">Alias</tt></a> is created from a <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> object,

162

this has the effect of the table being rendered

163

as <tt class="docutils literal">tablename AS aliasname</tt> in a SELECT statement.

164

For <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> objects, the effect is that of creating a named

165

subquery, i.e. <tt class="docutils literal">(select ...) AS aliasname</tt>.

166

The <tt class="docutils literal">name</tt> parameter is optional, and provides the name

167

to use in the rendered SQL. If blank, an “anonymous” name

168

will be deterministically generated at compile time.

169

Deterministic means the name is guaranteed to be unique against

170

other constructs used in the same statement, and will also be the

171

same name for each successive compilation of the same statement

172

object.

173

174

175

176

177

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

178

<li>selectable – any <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> subclass,

179

such as a table, select statement, etc.</li>

180

<li>name – string name to be assigned as the alias.

181

If <tt class="docutils literal">None</tt>, a name will be deterministically generated

182

at compile time.</li>

183

</ul>

184

</td>

185

</tr>

186

</tbody>

187

</table>

188

</dd></dl>

189

190

191

192

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">except_</tt><big>(</big>*selects, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.except_" title="Permalink to this definition">¶</a></dt>

193

<dd>Return an <tt class="docutils literal">EXCEPT</tt> of multiple selectables.

194

The returned object is an instance of

195

<a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect" title="sqlalchemy.sql.expression.CompoundSelect"><tt class="xref py py-class docutils literal">CompoundSelect</tt></a>.

196

197

<dt>*selects</dt>

198

<dd>a list of <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> instances.</dd>

199

<dt>**kwargs</dt>

200

<dd>available keyword arguments are the same as those of

201

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>.</dd>

202

</dl>

203

</dd></dl>

204

205

206

207

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">except_all</tt><big>(</big>*selects, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.except_all" title="Permalink to this definition">¶</a></dt>

208

<dd>Return an <tt class="docutils literal">EXCEPT ALL</tt> of multiple selectables.

209

The returned object is an instance of

210

<a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect" title="sqlalchemy.sql.expression.CompoundSelect"><tt class="xref py py-class docutils literal">CompoundSelect</tt></a>.

211

212

<dt>*selects</dt>

213

<dd>a list of <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> instances.</dd>

214

<dt>**kwargs</dt>

215

<dd>available keyword arguments are the same as those of

216

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>.</dd>

217

</dl>

218

</dd></dl>

219

220

221

222

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">exists</tt><big>(</big>*args, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.exists" title="Permalink to this definition">¶</a></dt>

223

<dd>Return an <tt class="docutils literal">EXISTS</tt> clause as applied to a <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> object.

224

Calling styles are of the following forms:

225

<div class="highlight-python"><div class="highlight"><pre># use on an existing select()

226

s = select([table.c.col1]).where(table.c.col2==5)

227

s = exists(s)

228

229

# construct a select() at once

230

exists(['*'], **select_arguments).where(criterion)

231

232

# columns argument is optional, generates "EXISTS (SELECT *)"

233

# by default.

234

exists().where(table.c.col2==5)</pre></div>

235

</div>

236

</dd></dl>

237

238

239

240

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">intersect</tt><big>(</big>*selects, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.intersect" title="Permalink to this definition">¶</a></dt>

241

<dd>Return an <tt class="docutils literal">INTERSECT</tt> of multiple selectables.

242

The returned object is an instance of

243

<a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect" title="sqlalchemy.sql.expression.CompoundSelect"><tt class="xref py py-class docutils literal">CompoundSelect</tt></a>.

244

245

<dt>*selects</dt>

246

<dd>a list of <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> instances.</dd>

247

<dt>**kwargs</dt>

248

<dd>available keyword arguments are the same as those of

249

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>.</dd>

250

</dl>

251

</dd></dl>

252

253

254

255

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">intersect_all</tt><big>(</big>*selects, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.intersect_all" title="Permalink to this definition">¶</a></dt>

256

<dd>Return an <tt class="docutils literal">INTERSECT ALL</tt> of multiple selectables.

257

The returned object is an instance of

258

<a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect" title="sqlalchemy.sql.expression.CompoundSelect"><tt class="xref py py-class docutils literal">CompoundSelect</tt></a>.

259

260

<dt>*selects</dt>

261

<dd>a list of <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> instances.</dd>

262

<dt>**kwargs</dt>

263

<dd>available keyword arguments are the same as those of

264

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>.</dd>

265

</dl>

266

</dd></dl>

267

268

269

270

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">join</tt><big>(</big>left, right, onclause=None, isouter=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.join" title="Permalink to this definition">¶</a></dt>

271

<dd>Return a <tt class="docutils literal">JOIN</tt> clause element (regular inner join).

272

The returned object is an instance of <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a>.

273

Similar functionality is also available via the

274

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">join()</tt></a> method on any

275

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

276

277

278

279

280

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

281

282

<li>right – The right side of the join.</li>

283

<li>onclause – Optional criterion for the <tt class="docutils literal">ON</tt> clause, is

284

derived from foreign key relationships established between

285

left and right otherwise.</li>

286

</ul>

287

</td>

288

</tr>

289

</tbody>

290

</table>

291

To chain joins together, use the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">FromClause.join()</tt></a> or

292

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.outerjoin" title="sqlalchemy.sql.expression.FromClause.outerjoin"><tt class="xref py py-meth docutils literal">FromClause.outerjoin()</tt></a> methods on the resulting

293

<a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a> object.

294

</dd></dl>

295

296

297

298

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">outerjoin</tt><big>(</big>left, right, onclause=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.outerjoin" title="Permalink to this definition">¶</a></dt>

299

<dd>Return an <tt class="docutils literal">OUTER JOIN</tt> clause element.

300

The returned object is an instance of <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a>.

301

Similar functionality is also available via the

302

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.outerjoin" title="sqlalchemy.sql.expression.FromClause.outerjoin"><tt class="xref py py-meth docutils literal">outerjoin()</tt></a> method on any

303

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

304

305

306

307

308

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

309

310

<li>right – The right side of the join.</li>

311

<li>onclause – Optional criterion for the <tt class="docutils literal">ON</tt> clause, is

312

derived from foreign key relationships established between

313

left and right otherwise.</li>

314

</ul>

315

</td>

316

</tr>

317

</tbody>

318

</table>

319

To chain joins together, use the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">FromClause.join()</tt></a> or

320

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.outerjoin" title="sqlalchemy.sql.expression.FromClause.outerjoin"><tt class="xref py py-meth docutils literal">FromClause.outerjoin()</tt></a> methods on the resulting

321

<a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a> object.

322

</dd></dl>

323

324

325

326

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">select</tt><big>(</big>columns=None, whereclause=None, from_obj=[], **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.select" title="Permalink to this definition">¶</a></dt>

327

<dd>Returns a <tt class="docutils literal">SELECT</tt> clause element.

328

Similar functionality is also available via the <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>

329

method on any <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

330

The returned object is an instance of <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>.

331

All arguments which accept <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a> arguments also accept

332

string arguments, which will be converted as appropriate into

333

either <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a> or <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.literal_column" title="sqlalchemy.sql.expression.literal_column"><tt class="xref py py-func docutils literal">literal_column()</tt></a> constructs.

334

335

See also

336

<a class="reference internal" href="tutorial.html#coretutorial-selecting">Selecting</a> - Core Tutorial description of

337

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>.

338

</div>

339

340

341

342

343

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

344

<li>columns – A list of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a> objects, typically

345

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> objects or subclasses, which will form the

346

columns clause of the resulting statement. For all members which are

347

instances of <a class="reference internal" href="#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a>, the individual <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>

348

members of the <a class="reference internal" href="#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a> will be added individually to the

349

columns clause. For example, specifying a

350

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> instance will result in all the

351

contained <a class="reference internal" href="metadata.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a> objects within to be added

352

to the columns clause.

353

This argument is not present on the form of <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>

354

available on <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>.

355

</li>

356

<li>whereclause – A <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a> expression which will be used to form the

357

<tt class="docutils literal">WHERE</tt> clause.</li>

358

<li>from_obj – A list of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a> objects which will be added to the

359

<tt class="docutils literal">FROM</tt> clause of the resulting statement. Note that “from” objects are

360

automatically located within the columns and whereclause ClauseElements.

361

Use this parameter to explicitly specify “from” objects which are not

362

automatically locatable. This could include

363

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> objects that aren’t otherwise present,

364

or <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a> objects whose presence will supercede that of the

365

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> objects already located in the other

366

clauses.</li>

367

<li>autocommit – Deprecated. Use .execution_options(autocommit=<True|False>)

368

to set the autocommit option.</li>

369

<li>bind=None – an <tt class="xref py py-class docutils literal">Engine</tt> or <tt class="xref py py-class docutils literal">Connection</tt> instance

370

to which the

371

resulting <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> object will be bound. The <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>

372

object will otherwise automatically bind to whatever

373

<tt class="xref py py-class docutils literal">Connectable</tt> instances can be located within its contained

374

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a> members.</li>

375

<li>correlate=True – indicates that this <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> object should have its

376

contained <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> elements “correlated” to an enclosing

377

<a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> object. This means that any <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>

378

instance within the “froms” collection of this <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>

379

which is also present in the “froms” collection of an

380

enclosing select will not be rendered in the <tt class="docutils literal">FROM</tt> clause

381

of this select statement.</li>

382

<li>distinct=False – when <tt class="docutils literal">True</tt>, applies a <tt class="docutils literal">DISTINCT</tt> qualifier to the columns

383

clause of the resulting statement.

384

The boolean argument may also be a column expression or list

385

of column expressions - this is a special calling form which

386

is understood by the Postgresql dialect to render the

387

<tt class="docutils literal">DISTINCT ON (<columns>)</tt> syntax.

388

<tt class="docutils literal">distinct</tt> is also available via the <a class="reference internal" href="#sqlalchemy.sql.expression.Select.distinct" title="sqlalchemy.sql.expression.Select.distinct"><tt class="xref py py-meth docutils literal">distinct()</tt></a>

389

generative method.

390

</li>

391

<li>for_update=False – when <tt class="docutils literal">True</tt>, applies <tt class="docutils literal">FOR UPDATE</tt> to the end of the

392

resulting statement.

393

Certain database dialects also support

394

alternate values for this parameter:

395

<ul>

396

<li>With the MySQL dialect, the value <tt class="docutils literal">"read"</tt> translates to

397

<tt class="docutils literal">LOCK IN SHARE MODE</tt>.</li>

398

<li>With the Oracle and Postgresql dialects, the value <tt class="docutils literal">"nowait"</tt>

399

translates to <tt class="docutils literal">FOR UPDATE NOWAIT</tt>.</li>

400

<li>With the Postgresql dialect, the values “read” and <tt class="docutils literal">"read_nowait"</tt>

401

translate to <tt class="docutils literal">FOR SHARE</tt> and <tt class="docutils literal">FOR SHARE NOWAIT</tt>, respectively.<div class="versionadded">

402

New in version 0.7.7.

403

</div>

404

</li>

405

</ul>

406

</li>

407

<li>group_by – a list of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a> objects which will comprise the

408

<tt class="docutils literal">GROUP BY</tt> clause of the resulting select.</li>

409

<li>having – a <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a> that will comprise the <tt class="docutils literal">HAVING</tt> clause

410

of the resulting select when <tt class="docutils literal">GROUP BY</tt> is used.</li>

411

<li>limit=None – a numerical value which usually compiles to a <tt class="docutils literal">LIMIT</tt>

412

expression in the resulting select. Databases that don’t

413

support <tt class="docutils literal">LIMIT</tt> will attempt to provide similar

414

functionality.</li>

415

<li>offset=None – a numeric value which usually compiles to an <tt class="docutils literal">OFFSET</tt>

416

expression in the resulting select. Databases that don’t

417

support <tt class="docutils literal">OFFSET</tt> will attempt to provide similar

418

functionality.</li>

419

<li>order_by – a scalar or list of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a> objects which will

420

comprise the <tt class="docutils literal">ORDER BY</tt> clause of the resulting select.</li>

421

<li>use_labels=False – when <tt class="docutils literal">True</tt>, the statement will be generated using labels

422

for each column in the columns clause, which qualify each

423

column with its parent table’s (or aliases) name so that name

424

conflicts between columns in different tables don’t occur.

425

The format of the label is <tablename>_<column>. The “c”

426

collection of the resulting <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> object will use these

427

names as well for targeting column members.

428

use_labels is also available via the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.apply_labels" title="sqlalchemy.sql.expression.SelectBase.apply_labels"><tt class="xref py py-meth docutils literal">apply_labels()</tt></a>

429

generative method.

430

</li>

431

</ul>

432

</td>

433

</tr>

434

</tbody>

435

</table>

436

</dd></dl>

437

438

439

440

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">subquery</tt><big>(</big>alias, *args, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.subquery" title="Permalink to this definition">¶</a></dt>

441

<dd>Return an <a class="reference internal" href="#sqlalchemy.sql.expression.Alias" title="sqlalchemy.sql.expression.Alias"><tt class="xref py py-class docutils literal">Alias</tt></a> object derived

442

from a <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>.

443

444

445

<dd>alias name</dd>

446

</dl>

447

*args, **kwargs

448

449

<div>all other arguments are delivered to the

450

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> function.</div></blockquote>

451

</dd></dl>

452

453

454

455

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">table</tt><big>(</big>name, *columns<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.table" title="Permalink to this definition">¶</a></dt>

456

<dd>Represent a textual table clause.

457

The object returned is an instance of <a class="reference internal" href="#sqlalchemy.sql.expression.TableClause" title="sqlalchemy.sql.expression.TableClause"><tt class="xref py py-class docutils literal">TableClause</tt></a>, which

458

represents the “syntactical” portion of the schema-level

459

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> object.

460

It may be used to construct lightweight table constructs.

461

Note that the <a class="reference internal" href="#sqlalchemy.sql.expression.table" title="sqlalchemy.sql.expression.table"><tt class="xref py py-func docutils literal">table()</tt></a> function is not part of

462

the <tt class="docutils literal">sqlalchemy</tt> namespace. It must be imported from the

463

<tt class="docutils literal">sql</tt> package:

464

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy.sql import table, column</pre></div>

465

</div>

466

467

468

469

470

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

471

<li>name – Name of the table.</li>

472

<li>columns – A collection of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.column" title="sqlalchemy.sql.expression.column"><tt class="xref py py-func docutils literal">column()</tt></a> constructs.</li>

473

</ul>

474

</td>

475

</tr>

476

</tbody>

477

</table>

478

See <a class="reference internal" href="#sqlalchemy.sql.expression.TableClause" title="sqlalchemy.sql.expression.TableClause"><tt class="xref py py-class docutils literal">TableClause</tt></a> for further examples.

479

</dd></dl>

480

481

482

483

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">union</tt><big>(</big>*selects, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.union" title="Permalink to this definition">¶</a></dt>

484

<dd>Return a <tt class="docutils literal">UNION</tt> of multiple selectables.

485

The returned object is an instance of

486

<a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect" title="sqlalchemy.sql.expression.CompoundSelect"><tt class="xref py py-class docutils literal">CompoundSelect</tt></a>.

487

A similar <a class="reference internal" href="#sqlalchemy.sql.expression.union" title="sqlalchemy.sql.expression.union"><tt class="xref py py-func docutils literal">union()</tt></a> method is available on all

488

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> subclasses.

489

490

<dt>*selects</dt>

491

<dd>a list of <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> instances.</dd>

492

<dt>**kwargs</dt>

493

<dd>available keyword arguments are the same as those of

494

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>.</dd>

495

</dl>

496

</dd></dl>

497

498

499

500

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">union_all</tt><big>(</big>*selects, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.union_all" title="Permalink to this definition">¶</a></dt>

501

<dd>Return a <tt class="docutils literal">UNION ALL</tt> of multiple selectables.

502

The returned object is an instance of

503

<a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect" title="sqlalchemy.sql.expression.CompoundSelect"><tt class="xref py py-class docutils literal">CompoundSelect</tt></a>.

504

A similar <a class="reference internal" href="#sqlalchemy.sql.expression.union_all" title="sqlalchemy.sql.expression.union_all"><tt class="xref py py-func docutils literal">union_all()</tt></a> method is available on all

505

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> subclasses.

506

507

<dt>*selects</dt>

508

<dd>a list of <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> instances.</dd>

509

<dt>**kwargs</dt>

510

<dd>available keyword arguments are the same as those of

511

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>.</dd>

512

</dl>

513

</dd></dl>

514

515

516

517

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">Alias</tt><big>(</big>selectable, name=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias" title="Permalink to this definition">¶</a></dt>

518

<dd>Bases: <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.FromClause</tt></a>

519

Represents an table or selectable alias (AS).

520

Represents an alias, as typically applied to any table or

521

sub-select within a SQL statement using the <tt class="docutils literal">AS</tt> keyword (or

522

without the keyword on certain databases such as Oracle).

523

This object is constructed from the <a class="reference internal" href="#sqlalchemy.sql.expression.alias" title="sqlalchemy.sql.expression.alias"><tt class="xref py py-func docutils literal">alias()</tt></a> module level

524

function as well as the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.alias" title="sqlalchemy.sql.expression.FromClause.alias"><tt class="xref py py-meth docutils literal">FromClause.alias()</tt></a> method available on all

525

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> subclasses.

526

527

528

<tt class="descname">alias</tt><big>(</big>name=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.alias" title="Permalink to this definition">¶</a></dt>

529

530

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.alias" title="sqlalchemy.sql.expression.FromClause.alias"><tt class="xref py py-meth docutils literal">alias()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

531

return an alias of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

532

This is shorthand for calling:

533

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import alias

534

a = alias(self, name=name)</pre></div>

535

</div>

536

See <a class="reference internal" href="#sqlalchemy.sql.expression.alias" title="sqlalchemy.sql.expression.alias"><tt class="xref py py-func docutils literal">alias()</tt></a> for details.

537

</dd></dl>

538

539

540

541

542

543

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.c" title="sqlalchemy.sql.expression.FromClause.c"><tt class="xref py py-attr docutils literal">c</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

544

An alias for the <a class="reference internal" href="#sqlalchemy.sql.expression.Alias.columns" title="sqlalchemy.sql.expression.Alias.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute.

545

</dd></dl>

546

547

548

549

<tt class="descname">columns</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.columns" title="Permalink to this definition">¶</a></dt>

550

551

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.columns" title="sqlalchemy.sql.expression.FromClause.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

552

A named-based collection of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> objects

553

maintained by this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

554

The <a class="reference internal" href="#sqlalchemy.sql.expression.Alias.columns" title="sqlalchemy.sql.expression.Alias.columns"><tt class="xref py py-attr docutils literal">columns</tt></a>, or <a class="reference internal" href="#sqlalchemy.sql.expression.Alias.c" title="sqlalchemy.sql.expression.Alias.c"><tt class="xref py py-attr docutils literal">c</tt></a> collection, is the gateway

555

to the construction of SQL expressions using table-bound or

556

other selectable-bound columns:

557

<div class="highlight-python"><div class="highlight"><pre>select([mytable]).where(mytable.c.somecolumn == 5)</pre></div>

558

</div>

559

</dd></dl>

560

561

562

563

<tt class="descname">compare</tt><big>(</big>other, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.compare" title="Permalink to this definition">¶</a></dt>

564

565

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compare" title="sqlalchemy.sql.expression.ClauseElement.compare"><tt class="xref py py-meth docutils literal">compare()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

566

Compare this ClauseElement to the given ClauseElement.

567

Subclasses should override the default behavior, which is a

568

straight identity comparison.

569

**kw are arguments consumed by subclass compare() methods and

570

may be used to modify the criteria for comparison.

571

(see <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>)

572

</dd></dl>

573

574

575

576

<tt class="descname">compile</tt><big>(</big>bind=None, dialect=None, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.compile" title="Permalink to this definition">¶</a></dt>

577

578

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compile" title="sqlalchemy.sql.expression.ClauseElement.compile"><tt class="xref py py-meth docutils literal">compile()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

579

Compile this SQL expression.

580

The return value is a <a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object.

581

Calling <tt class="docutils literal">str()</tt> or <tt class="docutils literal">unicode()</tt> on the returned value will yield a

582

string representation of the result. The

583

<a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object also can return a

584

dictionary of bind parameter names and values

585

using the <tt class="docutils literal">params</tt> accessor.

586

587

588

589

590

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

591

<li>bind – An <tt class="docutils literal">Engine</tt> or <tt class="docutils literal">Connection</tt> from which a

592

<tt class="docutils literal">Compiled</tt> will be acquired. This argument takes precedence over

593

this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if any.</li>

594

<li>column_keys – Used for INSERT and UPDATE statements, a list of

595

column names which should be present in the VALUES clause of the

596

compiled statement. If <tt class="docutils literal">None</tt>, all columns from the target table

597

object are rendered.</li>

598

<li>dialect – A <tt class="docutils literal">Dialect</tt> instance from which a <tt class="docutils literal">Compiled</tt>

599

will be acquired. This argument takes precedence over the <cite>bind</cite>

600

argument as well as this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if

601

any.</li>

602

<li>inline – Used for INSERT statements, for a dialect which does

603

not support inline retrieval of newly generated primary key

604

columns, will force the expression used to create the new primary

605

key value to be rendered inline within the INSERT statement’s

606

VALUES clause. This typically refers to Sequence execution but may

607

also refer to any server-side default generation function

608

associated with a primary key <cite>Column</cite>.</li>

609

</ul>

610

</td>

611

</tr>

612

</tbody>

613

</table>

614

</dd></dl>

615

616

617

618

<tt class="descname">correspond_on_equivalents</tt><big>(</big>column, equivalents<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.correspond_on_equivalents" title="Permalink to this definition">¶</a></dt>

619

620

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.correspond_on_equivalents" title="sqlalchemy.sql.expression.FromClause.correspond_on_equivalents"><tt class="xref py py-meth docutils literal">correspond_on_equivalents()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

621

Return corresponding_column for the given column, or if None

622

search for a match in the given dictionary.

623

</dd></dl>

624

625

626

627

<tt class="descname">corresponding_column</tt><big>(</big>column, require_embedded=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.corresponding_column" title="Permalink to this definition">¶</a></dt>

628

629

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.corresponding_column" title="sqlalchemy.sql.expression.FromClause.corresponding_column"><tt class="xref py py-meth docutils literal">corresponding_column()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

630

Given a <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, return the exported

631

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> object from this <a class="reference internal" href="#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a>

632

which corresponds to that original

633

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a> via a common ancestor

634

column.

635

636

637

638

639

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

640

<li>column – the target <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> to be matched</li>

641

<li>require_embedded – only return corresponding columns for</li>

642

</ul>

643

</td>

644

</tr>

645

</tbody>

646

</table>

647

the given <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, if the given

648

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> is actually present within a sub-element

649

of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>. Normally the column will match if

650

it merely shares a common ancestor with one of the exported

651

columns of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

652

</dd></dl>

653

654

655

656

<tt class="descname">count</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.count" title="Permalink to this definition">¶</a></dt>

657

658

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.count" title="sqlalchemy.sql.expression.FromClause.count"><tt class="xref py py-meth docutils literal">count()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

659

return a SELECT COUNT generated against this

660

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

661

</dd></dl>

662

663

664

665

<tt class="descname">foreign_keys</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.foreign_keys" title="Permalink to this definition">¶</a></dt>

666

667

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.foreign_keys" title="sqlalchemy.sql.expression.FromClause.foreign_keys"><tt class="xref py py-attr docutils literal">foreign_keys</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

668

Return the collection of ForeignKey objects which this

669

FromClause references.

670

</dd></dl>

671

672

673

674

<tt class="descname">join</tt><big>(</big>right, onclause=None, isouter=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.join" title="Permalink to this definition">¶</a></dt>

675

676

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">join()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

677

return a join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

678

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

679

</dd></dl>

680

681

682

683

<tt class="descname">outerjoin</tt><big>(</big>right, onclause=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.outerjoin" title="Permalink to this definition">¶</a></dt>

684

685

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.outerjoin" title="sqlalchemy.sql.expression.FromClause.outerjoin"><tt class="xref py py-meth docutils literal">outerjoin()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

686

return an outer join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

687

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

688

</dd></dl>

689

690

691

692

<tt class="descname">params</tt><big>(</big>*optionaldict, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.params" title="Permalink to this definition">¶</a></dt>

693

694

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.params" title="sqlalchemy.sql.expression.ClauseElement.params"><tt class="xref py py-meth docutils literal">params()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

695

Return a copy with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> elements replaced.

696

Returns a copy of this ClauseElement with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a>

697

elements replaced with values taken from the given dictionary:

698

<div class="highlight-python"><div class="highlight"><pre>>>> clause = column('x') + bindparam('foo')

699

>>> print clause.compile().params

700

{'foo':None}

701

>>> print clause.params({'foo':7}).compile().params

702

{'foo':7}</pre></div>

703

</div>

704

</dd></dl>

705

706

707

708

<tt class="descname">primary_key</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.primary_key" title="Permalink to this definition">¶</a></dt>

709

710

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.primary_key" title="sqlalchemy.sql.expression.FromClause.primary_key"><tt class="xref py py-attr docutils literal">primary_key</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

711

Return the collection of Column objects which comprise the

712

primary key of this FromClause.

713

</dd></dl>

714

715

716

717

<tt class="descname">replace_selectable</tt><big>(</big>old, alias<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.replace_selectable" title="Permalink to this definition">¶</a></dt>

718

719

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.replace_selectable" title="sqlalchemy.sql.expression.FromClause.replace_selectable"><tt class="xref py py-meth docutils literal">replace_selectable()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

720

replace all occurrences of FromClause ‘old’ with the given Alias

721

object, returning a copy of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

722

</dd></dl>

723

724

725

726

<tt class="descname">select</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.select" title="Permalink to this definition">¶</a></dt>

727

728

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.select" title="sqlalchemy.sql.expression.FromClause.select"><tt class="xref py py-meth docutils literal">select()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

729

return a SELECT of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

730

731

See also

732

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> - general purpose

733

method which allows for arbitrary column lists.

734

</div>

735

</dd></dl>

736

737

738

739

<tt class="descname">self_group</tt><big>(</big>against=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.self_group" title="Permalink to this definition">¶</a></dt>

740

741

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.self_group" title="sqlalchemy.sql.expression.ClauseElement.self_group"><tt class="xref py py-meth docutils literal">self_group()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

742

Apply a ‘grouping’ to this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>.

743

This method is overridden by subclasses to return a

744

“grouping” construct, i.e. parenthesis. In particular

745

it’s used by “binary” expressions to provide a grouping

746

around themselves when placed into a larger expression,

747

as well as by <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> constructs when placed into

748

the FROM clause of another <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>. (Note that

749

subqueries should be normally created using the

750

<tt class="xref py py-func docutils literal">Select.alias()</tt> method, as many platforms require

751

nested SELECT statements to be named).

752

As expressions are composed together, the application of

753

<a class="reference internal" href="#sqlalchemy.sql.expression.Alias.self_group" title="sqlalchemy.sql.expression.Alias.self_group"><tt class="xref py py-meth docutils literal">self_group()</tt></a> is automatic - end-user code should never

754

need to use this method directly. Note that SQLAlchemy’s

755

clause constructs take operator precedence into account -

756

so parenthesis might not be needed, for example, in

757

an expression like <tt class="docutils literal">x OR (y AND z)</tt> - AND takes precedence

758

over OR.

759

The base <a class="reference internal" href="#sqlalchemy.sql.expression.Alias.self_group" title="sqlalchemy.sql.expression.Alias.self_group"><tt class="xref py py-meth docutils literal">self_group()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>

760

just returns self.

761

</dd></dl>

762

763

764

765

<tt class="descname">unique_params</tt><big>(</big>*optionaldict, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Alias.unique_params" title="Permalink to this definition">¶</a></dt>

766

767

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.unique_params" title="sqlalchemy.sql.expression.ClauseElement.unique_params"><tt class="xref py py-meth docutils literal">unique_params()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

768

Return a copy with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> elements replaced.

769

Same functionality as <tt class="docutils literal">params()</tt>, except adds <cite>unique=True</cite>

770

to affected bind parameters so that multiple statements can be

771

used.

772

</dd></dl>

773

774

</dd></dl>

775

776

777

778

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">CompoundSelect</tt><big>(</big>keyword, *selects, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect" title="Permalink to this definition">¶</a></dt>

779

<dd>Bases: <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.SelectBase</tt></a>

780

781

<dt>Forms the basis of <tt class="docutils literal">UNION</tt>, <tt class="docutils literal">UNION ALL</tt>, and other</dt>

782

<dd>SELECT-based set operations.</dd>

783

</dl>

784

785

See also

786

<a class="reference internal" href="#sqlalchemy.sql.expression.union" title="sqlalchemy.sql.expression.union"><tt class="xref py py-func docutils literal">union()</tt></a>

787

<a class="reference internal" href="#sqlalchemy.sql.expression.union_all" title="sqlalchemy.sql.expression.union_all"><tt class="xref py py-func docutils literal">union_all()</tt></a>

788

<a class="reference internal" href="#sqlalchemy.sql.expression.intersect" title="sqlalchemy.sql.expression.intersect"><tt class="xref py py-func docutils literal">intersect()</tt></a>

789

<a class="reference internal" href="#sqlalchemy.sql.expression.intersect_all" title="sqlalchemy.sql.expression.intersect_all"><tt class="xref py py-func docutils literal">intersect_all()</tt></a>

790

<tt class="xref py py-func docutils literal">except()</tt>

791

<a class="reference internal" href="#sqlalchemy.sql.expression.except_all" title="sqlalchemy.sql.expression.except_all"><tt class="xref py py-func docutils literal">except_all()</tt></a>

792

</div>

793

794

795

<tt class="descname">alias</tt><big>(</big>name=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.alias" title="Permalink to this definition">¶</a></dt>

796

797

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.alias" title="sqlalchemy.sql.expression.FromClause.alias"><tt class="xref py py-meth docutils literal">alias()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

798

return an alias of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

799

This is shorthand for calling:

800

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import alias

801

a = alias(self, name=name)</pre></div>

802

</div>

803

See <a class="reference internal" href="#sqlalchemy.sql.expression.alias" title="sqlalchemy.sql.expression.alias"><tt class="xref py py-func docutils literal">alias()</tt></a> for details.

804

</dd></dl>

805

806

807

808

<tt class="descname">append_group_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.append_group_by" title="Permalink to this definition">¶</a></dt>

809

810

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.append_group_by" title="sqlalchemy.sql.expression.SelectBase.append_group_by"><tt class="xref py py-meth docutils literal">append_group_by()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

811

Append the given GROUP BY criterion applied to this selectable.

812

The criterion will be appended to any pre-existing GROUP BY criterion.

813

This is an in-place mutation method; the

814

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.group_by" title="sqlalchemy.sql.expression.SelectBase.group_by"><tt class="xref py py-meth docutils literal">group_by()</tt></a> method is preferred, as it provides standard

815

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

816

</dd></dl>

817

818

819

820

<tt class="descname">append_order_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.append_order_by" title="Permalink to this definition">¶</a></dt>

821

822

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.append_order_by" title="sqlalchemy.sql.expression.SelectBase.append_order_by"><tt class="xref py py-meth docutils literal">append_order_by()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

823

Append the given ORDER BY criterion applied to this selectable.

824

The criterion will be appended to any pre-existing ORDER BY criterion.

825

This is an in-place mutation method; the

826

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.order_by" title="sqlalchemy.sql.expression.SelectBase.order_by"><tt class="xref py py-meth docutils literal">order_by()</tt></a> method is preferred, as it provides standard

827

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

828

</dd></dl>

829

830

831

832

<tt class="descname">apply_labels</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.apply_labels" title="Permalink to this definition">¶</a></dt>

833

834

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.apply_labels" title="sqlalchemy.sql.expression.SelectBase.apply_labels"><tt class="xref py py-meth docutils literal">apply_labels()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

835

return a new selectable with the ‘use_labels’ flag set to True.

836

This will result in column expressions being generated using labels

837

against their table name, such as “SELECT somecolumn AS

838

tablename_somecolumn”. This allows selectables which contain multiple

839

FROM clauses to produce a unique set of column names regardless of

840

name conflicts among the individual FROM clauses.

841

</dd></dl>

842

843

844

845

<tt class="descname">as_scalar</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.as_scalar" title="Permalink to this definition">¶</a></dt>

846

847

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.as_scalar" title="sqlalchemy.sql.expression.SelectBase.as_scalar"><tt class="xref py py-meth docutils literal">as_scalar()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

848

return a ‘scalar’ representation of this selectable, which can be

849

used as a column expression.

850

Typically, a select statement which has only one column in its columns

851

clause is eligible to be used as a scalar expression.

852

The returned object is an instance of

853

<tt class="xref py py-class docutils literal">ScalarSelect</tt>.

854

</dd></dl>

855

856

857

858

<tt class="descname">autocommit</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.autocommit" title="Permalink to this definition">¶</a></dt>

859

860

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.autocommit" title="sqlalchemy.sql.expression.SelectBase.autocommit"><tt class="xref py py-meth docutils literal">autocommit()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

861

return a new selectable with the ‘autocommit’ flag set to

862

863

Deprecated since version 0.6: <tt class="xref py py-func docutils literal">autocommit()</tt> is deprecated. Use <tt class="xref py py-func docutils literal">Executable.execution_options()</tt> with the ‘autocommit’ flag.

864

</div>

865

True.

866

</dd></dl>

867

868

869

870

871

872

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.c" title="sqlalchemy.sql.expression.FromClause.c"><tt class="xref py py-attr docutils literal">c</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

873

An alias for the <a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect.columns" title="sqlalchemy.sql.expression.CompoundSelect.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute.

874

</dd></dl>

875

876

877

878

<tt class="descname">columns</tt><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.columns" title="Permalink to this definition">¶</a></dt>

879

880

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.columns" title="sqlalchemy.sql.expression.FromClause.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

881

A named-based collection of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> objects

882

maintained by this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

883

The <a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect.columns" title="sqlalchemy.sql.expression.CompoundSelect.columns"><tt class="xref py py-attr docutils literal">columns</tt></a>, or <a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect.c" title="sqlalchemy.sql.expression.CompoundSelect.c"><tt class="xref py py-attr docutils literal">c</tt></a> collection, is the gateway

884

to the construction of SQL expressions using table-bound or

885

other selectable-bound columns:

886

<div class="highlight-python"><div class="highlight"><pre>select([mytable]).where(mytable.c.somecolumn == 5)</pre></div>

887

</div>

888

</dd></dl>

889

890

891

892

<tt class="descname">compare</tt><big>(</big>other, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.compare" title="Permalink to this definition">¶</a></dt>

893

894

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compare" title="sqlalchemy.sql.expression.ClauseElement.compare"><tt class="xref py py-meth docutils literal">compare()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

895

Compare this ClauseElement to the given ClauseElement.

896

Subclasses should override the default behavior, which is a

897

straight identity comparison.

898

**kw are arguments consumed by subclass compare() methods and

899

may be used to modify the criteria for comparison.

900

(see <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>)

901

</dd></dl>

902

903

904

905

<tt class="descname">compile</tt><big>(</big>bind=None, dialect=None, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.compile" title="Permalink to this definition">¶</a></dt>

906

907

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compile" title="sqlalchemy.sql.expression.ClauseElement.compile"><tt class="xref py py-meth docutils literal">compile()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

908

Compile this SQL expression.

909

The return value is a <a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object.

910

Calling <tt class="docutils literal">str()</tt> or <tt class="docutils literal">unicode()</tt> on the returned value will yield a

911

string representation of the result. The

912

<a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object also can return a

913

dictionary of bind parameter names and values

914

using the <tt class="docutils literal">params</tt> accessor.

915

916

917

918

919

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

920

<li>bind – An <tt class="docutils literal">Engine</tt> or <tt class="docutils literal">Connection</tt> from which a

921

<tt class="docutils literal">Compiled</tt> will be acquired. This argument takes precedence over

922

this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if any.</li>

923

<li>column_keys – Used for INSERT and UPDATE statements, a list of

924

column names which should be present in the VALUES clause of the

925

compiled statement. If <tt class="docutils literal">None</tt>, all columns from the target table

926

object are rendered.</li>

927

<li>dialect – A <tt class="docutils literal">Dialect</tt> instance from which a <tt class="docutils literal">Compiled</tt>

928

will be acquired. This argument takes precedence over the <cite>bind</cite>

929

argument as well as this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if

930

any.</li>

931

<li>inline – Used for INSERT statements, for a dialect which does

932

not support inline retrieval of newly generated primary key

933

columns, will force the expression used to create the new primary

934

key value to be rendered inline within the INSERT statement’s

935

VALUES clause. This typically refers to Sequence execution but may

936

also refer to any server-side default generation function

937

associated with a primary key <cite>Column</cite>.</li>

938

</ul>

939

</td>

940

</tr>

941

</tbody>

942

</table>

943

</dd></dl>

944

945

946

947

<tt class="descname">correspond_on_equivalents</tt><big>(</big>column, equivalents<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.correspond_on_equivalents" title="Permalink to this definition">¶</a></dt>

948

949

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.correspond_on_equivalents" title="sqlalchemy.sql.expression.FromClause.correspond_on_equivalents"><tt class="xref py py-meth docutils literal">correspond_on_equivalents()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

950

Return corresponding_column for the given column, or if None

951

search for a match in the given dictionary.

952

</dd></dl>

953

954

955

956

<tt class="descname">corresponding_column</tt><big>(</big>column, require_embedded=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.corresponding_column" title="Permalink to this definition">¶</a></dt>

957

958

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.corresponding_column" title="sqlalchemy.sql.expression.FromClause.corresponding_column"><tt class="xref py py-meth docutils literal">corresponding_column()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

959

Given a <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, return the exported

960

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> object from this <a class="reference internal" href="#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a>

961

which corresponds to that original

962

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a> via a common ancestor

963

column.

964

965

966

967

968

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

969

<li>column – the target <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> to be matched</li>

970

<li>require_embedded – only return corresponding columns for</li>

971

</ul>

972

</td>

973

</tr>

974

</tbody>

975

</table>

976

the given <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, if the given

977

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> is actually present within a sub-element

978

of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>. Normally the column will match if

979

it merely shares a common ancestor with one of the exported

980

columns of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

981

</dd></dl>

982

983

984

985

<tt class="descname">count</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.count" title="Permalink to this definition">¶</a></dt>

986

987

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.count" title="sqlalchemy.sql.expression.FromClause.count"><tt class="xref py py-meth docutils literal">count()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

988

return a SELECT COUNT generated against this

989

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

990

</dd></dl>

991

992

993

994

<tt class="descname">cte</tt><big>(</big>name=None, recursive=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.cte" title="Permalink to this definition">¶</a></dt>

995

996

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.cte" title="sqlalchemy.sql.expression.SelectBase.cte"><tt class="xref py py-meth docutils literal">cte()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

997

Return a new <a class="reference internal" href="#sqlalchemy.sql.expression.CTE" title="sqlalchemy.sql.expression.CTE"><tt class="xref py py-class docutils literal">CTE</tt></a>, or Common Table Expression instance.

998

Common table expressions are a SQL standard whereby SELECT

999

statements can draw upon secondary statements specified along

1000

with the primary statement, using a clause called “WITH”.

1001

Special semantics regarding UNION can also be employed to

1002

allow “recursive” queries, where a SELECT statement can draw

1003

upon the set of rows that have previously been selected.

1004

SQLAlchemy detects <a class="reference internal" href="#sqlalchemy.sql.expression.CTE" title="sqlalchemy.sql.expression.CTE"><tt class="xref py py-class docutils literal">CTE</tt></a> objects, which are treated

1005

similarly to <a class="reference internal" href="#sqlalchemy.sql.expression.Alias" title="sqlalchemy.sql.expression.Alias"><tt class="xref py py-class docutils literal">Alias</tt></a> objects, as special elements

1006

to be delivered to the FROM clause of the statement as well

1007

as to a WITH clause at the top of the statement.

1008

1009

New in version 0.7.6.

1010

</div>

1011

1012

1013

1014

1015

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

1016

<li>name – name given to the common table expression. Like

1017

<tt class="xref py py-meth docutils literal">_FromClause.alias()</tt>, the name can be left as <tt class="docutils literal">None</tt>

1018

in which case an anonymous symbol will be used at query

1019

compile time.</li>

1020

<li>recursive – if <tt class="docutils literal">True</tt>, will render <tt class="docutils literal">WITH RECURSIVE</tt>.

1021

A recursive common table expression is intended to be used in

1022

conjunction with UNION ALL in order to derive rows

1023

from those already selected.</li>

1024

</ul>

1025

</td>

1026

</tr>

1027

</tbody>

1028

</table>

1029

The following examples illustrate two examples from

1030

Postgresql’s documentation at

1031

<a class="reference external" href="http://www.postgresql.org/docs/8.4/static/queries-with.html">http://www.postgresql.org/docs/8.4/static/queries-with.html</a>.

1032

Example 1, non recursive:

1033

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import Table, Column, String, Integer, MetaData, \

1034

select, func

1035

1036

metadata = MetaData()

1037

1038

orders = Table('orders', metadata,

1039

Column('region', String),

1040

Column('amount', Integer),

1041

Column('product', String),

1042

Column('quantity', Integer)

1043

)

1044

1045

regional_sales = select([

1046

orders.c.region,

1047

func.sum(orders.c.amount).label('total_sales')

1048

]).group_by(orders.c.region).cte("regional_sales")

1049

1050

1051

top_regions = select([regional_sales.c.region]).\

1052

where(

1053

regional_sales.c.total_sales >

1054

select([

1055

func.sum(regional_sales.c.total_sales)/10

1056

])

1057

).cte("top_regions")

1058

1059

statement = select([

1060

orders.c.region,

1061

orders.c.product,

1062

func.sum(orders.c.quantity).label("product_units"),

1063

func.sum(orders.c.amount).label("product_sales")

1064

]).where(orders.c.region.in_(

1065

select([top_regions.c.region])

1066

)).group_by(orders.c.region, orders.c.product)

1067

1068

result = conn.execute(statement).fetchall()</pre></div>

1069

</div>

1070

Example 2, WITH RECURSIVE:

1071

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import Table, Column, String, Integer, MetaData, \

1072

select, func

1073

1074

metadata = MetaData()

1075

1076

parts = Table('parts', metadata,

1077

Column('part', String),

1078

Column('sub_part', String),

1079

Column('quantity', Integer),

1080

)

1081

1082

included_parts = select([

1083

parts.c.sub_part,

1084

parts.c.part,

1085

parts.c.quantity]).\

1086

where(parts.c.part=='our part').\

1087

cte(recursive=True)

1088

1089

1090

incl_alias = included_parts.alias()

1091

parts_alias = parts.alias()

1092

included_parts = included_parts.union_all(

1093

select([

1094

parts_alias.c.part,

1095

parts_alias.c.sub_part,

1096

parts_alias.c.quantity

1097

]).

1098

where(parts_alias.c.part==incl_alias.c.sub_part)

1099

)

1100

1101

statement = select([

1102

included_parts.c.sub_part,

1103

func.sum(included_parts.c.quantity).

1104

label('total_quantity')

1105

]). select_from(included_parts.join(parts,

1106

included_parts.c.part==parts.c.part)).\

1107

group_by(included_parts.c.sub_part)

1108

1109

result = conn.execute(statement).fetchall()</pre></div>

1110

</div>

1111

1112

See also

1113

<a class="reference internal" href="../orm/query.html#sqlalchemy.orm.query.Query.cte" title="sqlalchemy.orm.query.Query.cte"><tt class="xref py py-meth docutils literal">orm.query.Query.cte()</tt></a> - ORM version of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.cte" title="sqlalchemy.sql.expression.SelectBase.cte"><tt class="xref py py-meth docutils literal">SelectBase.cte()</tt></a>.

1114

</div>

1115

</dd></dl>

1116

1117

1118

1119

<tt class="descname">description</tt><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.description" title="Permalink to this definition">¶</a></dt>

1120

1121

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.description" title="sqlalchemy.sql.expression.FromClause.description"><tt class="xref py py-attr docutils literal">description</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1122

a brief description of this FromClause.

1123

Used primarily for error message formatting.

1124

</dd></dl>

1125

1126

1127

1128

<tt class="descname">execute</tt><big>(</big>*multiparams, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.execute" title="Permalink to this definition">¶</a></dt>

1129

1130

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.Executable.execute" title="sqlalchemy.sql.expression.Executable.execute"><tt class="xref py py-meth docutils literal">execute()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a></div>

1131

Compile and execute this <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a>.

1132

</dd></dl>

1133

1134

1135

1136

<tt class="descname">execution_options</tt><big>(</big>**kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.execution_options" title="Permalink to this definition">¶</a></dt>

1137

1138

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.Executable.execution_options" title="sqlalchemy.sql.expression.Executable.execution_options"><tt class="xref py py-meth docutils literal">execution_options()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a></div>

1139

Set non-SQL options for the statement which take effect during

1140

execution.

1141

Execution options can be set on a per-statement or

1142

per <a class="reference internal" href="connections.html#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a> basis. Additionally, the

1143

<a class="reference internal" href="connections.html#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> and ORM <a class="reference internal" href="../orm/query.html#sqlalchemy.orm.query.Query" title="sqlalchemy.orm.query.Query"><tt class="xref py py-class docutils literal">Query</tt></a> objects provide

1144

access to execution options which they in turn configure upon

1145

connections.

1146

The <a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect.execution_options" title="sqlalchemy.sql.expression.CompoundSelect.execution_options"><tt class="xref py py-meth docutils literal">execution_options()</tt></a> method is generative. A new

1147

instance of this statement is returned that contains the options:

1148

<div class="highlight-python"><div class="highlight"><pre>statement = select([table.c.x, table.c.y])

1149

statement = statement.execution_options(autocommit=True)</pre></div>

1150

</div>

1151

Note that only a subset of possible execution options can be applied

1152

to a statement - these include “autocommit” and “stream_results”,

1153

but not “isolation_level” or “compiled_cache”.

1154

See <a class="reference internal" href="connections.html#sqlalchemy.engine.Connection.execution_options" title="sqlalchemy.engine.Connection.execution_options"><tt class="xref py py-meth docutils literal">Connection.execution_options()</tt></a> for a full list of

1155

possible options.

1156

1157

See also

1158

<a class="reference internal" href="connections.html#sqlalchemy.engine.Connection.execution_options" title="sqlalchemy.engine.Connection.execution_options"><tt class="xref py py-meth docutils literal">Connection.execution_options()</tt></a>

1159

<a class="reference internal" href="../orm/query.html#sqlalchemy.orm.query.Query.execution_options" title="sqlalchemy.orm.query.Query.execution_options"><tt class="xref py py-meth docutils literal">Query.execution_options()</tt></a>

1160

</div>

1161

</dd></dl>

1162

1163

1164

1165

<tt class="descname">foreign_keys</tt><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.foreign_keys" title="Permalink to this definition">¶</a></dt>

1166

1167

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.foreign_keys" title="sqlalchemy.sql.expression.FromClause.foreign_keys"><tt class="xref py py-attr docutils literal">foreign_keys</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1168

Return the collection of ForeignKey objects which this

1169

FromClause references.

1170

</dd></dl>

1171

1172

1173

1174

<tt class="descname">group_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.group_by" title="Permalink to this definition">¶</a></dt>

1175

1176

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.group_by" title="sqlalchemy.sql.expression.SelectBase.group_by"><tt class="xref py py-meth docutils literal">group_by()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

1177

return a new selectable with the given list of GROUP BY

1178

criterion applied.

1179

The criterion will be appended to any pre-existing GROUP BY

1180

criterion.

1181

</dd></dl>

1182

1183

1184

1185

<tt class="descname">join</tt><big>(</big>right, onclause=None, isouter=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.join" title="Permalink to this definition">¶</a></dt>

1186

1187

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">join()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1188

return a join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

1189

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1190

</dd></dl>

1191

1192

1193

1194

<tt class="descname">label</tt><big>(</big>name<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.label" title="Permalink to this definition">¶</a></dt>

1195

1196

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.label" title="sqlalchemy.sql.expression.SelectBase.label"><tt class="xref py py-meth docutils literal">label()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

1197

return a ‘scalar’ representation of this selectable, embedded as a

1198

subquery with a label.

1199

1200

See also

1201

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.as_scalar" title="sqlalchemy.sql.expression.SelectBase.as_scalar"><tt class="xref py py-meth docutils literal">as_scalar()</tt></a>.

1202

</div>

1203

</dd></dl>

1204

1205

1206

1207

<tt class="descname">limit</tt><big>(</big>limit<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.limit" title="Permalink to this definition">¶</a></dt>

1208

1209

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.limit" title="sqlalchemy.sql.expression.SelectBase.limit"><tt class="xref py py-meth docutils literal">limit()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

1210

return a new selectable with the given LIMIT criterion

1211

applied.

1212

</dd></dl>

1213

1214

1215

1216

<tt class="descname">offset</tt><big>(</big>offset<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.offset" title="Permalink to this definition">¶</a></dt>

1217

1218

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.offset" title="sqlalchemy.sql.expression.SelectBase.offset"><tt class="xref py py-meth docutils literal">offset()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

1219

return a new selectable with the given OFFSET criterion

1220

applied.

1221

</dd></dl>

1222

1223

1224

1225

<tt class="descname">order_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.order_by" title="Permalink to this definition">¶</a></dt>

1226

1227

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.order_by" title="sqlalchemy.sql.expression.SelectBase.order_by"><tt class="xref py py-meth docutils literal">order_by()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

1228

return a new selectable with the given list of ORDER BY

1229

criterion applied.

1230

The criterion will be appended to any pre-existing ORDER BY

1231

criterion.

1232

</dd></dl>

1233

1234

1235

1236

<tt class="descname">outerjoin</tt><big>(</big>right, onclause=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.outerjoin" title="Permalink to this definition">¶</a></dt>

1237

1238

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.outerjoin" title="sqlalchemy.sql.expression.FromClause.outerjoin"><tt class="xref py py-meth docutils literal">outerjoin()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1239

return an outer join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

1240

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1241

</dd></dl>

1242

1243

1244

1245

<tt class="descname">params</tt><big>(</big>*optionaldict, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.params" title="Permalink to this definition">¶</a></dt>

1246

1247

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.params" title="sqlalchemy.sql.expression.ClauseElement.params"><tt class="xref py py-meth docutils literal">params()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1248

Return a copy with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> elements replaced.

1249

Returns a copy of this ClauseElement with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a>

1250

elements replaced with values taken from the given dictionary:

1251

<div class="highlight-python"><div class="highlight"><pre>>>> clause = column('x') + bindparam('foo')

1252

>>> print clause.compile().params

1253

{'foo':None}

1254

>>> print clause.params({'foo':7}).compile().params

1255

{'foo':7}</pre></div>

1256

</div>

1257

</dd></dl>

1258

1259

1260

1261

<tt class="descname">primary_key</tt><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.primary_key" title="Permalink to this definition">¶</a></dt>

1262

1263

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.primary_key" title="sqlalchemy.sql.expression.FromClause.primary_key"><tt class="xref py py-attr docutils literal">primary_key</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1264

Return the collection of Column objects which comprise the

1265

primary key of this FromClause.

1266

</dd></dl>

1267

1268

1269

1270

<tt class="descname">replace_selectable</tt><big>(</big>old, alias<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.replace_selectable" title="Permalink to this definition">¶</a></dt>

1271

1272

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.replace_selectable" title="sqlalchemy.sql.expression.FromClause.replace_selectable"><tt class="xref py py-meth docutils literal">replace_selectable()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1273

replace all occurrences of FromClause ‘old’ with the given Alias

1274

object, returning a copy of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1275

</dd></dl>

1276

1277

1278

1279

<tt class="descname">scalar</tt><big>(</big>*multiparams, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.scalar" title="Permalink to this definition">¶</a></dt>

1280

1281

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.Executable.scalar" title="sqlalchemy.sql.expression.Executable.scalar"><tt class="xref py py-meth docutils literal">scalar()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a></div>

1282

Compile and execute this <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a>, returning the

1283

result’s scalar representation.

1284

</dd></dl>

1285

1286

1287

1288

<tt class="descname">select</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.select" title="Permalink to this definition">¶</a></dt>

1289

1290

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.select" title="sqlalchemy.sql.expression.FromClause.select"><tt class="xref py py-meth docutils literal">select()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1291

return a SELECT of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1292

1293

See also

1294

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> - general purpose

1295

method which allows for arbitrary column lists.

1296

</div>

1297

</dd></dl>

1298

1299

1300

1301

<tt class="descname">unique_params</tt><big>(</big>*optionaldict, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CompoundSelect.unique_params" title="Permalink to this definition">¶</a></dt>

1302

1303

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.unique_params" title="sqlalchemy.sql.expression.ClauseElement.unique_params"><tt class="xref py py-meth docutils literal">unique_params()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1304

Return a copy with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> elements replaced.

1305

Same functionality as <tt class="docutils literal">params()</tt>, except adds <cite>unique=True</cite>

1306

to affected bind parameters so that multiple statements can be

1307

used.

1308

</dd></dl>

1309

1310

</dd></dl>

1311

1312

1313

1314

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">CTE</tt><big>(</big>selectable, name=None, recursive=False, _cte_alias=None, _restates=frozenset([])<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE" title="Permalink to this definition">¶</a></dt>

1315

<dd>Bases: <a class="reference internal" href="#sqlalchemy.sql.expression.Alias" title="sqlalchemy.sql.expression.Alias"><tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.Alias</tt></a>

1316

Represent a Common Table Expression.

1317

The <a class="reference internal" href="#sqlalchemy.sql.expression.CTE" title="sqlalchemy.sql.expression.CTE"><tt class="xref py py-class docutils literal">CTE</tt></a> object is obtained using the

1318

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.cte" title="sqlalchemy.sql.expression.SelectBase.cte"><tt class="xref py py-meth docutils literal">SelectBase.cte()</tt></a> method from any selectable.

1319

See that method for complete examples.

1320

1321

New in version 0.7.6.

1322

</div>

1323

1324

1325

1326

1327

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.c" title="sqlalchemy.sql.expression.FromClause.c"><tt class="xref py py-attr docutils literal">c</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1328

An alias for the <a class="reference internal" href="#sqlalchemy.sql.expression.CTE.columns" title="sqlalchemy.sql.expression.CTE.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute.

1329

</dd></dl>

1330

1331

1332

1333

<tt class="descname">columns</tt><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.columns" title="Permalink to this definition">¶</a></dt>

1334

1335

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.columns" title="sqlalchemy.sql.expression.FromClause.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1336

A named-based collection of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> objects

1337

maintained by this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1338

The <a class="reference internal" href="#sqlalchemy.sql.expression.CTE.columns" title="sqlalchemy.sql.expression.CTE.columns"><tt class="xref py py-attr docutils literal">columns</tt></a>, or <a class="reference internal" href="#sqlalchemy.sql.expression.CTE.c" title="sqlalchemy.sql.expression.CTE.c"><tt class="xref py py-attr docutils literal">c</tt></a> collection, is the gateway

1339

to the construction of SQL expressions using table-bound or

1340

other selectable-bound columns:

1341

<div class="highlight-python"><div class="highlight"><pre>select([mytable]).where(mytable.c.somecolumn == 5)</pre></div>

1342

</div>

1343

</dd></dl>

1344

1345

1346

1347

<tt class="descname">compare</tt><big>(</big>other, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.compare" title="Permalink to this definition">¶</a></dt>

1348

1349

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compare" title="sqlalchemy.sql.expression.ClauseElement.compare"><tt class="xref py py-meth docutils literal">compare()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1350

Compare this ClauseElement to the given ClauseElement.

1351

Subclasses should override the default behavior, which is a

1352

straight identity comparison.

1353

**kw are arguments consumed by subclass compare() methods and

1354

may be used to modify the criteria for comparison.

1355

(see <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>)

1356

</dd></dl>

1357

1358

1359

1360

<tt class="descname">compile</tt><big>(</big>bind=None, dialect=None, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.compile" title="Permalink to this definition">¶</a></dt>

1361

1362

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compile" title="sqlalchemy.sql.expression.ClauseElement.compile"><tt class="xref py py-meth docutils literal">compile()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1363

Compile this SQL expression.

1364

The return value is a <a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object.

1365

Calling <tt class="docutils literal">str()</tt> or <tt class="docutils literal">unicode()</tt> on the returned value will yield a

1366

string representation of the result. The

1367

<a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object also can return a

1368

dictionary of bind parameter names and values

1369

using the <tt class="docutils literal">params</tt> accessor.

1370

1371

1372

1373

1374

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

1375

<li>bind – An <tt class="docutils literal">Engine</tt> or <tt class="docutils literal">Connection</tt> from which a

1376

<tt class="docutils literal">Compiled</tt> will be acquired. This argument takes precedence over

1377

this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if any.</li>

1378

<li>column_keys – Used for INSERT and UPDATE statements, a list of

1379

column names which should be present in the VALUES clause of the

1380

compiled statement. If <tt class="docutils literal">None</tt>, all columns from the target table

1381

object are rendered.</li>

1382

<li>dialect – A <tt class="docutils literal">Dialect</tt> instance from which a <tt class="docutils literal">Compiled</tt>

1383

will be acquired. This argument takes precedence over the <cite>bind</cite>

1384

argument as well as this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if

1385

any.</li>

1386

<li>inline – Used for INSERT statements, for a dialect which does

1387

not support inline retrieval of newly generated primary key

1388

columns, will force the expression used to create the new primary

1389

key value to be rendered inline within the INSERT statement’s

1390

VALUES clause. This typically refers to Sequence execution but may

1391

also refer to any server-side default generation function

1392

associated with a primary key <cite>Column</cite>.</li>

1393

</ul>

1394

</td>

1395

</tr>

1396

</tbody>

1397

</table>

1398

</dd></dl>

1399

1400

1401

1402

<tt class="descname">correspond_on_equivalents</tt><big>(</big>column, equivalents<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.correspond_on_equivalents" title="Permalink to this definition">¶</a></dt>

1403

1404

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.correspond_on_equivalents" title="sqlalchemy.sql.expression.FromClause.correspond_on_equivalents"><tt class="xref py py-meth docutils literal">correspond_on_equivalents()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1405

Return corresponding_column for the given column, or if None

1406

search for a match in the given dictionary.

1407

</dd></dl>

1408

1409

1410

1411

<tt class="descname">corresponding_column</tt><big>(</big>column, require_embedded=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.corresponding_column" title="Permalink to this definition">¶</a></dt>

1412

1413

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.corresponding_column" title="sqlalchemy.sql.expression.FromClause.corresponding_column"><tt class="xref py py-meth docutils literal">corresponding_column()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1414

Given a <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, return the exported

1415

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> object from this <a class="reference internal" href="#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a>

1416

which corresponds to that original

1417

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a> via a common ancestor

1418

column.

1419

1420

1421

1422

1423

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

1424

<li>column – the target <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> to be matched</li>

1425

<li>require_embedded – only return corresponding columns for</li>

1426

</ul>

1427

</td>

1428

</tr>

1429

</tbody>

1430

</table>

1431

the given <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, if the given

1432

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> is actually present within a sub-element

1433

of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>. Normally the column will match if

1434

it merely shares a common ancestor with one of the exported

1435

columns of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1436

</dd></dl>

1437

1438

1439

1440

<tt class="descname">count</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.count" title="Permalink to this definition">¶</a></dt>

1441

1442

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.count" title="sqlalchemy.sql.expression.FromClause.count"><tt class="xref py py-meth docutils literal">count()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1443

return a SELECT COUNT generated against this

1444

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1445

</dd></dl>

1446

1447

1448

1449

<tt class="descname">foreign_keys</tt><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.foreign_keys" title="Permalink to this definition">¶</a></dt>

1450

1451

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.foreign_keys" title="sqlalchemy.sql.expression.FromClause.foreign_keys"><tt class="xref py py-attr docutils literal">foreign_keys</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1452

Return the collection of ForeignKey objects which this

1453

FromClause references.

1454

</dd></dl>

1455

1456

1457

1458

<tt class="descname">join</tt><big>(</big>right, onclause=None, isouter=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.join" title="Permalink to this definition">¶</a></dt>

1459

1460

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">join()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1461

return a join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

1462

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1463

</dd></dl>

1464

1465

1466

1467

<tt class="descname">outerjoin</tt><big>(</big>right, onclause=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.outerjoin" title="Permalink to this definition">¶</a></dt>

1468

1469

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.outerjoin" title="sqlalchemy.sql.expression.FromClause.outerjoin"><tt class="xref py py-meth docutils literal">outerjoin()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1470

return an outer join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

1471

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1472

</dd></dl>

1473

1474

1475

1476

<tt class="descname">params</tt><big>(</big>*optionaldict, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.params" title="Permalink to this definition">¶</a></dt>

1477

1478

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.params" title="sqlalchemy.sql.expression.ClauseElement.params"><tt class="xref py py-meth docutils literal">params()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1479

Return a copy with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> elements replaced.

1480

Returns a copy of this ClauseElement with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a>

1481

elements replaced with values taken from the given dictionary:

1482

<div class="highlight-python"><div class="highlight"><pre>>>> clause = column('x') + bindparam('foo')

1483

>>> print clause.compile().params

1484

{'foo':None}

1485

>>> print clause.params({'foo':7}).compile().params

1486

{'foo':7}</pre></div>

1487

</div>

1488

</dd></dl>

1489

1490

1491

1492

<tt class="descname">primary_key</tt><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.primary_key" title="Permalink to this definition">¶</a></dt>

1493

1494

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.primary_key" title="sqlalchemy.sql.expression.FromClause.primary_key"><tt class="xref py py-attr docutils literal">primary_key</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1495

Return the collection of Column objects which comprise the

1496

primary key of this FromClause.

1497

</dd></dl>

1498

1499

1500

1501

<tt class="descname">replace_selectable</tt><big>(</big>old, alias<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.replace_selectable" title="Permalink to this definition">¶</a></dt>

1502

1503

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.replace_selectable" title="sqlalchemy.sql.expression.FromClause.replace_selectable"><tt class="xref py py-meth docutils literal">replace_selectable()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1504

replace all occurrences of FromClause ‘old’ with the given Alias

1505

object, returning a copy of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1506

</dd></dl>

1507

1508

1509

1510

<tt class="descname">select</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.select" title="Permalink to this definition">¶</a></dt>

1511

1512

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.select" title="sqlalchemy.sql.expression.FromClause.select"><tt class="xref py py-meth docutils literal">select()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1513

return a SELECT of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1514

1515

See also

1516

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> - general purpose

1517

method which allows for arbitrary column lists.

1518

</div>

1519

</dd></dl>

1520

1521

1522

1523

<tt class="descname">self_group</tt><big>(</big>against=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.self_group" title="Permalink to this definition">¶</a></dt>

1524

1525

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.self_group" title="sqlalchemy.sql.expression.ClauseElement.self_group"><tt class="xref py py-meth docutils literal">self_group()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1526

Apply a ‘grouping’ to this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>.

1527

This method is overridden by subclasses to return a

1528

“grouping” construct, i.e. parenthesis. In particular

1529

it’s used by “binary” expressions to provide a grouping

1530

around themselves when placed into a larger expression,

1531

as well as by <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> constructs when placed into

1532

the FROM clause of another <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>. (Note that

1533

subqueries should be normally created using the

1534

<tt class="xref py py-func docutils literal">Select.alias()</tt> method, as many platforms require

1535

nested SELECT statements to be named).

1536

As expressions are composed together, the application of

1537

<a class="reference internal" href="#sqlalchemy.sql.expression.CTE.self_group" title="sqlalchemy.sql.expression.CTE.self_group"><tt class="xref py py-meth docutils literal">self_group()</tt></a> is automatic - end-user code should never

1538

need to use this method directly. Note that SQLAlchemy’s

1539

clause constructs take operator precedence into account -

1540

so parenthesis might not be needed, for example, in

1541

an expression like <tt class="docutils literal">x OR (y AND z)</tt> - AND takes precedence

1542

over OR.

1543

The base <a class="reference internal" href="#sqlalchemy.sql.expression.CTE.self_group" title="sqlalchemy.sql.expression.CTE.self_group"><tt class="xref py py-meth docutils literal">self_group()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>

1544

just returns self.

1545

</dd></dl>

1546

1547

1548

1549

<tt class="descname">unique_params</tt><big>(</big>*optionaldict, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.CTE.unique_params" title="Permalink to this definition">¶</a></dt>

1550

1551

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.unique_params" title="sqlalchemy.sql.expression.ClauseElement.unique_params"><tt class="xref py py-meth docutils literal">unique_params()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1552

Return a copy with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> elements replaced.

1553

Same functionality as <tt class="docutils literal">params()</tt>, except adds <cite>unique=True</cite>

1554

to affected bind parameters so that multiple statements can be

1555

used.

1556

</dd></dl>

1557

1558

</dd></dl>

1559

1560

1561

1562

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">Executable</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Executable" title="Permalink to this definition">¶</a></dt>

1563

<dd>Bases: <tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.Generative</tt>

1564

Mark a ClauseElement as supporting execution.

1565

<a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a> is a superclass for all “statement” types

1566

of objects, including <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>, <a class="reference internal" href="dml.html#sqlalchemy.sql.expression.delete" title="sqlalchemy.sql.expression.delete"><tt class="xref py py-func docutils literal">delete()</tt></a>, <a class="reference internal" href="dml.html#sqlalchemy.sql.expression.update" title="sqlalchemy.sql.expression.update"><tt class="xref py py-func docutils literal">update()</tt></a>,

1567

<a class="reference internal" href="dml.html#sqlalchemy.sql.expression.insert" title="sqlalchemy.sql.expression.insert"><tt class="xref py py-func docutils literal">insert()</tt></a>, <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a>.

1568

1569

1570

1571

<dd>Returns the <a class="reference internal" href="connections.html#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> or <a class="reference internal" href="connections.html#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a> to

1572

which this <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a> is bound, or None if none found.

1573

This is a traversal which checks locally, then

1574

checks among the “from” clauses of associated objects

1575

until a bound engine or connection is found.

1576

</dd></dl>

1577

1578

1579

1580

<tt class="descname">execute</tt><big>(</big>*multiparams, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Executable.execute" title="Permalink to this definition">¶</a></dt>

1581

<dd>Compile and execute this <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a>.

1582

</dd></dl>

1583

1584

1585

1586

<tt class="descname">execution_options</tt><big>(</big>**kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Executable.execution_options" title="Permalink to this definition">¶</a></dt>

1587

<dd>Set non-SQL options for the statement which take effect during

1588

execution.

1589

Execution options can be set on a per-statement or

1590

per <a class="reference internal" href="connections.html#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a> basis. Additionally, the

1591

<a class="reference internal" href="connections.html#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> and ORM <a class="reference internal" href="../orm/query.html#sqlalchemy.orm.query.Query" title="sqlalchemy.orm.query.Query"><tt class="xref py py-class docutils literal">Query</tt></a> objects provide

1592

access to execution options which they in turn configure upon

1593

connections.

1594

The <a class="reference internal" href="#sqlalchemy.sql.expression.Executable.execution_options" title="sqlalchemy.sql.expression.Executable.execution_options"><tt class="xref py py-meth docutils literal">execution_options()</tt></a> method is generative. A new

1595

instance of this statement is returned that contains the options:

1596

<div class="highlight-python"><div class="highlight"><pre>statement = select([table.c.x, table.c.y])

1597

statement = statement.execution_options(autocommit=True)</pre></div>

1598

</div>

1599

Note that only a subset of possible execution options can be applied

1600

to a statement - these include “autocommit” and “stream_results”,

1601

but not “isolation_level” or “compiled_cache”.

1602

See <a class="reference internal" href="connections.html#sqlalchemy.engine.Connection.execution_options" title="sqlalchemy.engine.Connection.execution_options"><tt class="xref py py-meth docutils literal">Connection.execution_options()</tt></a> for a full list of

1603

possible options.

1604

1605

See also

1606

<a class="reference internal" href="connections.html#sqlalchemy.engine.Connection.execution_options" title="sqlalchemy.engine.Connection.execution_options"><tt class="xref py py-meth docutils literal">Connection.execution_options()</tt></a>

1607

<a class="reference internal" href="../orm/query.html#sqlalchemy.orm.query.Query.execution_options" title="sqlalchemy.orm.query.Query.execution_options"><tt class="xref py py-meth docutils literal">Query.execution_options()</tt></a>

1608

</div>

1609

</dd></dl>

1610

1611

1612

1613

<tt class="descname">scalar</tt><big>(</big>*multiparams, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Executable.scalar" title="Permalink to this definition">¶</a></dt>

1614

<dd>Compile and execute this <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a>, returning the

1615

result’s scalar representation.

1616

</dd></dl>

1617

1618

</dd></dl>

1619

1620

1621

1622

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">FromClause</tt><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause" title="Permalink to this definition">¶</a></dt>

1623

<dd>Bases: <a class="reference internal" href="#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.Selectable</tt></a>

1624

Represent an element that can be used within the <tt class="docutils literal">FROM</tt>

1625

clause of a <tt class="docutils literal">SELECT</tt> statement.

1626

The most common forms of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> are the

1627

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> and the <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> constructs. Key

1628

features common to all <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> objects include:

1629

1630

<li>a <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.c" title="sqlalchemy.sql.expression.FromClause.c"><tt class="xref py py-attr docutils literal">c</tt></a> collection, which provides per-name access to a collection

1631

of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> objects.</li>

1632

<li>a <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.primary_key" title="sqlalchemy.sql.expression.FromClause.primary_key"><tt class="xref py py-attr docutils literal">primary_key</tt></a> attribute, which is a collection of all those

1633

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> objects that indicate the <tt class="docutils literal">primary_key</tt> flag.</li>

1634

<li>Methods to generate various derivations of a “from” clause, including

1635

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.alias" title="sqlalchemy.sql.expression.FromClause.alias"><tt class="xref py py-meth docutils literal">FromClause.alias()</tt></a>, <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">FromClause.join()</tt></a>,

1636

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.select" title="sqlalchemy.sql.expression.FromClause.select"><tt class="xref py py-meth docutils literal">FromClause.select()</tt></a>.</li>

1637

</ul>

1638

1639

1640

<tt class="descname">alias</tt><big>(</big>name=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.alias" title="Permalink to this definition">¶</a></dt>

1641

<dd>return an alias of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1642

This is shorthand for calling:

1643

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import alias

1644

a = alias(self, name=name)</pre></div>

1645

</div>

1646

See <a class="reference internal" href="#sqlalchemy.sql.expression.alias" title="sqlalchemy.sql.expression.alias"><tt class="xref py py-func docutils literal">alias()</tt></a> for details.

1647

</dd></dl>

1648

1649

1650

1651

1652

<dd>An alias for the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.columns" title="sqlalchemy.sql.expression.FromClause.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute.

1653

</dd></dl>

1654

1655

1656

1657

<tt class="descname">columns</tt><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.columns" title="Permalink to this definition">¶</a></dt>

1658

<dd>A named-based collection of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> objects

1659

maintained by this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1660

The <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.columns" title="sqlalchemy.sql.expression.FromClause.columns"><tt class="xref py py-attr docutils literal">columns</tt></a>, or <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.c" title="sqlalchemy.sql.expression.FromClause.c"><tt class="xref py py-attr docutils literal">c</tt></a> collection, is the gateway

1661

to the construction of SQL expressions using table-bound or

1662

other selectable-bound columns:

1663

<div class="highlight-python"><div class="highlight"><pre>select([mytable]).where(mytable.c.somecolumn == 5)</pre></div>

1664

</div>

1665

</dd></dl>

1666

1667

1668

1669

<tt class="descname">correspond_on_equivalents</tt><big>(</big>column, equivalents<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.correspond_on_equivalents" title="Permalink to this definition">¶</a></dt>

1670

<dd>Return corresponding_column for the given column, or if None

1671

search for a match in the given dictionary.

1672

</dd></dl>

1673

1674

1675

1676

<tt class="descname">corresponding_column</tt><big>(</big>column, require_embedded=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.corresponding_column" title="Permalink to this definition">¶</a></dt>

1677

<dd>Given a <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, return the exported

1678

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> object from this <a class="reference internal" href="#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a>

1679

which corresponds to that original

1680

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a> via a common ancestor

1681

column.

1682

1683

1684

1685

1686

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

1687

<li>column – the target <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> to be matched</li>

1688

<li>require_embedded – only return corresponding columns for</li>

1689

</ul>

1690

</td>

1691

</tr>

1692

</tbody>

1693

</table>

1694

the given <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, if the given

1695

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> is actually present within a sub-element

1696

of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>. Normally the column will match if

1697

it merely shares a common ancestor with one of the exported

1698

columns of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1699

</dd></dl>

1700

1701

1702

1703

<tt class="descname">count</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.count" title="Permalink to this definition">¶</a></dt>

1704

<dd>return a SELECT COUNT generated against this

1705

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1706

</dd></dl>

1707

1708

1709

1710

<tt class="descname">description</tt><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.description" title="Permalink to this definition">¶</a></dt>

1711

<dd>a brief description of this FromClause.

1712

Used primarily for error message formatting.

1713

</dd></dl>

1714

1715

1716

1717

<tt class="descname">foreign_keys</tt><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.foreign_keys" title="Permalink to this definition">¶</a></dt>

1718

<dd>Return the collection of ForeignKey objects which this

1719

FromClause references.

1720

</dd></dl>

1721

1722

1723

1724

<tt class="descname">is_derived_from</tt><big>(</big>fromclause<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.is_derived_from" title="Permalink to this definition">¶</a></dt>

1725

<dd>Return True if this FromClause is ‘derived’ from the given

1726

FromClause.

1727

An example would be an Alias of a Table is derived from that Table.

1728

</dd></dl>

1729

1730

1731

1732

<tt class="descname">join</tt><big>(</big>right, onclause=None, isouter=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.join" title="Permalink to this definition">¶</a></dt>

1733

<dd>return a join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

1734

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1735

</dd></dl>

1736

1737

1738

1739

<tt class="descname">outerjoin</tt><big>(</big>right, onclause=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.outerjoin" title="Permalink to this definition">¶</a></dt>

1740

<dd>return an outer join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

1741

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1742

</dd></dl>

1743

1744

1745

1746

<tt class="descname">primary_key</tt><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.primary_key" title="Permalink to this definition">¶</a></dt>

1747

<dd>Return the collection of Column objects which comprise the

1748

primary key of this FromClause.

1749

</dd></dl>

1750

1751

1752

1753

<tt class="descname">replace_selectable</tt><big>(</big>old, alias<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.replace_selectable" title="Permalink to this definition">¶</a></dt>

1754

<dd>replace all occurrences of FromClause ‘old’ with the given Alias

1755

object, returning a copy of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1756

</dd></dl>

1757

1758

1759

1760

<tt class="descname">select</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.FromClause.select" title="Permalink to this definition">¶</a></dt>

1761

<dd>return a SELECT of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1762

1763

See also

1764

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> - general purpose

1765

method which allows for arbitrary column lists.

1766

</div>

1767

</dd></dl>

1768

1769

</dd></dl>

1770

1771

1772

1773

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">Join</tt><big>(</big>left, right, onclause=None, isouter=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join" title="Permalink to this definition">¶</a></dt>

1774

<dd>Bases: <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.FromClause</tt></a>

1775

represent a <tt class="docutils literal">JOIN</tt> construct between two <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>

1776

elements.

1777

The public constructor function for <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a> is the module-level

1778

<a class="reference internal" href="#sqlalchemy.sql.expression.join" title="sqlalchemy.sql.expression.join"><tt class="xref py py-func docutils literal">join()</tt></a> function, as well as the <a class="reference internal" href="#sqlalchemy.sql.expression.join" title="sqlalchemy.sql.expression.join"><tt class="xref py py-func docutils literal">join()</tt></a> method available

1779

off all <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> subclasses.

1780

1781

1782

<tt class="descname">__init__</tt><big>(</big>left, right, onclause=None, isouter=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.__init__" title="Permalink to this definition">¶</a></dt>

1783

<dd>Construct a new <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a>.

1784

The usual entrypoint here is the <a class="reference internal" href="#sqlalchemy.sql.expression.join" title="sqlalchemy.sql.expression.join"><tt class="xref py py-func docutils literal">join()</tt></a>

1785

function or the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">FromClause.join()</tt></a> method of any

1786

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> object.

1787

</dd></dl>

1788

1789

1790

1791

<tt class="descname">alias</tt><big>(</big>name=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.alias" title="Permalink to this definition">¶</a></dt>

1792

<dd>return an alias of this <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a>.

1793

Used against a <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a> object,

1794

<a class="reference internal" href="#sqlalchemy.sql.expression.Join.alias" title="sqlalchemy.sql.expression.Join.alias"><tt class="xref py py-meth docutils literal">alias()</tt></a> calls the <a class="reference internal" href="#sqlalchemy.sql.expression.Join.select" title="sqlalchemy.sql.expression.Join.select"><tt class="xref py py-meth docutils literal">select()</tt></a>

1795

method first so that a subquery against a

1796

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> construct is generated.

1797

the <tt class="xref py py-func docutils literal">select()</tt> construct also has the

1798

<tt class="docutils literal">correlate</tt> flag set to <tt class="docutils literal">False</tt> and will not

1799

auto-correlate inside an enclosing <tt class="xref py py-func docutils literal">select()</tt>

1800

construct.

1801

The equivalent long-hand form, given a <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a> object

1802

<tt class="docutils literal">j</tt>, is:

1803

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import select, alias

1804

j = alias(

1805

select([j.left, j.right]).\

1806

select_from(j).\

1807

with_labels(True).\

1808

correlate(False),

1809

name=name

1810

)</pre></div>

1811

</div>

1812

See <a class="reference internal" href="#sqlalchemy.sql.expression.alias" title="sqlalchemy.sql.expression.alias"><tt class="xref py py-func docutils literal">alias()</tt></a> for further details on

1813

aliases.

1814

</dd></dl>

1815

1816

1817

1818

1819

1820

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.c" title="sqlalchemy.sql.expression.FromClause.c"><tt class="xref py py-attr docutils literal">c</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1821

An alias for the <a class="reference internal" href="#sqlalchemy.sql.expression.Join.columns" title="sqlalchemy.sql.expression.Join.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute.

1822

</dd></dl>

1823

1824

1825

1826

<tt class="descname">columns</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Join.columns" title="Permalink to this definition">¶</a></dt>

1827

1828

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.columns" title="sqlalchemy.sql.expression.FromClause.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1829

A named-based collection of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> objects

1830

maintained by this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1831

The <a class="reference internal" href="#sqlalchemy.sql.expression.Join.columns" title="sqlalchemy.sql.expression.Join.columns"><tt class="xref py py-attr docutils literal">columns</tt></a>, or <a class="reference internal" href="#sqlalchemy.sql.expression.Join.c" title="sqlalchemy.sql.expression.Join.c"><tt class="xref py py-attr docutils literal">c</tt></a> collection, is the gateway

1832

to the construction of SQL expressions using table-bound or

1833

other selectable-bound columns:

1834

<div class="highlight-python"><div class="highlight"><pre>select([mytable]).where(mytable.c.somecolumn == 5)</pre></div>

1835

</div>

1836

</dd></dl>

1837

1838

1839

1840

<tt class="descname">compare</tt><big>(</big>other, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.compare" title="Permalink to this definition">¶</a></dt>

1841

1842

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compare" title="sqlalchemy.sql.expression.ClauseElement.compare"><tt class="xref py py-meth docutils literal">compare()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1843

Compare this ClauseElement to the given ClauseElement.

1844

Subclasses should override the default behavior, which is a

1845

straight identity comparison.

1846

**kw are arguments consumed by subclass compare() methods and

1847

may be used to modify the criteria for comparison.

1848

(see <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>)

1849

</dd></dl>

1850

1851

1852

1853

<tt class="descname">compile</tt><big>(</big>bind=None, dialect=None, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.compile" title="Permalink to this definition">¶</a></dt>

1854

1855

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compile" title="sqlalchemy.sql.expression.ClauseElement.compile"><tt class="xref py py-meth docutils literal">compile()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1856

Compile this SQL expression.

1857

The return value is a <a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object.

1858

Calling <tt class="docutils literal">str()</tt> or <tt class="docutils literal">unicode()</tt> on the returned value will yield a

1859

string representation of the result. The

1860

<a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object also can return a

1861

dictionary of bind parameter names and values

1862

using the <tt class="docutils literal">params</tt> accessor.

1863

1864

1865

1866

1867

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

1868

<li>bind – An <tt class="docutils literal">Engine</tt> or <tt class="docutils literal">Connection</tt> from which a

1869

<tt class="docutils literal">Compiled</tt> will be acquired. This argument takes precedence over

1870

this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if any.</li>

1871

<li>column_keys – Used for INSERT and UPDATE statements, a list of

1872

column names which should be present in the VALUES clause of the

1873

compiled statement. If <tt class="docutils literal">None</tt>, all columns from the target table

1874

object are rendered.</li>

1875

<li>dialect – A <tt class="docutils literal">Dialect</tt> instance from which a <tt class="docutils literal">Compiled</tt>

1876

will be acquired. This argument takes precedence over the <cite>bind</cite>

1877

argument as well as this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if

1878

any.</li>

1879

<li>inline – Used for INSERT statements, for a dialect which does

1880

not support inline retrieval of newly generated primary key

1881

columns, will force the expression used to create the new primary

1882

key value to be rendered inline within the INSERT statement’s

1883

VALUES clause. This typically refers to Sequence execution but may

1884

also refer to any server-side default generation function

1885

associated with a primary key <cite>Column</cite>.</li>

1886

</ul>

1887

</td>

1888

</tr>

1889

</tbody>

1890

</table>

1891

</dd></dl>

1892

1893

1894

1895

<tt class="descname">correspond_on_equivalents</tt><big>(</big>column, equivalents<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.correspond_on_equivalents" title="Permalink to this definition">¶</a></dt>

1896

1897

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.correspond_on_equivalents" title="sqlalchemy.sql.expression.FromClause.correspond_on_equivalents"><tt class="xref py py-meth docutils literal">correspond_on_equivalents()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1898

Return corresponding_column for the given column, or if None

1899

search for a match in the given dictionary.

1900

</dd></dl>

1901

1902

1903

1904

<tt class="descname">corresponding_column</tt><big>(</big>column, require_embedded=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.corresponding_column" title="Permalink to this definition">¶</a></dt>

1905

1906

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.corresponding_column" title="sqlalchemy.sql.expression.FromClause.corresponding_column"><tt class="xref py py-meth docutils literal">corresponding_column()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1907

Given a <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, return the exported

1908

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> object from this <a class="reference internal" href="#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a>

1909

which corresponds to that original

1910

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a> via a common ancestor

1911

column.

1912

1913

1914

1915

1916

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

1917

<li>column – the target <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> to be matched</li>

1918

<li>require_embedded – only return corresponding columns for</li>

1919

</ul>

1920

</td>

1921

</tr>

1922

</tbody>

1923

</table>

1924

the given <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, if the given

1925

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> is actually present within a sub-element

1926

of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>. Normally the column will match if

1927

it merely shares a common ancestor with one of the exported

1928

columns of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1929

</dd></dl>

1930

1931

1932

1933

<tt class="descname">count</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.count" title="Permalink to this definition">¶</a></dt>

1934

1935

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.count" title="sqlalchemy.sql.expression.FromClause.count"><tt class="xref py py-meth docutils literal">count()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1936

return a SELECT COUNT generated against this

1937

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1938

</dd></dl>

1939

1940

1941

1942

<tt class="descname">foreign_keys</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Join.foreign_keys" title="Permalink to this definition">¶</a></dt>

1943

1944

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.foreign_keys" title="sqlalchemy.sql.expression.FromClause.foreign_keys"><tt class="xref py py-attr docutils literal">foreign_keys</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1945

Return the collection of ForeignKey objects which this

1946

FromClause references.

1947

</dd></dl>

1948

1949

1950

1951

<tt class="descname">join</tt><big>(</big>right, onclause=None, isouter=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.join" title="Permalink to this definition">¶</a></dt>

1952

1953

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">join()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1954

return a join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

1955

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1956

</dd></dl>

1957

1958

1959

1960

<tt class="descname">outerjoin</tt><big>(</big>right, onclause=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.outerjoin" title="Permalink to this definition">¶</a></dt>

1961

1962

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.outerjoin" title="sqlalchemy.sql.expression.FromClause.outerjoin"><tt class="xref py py-meth docutils literal">outerjoin()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1963

return an outer join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

1964

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1965

</dd></dl>

1966

1967

1968

1969

<tt class="descname">params</tt><big>(</big>*optionaldict, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.params" title="Permalink to this definition">¶</a></dt>

1970

1971

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.params" title="sqlalchemy.sql.expression.ClauseElement.params"><tt class="xref py py-meth docutils literal">params()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1972

Return a copy with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> elements replaced.

1973

Returns a copy of this ClauseElement with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a>

1974

elements replaced with values taken from the given dictionary:

1975

<div class="highlight-python"><div class="highlight"><pre>>>> clause = column('x') + bindparam('foo')

1976

>>> print clause.compile().params

1977

{'foo':None}

1978

>>> print clause.params({'foo':7}).compile().params

1979

{'foo':7}</pre></div>

1980

</div>

1981

</dd></dl>

1982

1983

1984

1985

<tt class="descname">primary_key</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Join.primary_key" title="Permalink to this definition">¶</a></dt>

1986

1987

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.primary_key" title="sqlalchemy.sql.expression.FromClause.primary_key"><tt class="xref py py-attr docutils literal">primary_key</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1988

Return the collection of Column objects which comprise the

1989

primary key of this FromClause.

1990

</dd></dl>

1991

1992

1993

1994

<tt class="descname">replace_selectable</tt><big>(</big>old, alias<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.replace_selectable" title="Permalink to this definition">¶</a></dt>

1995

1996

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.replace_selectable" title="sqlalchemy.sql.expression.FromClause.replace_selectable"><tt class="xref py py-meth docutils literal">replace_selectable()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

1997

replace all occurrences of FromClause ‘old’ with the given Alias

1998

object, returning a copy of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

1999

</dd></dl>

2000

2001

2002

2003

<tt class="descname">select</tt><big>(</big>whereclause=None, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.select" title="Permalink to this definition">¶</a></dt>

2004

<dd>Create a <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> from this <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a>.

2005

The equivalent long-hand form, given a <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a> object

2006

<tt class="docutils literal">j</tt>, is:

2007

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import select

2008

j = select([j.left, j.right], **kw).\

2009

where(whereclause).\

2010

select_from(j)</pre></div>

2011

</div>

2012

2013

2014

2015

2016

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

2017

<li>whereclause – the WHERE criterion that will be sent to

2018

the <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> function</li>

2019

<li>**kwargs – all other kwargs are sent to the

2020

underlying <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> function.</li>

2021

</ul>

2022

</td>

2023

</tr>

2024

</tbody>

2025

</table>

2026

</dd></dl>

2027

2028

2029

2030

<tt class="descname">unique_params</tt><big>(</big>*optionaldict, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Join.unique_params" title="Permalink to this definition">¶</a></dt>

2031

2032

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.unique_params" title="sqlalchemy.sql.expression.ClauseElement.unique_params"><tt class="xref py py-meth docutils literal">unique_params()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

2033

Return a copy with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> elements replaced.

2034

Same functionality as <tt class="docutils literal">params()</tt>, except adds <cite>unique=True</cite>

2035

to affected bind parameters so that multiple statements can be

2036

used.

2037

</dd></dl>

2038

2039

</dd></dl>

2040

2041

2042

2043

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">Select</tt><big>(</big>columns, whereclause=None, from_obj=None, distinct=False, having=None, correlate=True, prefixes=None, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select" title="Permalink to this definition">¶</a></dt>

2044

<dd>Bases: <tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.HasPrefixes</tt>, <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.SelectBase</tt></a>

2045

Represents a <tt class="docutils literal">SELECT</tt> statement.

2046

2047

See also

2048

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> - the function which creates

2049

a <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> object.

2050

<a class="reference internal" href="tutorial.html#coretutorial-selecting">Selecting</a> - Core Tutorial description

2051

of <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>.

2052

</div>

2053

2054

2055

<tt class="descname">__init__</tt><big>(</big>columns, whereclause=None, from_obj=None, distinct=False, having=None, correlate=True, prefixes=None, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.__init__" title="Permalink to this definition">¶</a></dt>

2056

<dd>Construct a Select object.

2057

The public constructor for Select is the

2058

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> function; see that function for

2059

argument descriptions.

2060

Additional generative and mutator methods are available on the

2061

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a> superclass.

2062

</dd></dl>

2063

2064

2065

2066

<tt class="descname">alias</tt><big>(</big>name=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.alias" title="Permalink to this definition">¶</a></dt>

2067

2068

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.alias" title="sqlalchemy.sql.expression.FromClause.alias"><tt class="xref py py-meth docutils literal">alias()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2069

return an alias of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

2070

This is shorthand for calling:

2071

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import alias

2072

a = alias(self, name=name)</pre></div>

2073

</div>

2074

See <a class="reference internal" href="#sqlalchemy.sql.expression.alias" title="sqlalchemy.sql.expression.alias"><tt class="xref py py-func docutils literal">alias()</tt></a> for details.

2075

</dd></dl>

2076

2077

2078

2079

<tt class="descname">append_column</tt><big>(</big>column<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.append_column" title="Permalink to this definition">¶</a></dt>

2080

<dd>append the given column expression to the columns clause of this

2081

select() construct.

2082

This is an in-place mutation method; the

2083

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.column" title="sqlalchemy.sql.expression.Select.column"><tt class="xref py py-meth docutils literal">column()</tt></a> method is preferred, as it provides standard

2084

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

2085

</dd></dl>

2086

2087

2088

2089

<tt class="descname">append_correlation</tt><big>(</big>fromclause<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.append_correlation" title="Permalink to this definition">¶</a></dt>

2090

<dd>append the given correlation expression to this select()

2091

construct.

2092

This is an in-place mutation method; the

2093

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.correlate" title="sqlalchemy.sql.expression.Select.correlate"><tt class="xref py py-meth docutils literal">correlate()</tt></a> method is preferred, as it provides standard

2094

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

2095

</dd></dl>

2096

2097

2098

2099

<tt class="descname">append_from</tt><big>(</big>fromclause<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.append_from" title="Permalink to this definition">¶</a></dt>

2100

<dd>append the given FromClause expression to this select() construct’s

2101

FROM clause.

2102

This is an in-place mutation method; the

2103

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.select_from" title="sqlalchemy.sql.expression.Select.select_from"><tt class="xref py py-meth docutils literal">select_from()</tt></a> method is preferred, as it provides standard

2104

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

2105

</dd></dl>

2106

2107

2108

2109

<tt class="descname">append_group_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.append_group_by" title="Permalink to this definition">¶</a></dt>

2110

2111

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.append_group_by" title="sqlalchemy.sql.expression.SelectBase.append_group_by"><tt class="xref py py-meth docutils literal">append_group_by()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2112

Append the given GROUP BY criterion applied to this selectable.

2113

The criterion will be appended to any pre-existing GROUP BY criterion.

2114

This is an in-place mutation method; the

2115

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.group_by" title="sqlalchemy.sql.expression.SelectBase.group_by"><tt class="xref py py-meth docutils literal">group_by()</tt></a> method is preferred, as it provides standard

2116

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

2117

</dd></dl>

2118

2119

2120

2121

<tt class="descname">append_having</tt><big>(</big>having<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.append_having" title="Permalink to this definition">¶</a></dt>

2122

<dd>append the given expression to this select() construct’s HAVING

2123

criterion.

2124

The expression will be joined to existing HAVING criterion via AND.

2125

This is an in-place mutation method; the

2126

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.having" title="sqlalchemy.sql.expression.Select.having"><tt class="xref py py-meth docutils literal">having()</tt></a> method is preferred, as it provides standard

2127

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

2128

</dd></dl>

2129

2130

2131

2132

<tt class="descname">append_order_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.append_order_by" title="Permalink to this definition">¶</a></dt>

2133

2134

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.append_order_by" title="sqlalchemy.sql.expression.SelectBase.append_order_by"><tt class="xref py py-meth docutils literal">append_order_by()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2135

Append the given ORDER BY criterion applied to this selectable.

2136

The criterion will be appended to any pre-existing ORDER BY criterion.

2137

This is an in-place mutation method; the

2138

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.order_by" title="sqlalchemy.sql.expression.SelectBase.order_by"><tt class="xref py py-meth docutils literal">order_by()</tt></a> method is preferred, as it provides standard

2139

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

2140

</dd></dl>

2141

2142

2143

2144

<tt class="descname">append_prefix</tt><big>(</big>clause<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.append_prefix" title="Permalink to this definition">¶</a></dt>

2145

<dd>append the given columns clause prefix expression to this select()

2146

construct.

2147

This is an in-place mutation method; the

2148

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.prefix_with" title="sqlalchemy.sql.expression.Select.prefix_with"><tt class="xref py py-meth docutils literal">prefix_with()</tt></a> method is preferred, as it provides standard

2149

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

2150

</dd></dl>

2151

2152

2153

2154

<tt class="descname">append_whereclause</tt><big>(</big>whereclause<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.append_whereclause" title="Permalink to this definition">¶</a></dt>

2155

<dd>append the given expression to this select() construct’s WHERE

2156

criterion.

2157

The expression will be joined to existing WHERE criterion via AND.

2158

This is an in-place mutation method; the

2159

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.where" title="sqlalchemy.sql.expression.Select.where"><tt class="xref py py-meth docutils literal">where()</tt></a> method is preferred, as it provides standard

2160

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

2161

</dd></dl>

2162

2163

2164

2165

<tt class="descname">apply_labels</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.apply_labels" title="Permalink to this definition">¶</a></dt>

2166

2167

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.apply_labels" title="sqlalchemy.sql.expression.SelectBase.apply_labels"><tt class="xref py py-meth docutils literal">apply_labels()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2168

return a new selectable with the ‘use_labels’ flag set to True.

2169

This will result in column expressions being generated using labels

2170

against their table name, such as “SELECT somecolumn AS

2171

tablename_somecolumn”. This allows selectables which contain multiple

2172

FROM clauses to produce a unique set of column names regardless of

2173

name conflicts among the individual FROM clauses.

2174

</dd></dl>

2175

2176

2177

2178

<tt class="descname">as_scalar</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.as_scalar" title="Permalink to this definition">¶</a></dt>

2179

2180

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.as_scalar" title="sqlalchemy.sql.expression.SelectBase.as_scalar"><tt class="xref py py-meth docutils literal">as_scalar()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2181

return a ‘scalar’ representation of this selectable, which can be

2182

used as a column expression.

2183

Typically, a select statement which has only one column in its columns

2184

clause is eligible to be used as a scalar expression.

2185

The returned object is an instance of

2186

<tt class="xref py py-class docutils literal">ScalarSelect</tt>.

2187

</dd></dl>

2188

2189

2190

2191

<tt class="descname">autocommit</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.autocommit" title="Permalink to this definition">¶</a></dt>

2192

2193

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.autocommit" title="sqlalchemy.sql.expression.SelectBase.autocommit"><tt class="xref py py-meth docutils literal">autocommit()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2194

return a new selectable with the ‘autocommit’ flag set to

2195

2196

Deprecated since version 0.6: <tt class="xref py py-func docutils literal">autocommit()</tt> is deprecated. Use <tt class="xref py py-func docutils literal">Executable.execution_options()</tt> with the ‘autocommit’ flag.

2197

</div>

2198

True.

2199

</dd></dl>

2200

2201

2202

2203

2204

2205

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.c" title="sqlalchemy.sql.expression.FromClause.c"><tt class="xref py py-attr docutils literal">c</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2206

An alias for the <a class="reference internal" href="#sqlalchemy.sql.expression.Select.columns" title="sqlalchemy.sql.expression.Select.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute.

2207

</dd></dl>

2208

2209

2210

2211

<tt class="descname">column</tt><big>(</big>column<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.column" title="Permalink to this definition">¶</a></dt>

2212

<dd>return a new select() construct with the given column expression

2213

added to its columns clause.

2214

</dd></dl>

2215

2216

2217

2218

<tt class="descname">columns</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Select.columns" title="Permalink to this definition">¶</a></dt>

2219

2220

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.columns" title="sqlalchemy.sql.expression.FromClause.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2221

A named-based collection of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> objects

2222

maintained by this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

2223

The <a class="reference internal" href="#sqlalchemy.sql.expression.Select.columns" title="sqlalchemy.sql.expression.Select.columns"><tt class="xref py py-attr docutils literal">columns</tt></a>, or <a class="reference internal" href="#sqlalchemy.sql.expression.Select.c" title="sqlalchemy.sql.expression.Select.c"><tt class="xref py py-attr docutils literal">c</tt></a> collection, is the gateway

2224

to the construction of SQL expressions using table-bound or

2225

other selectable-bound columns:

2226

<div class="highlight-python"><div class="highlight"><pre>select([mytable]).where(mytable.c.somecolumn == 5)</pre></div>

2227

</div>

2228

</dd></dl>

2229

2230

2231

2232

<tt class="descname">compare</tt><big>(</big>other, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.compare" title="Permalink to this definition">¶</a></dt>

2233

2234

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compare" title="sqlalchemy.sql.expression.ClauseElement.compare"><tt class="xref py py-meth docutils literal">compare()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

2235

Compare this ClauseElement to the given ClauseElement.

2236

Subclasses should override the default behavior, which is a

2237

straight identity comparison.

2238

**kw are arguments consumed by subclass compare() methods and

2239

may be used to modify the criteria for comparison.

2240

(see <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>)

2241

</dd></dl>

2242

2243

2244

2245

<tt class="descname">compile</tt><big>(</big>bind=None, dialect=None, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.compile" title="Permalink to this definition">¶</a></dt>

2246

2247

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compile" title="sqlalchemy.sql.expression.ClauseElement.compile"><tt class="xref py py-meth docutils literal">compile()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

2248

Compile this SQL expression.

2249

The return value is a <a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object.

2250

Calling <tt class="docutils literal">str()</tt> or <tt class="docutils literal">unicode()</tt> on the returned value will yield a

2251

string representation of the result. The

2252

<a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object also can return a

2253

dictionary of bind parameter names and values

2254

using the <tt class="docutils literal">params</tt> accessor.

2255

2256

2257

2258

2259

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

2260

<li>bind – An <tt class="docutils literal">Engine</tt> or <tt class="docutils literal">Connection</tt> from which a

2261

<tt class="docutils literal">Compiled</tt> will be acquired. This argument takes precedence over

2262

this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if any.</li>

2263

<li>column_keys – Used for INSERT and UPDATE statements, a list of

2264

column names which should be present in the VALUES clause of the

2265

compiled statement. If <tt class="docutils literal">None</tt>, all columns from the target table

2266

object are rendered.</li>

2267

<li>dialect – A <tt class="docutils literal">Dialect</tt> instance from which a <tt class="docutils literal">Compiled</tt>

2268

will be acquired. This argument takes precedence over the <cite>bind</cite>

2269

argument as well as this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if

2270

any.</li>

2271

<li>inline – Used for INSERT statements, for a dialect which does

2272

not support inline retrieval of newly generated primary key

2273

columns, will force the expression used to create the new primary

2274

key value to be rendered inline within the INSERT statement’s

2275

VALUES clause. This typically refers to Sequence execution but may

2276

also refer to any server-side default generation function

2277

associated with a primary key <cite>Column</cite>.</li>

2278

</ul>

2279

</td>

2280

</tr>

2281

</tbody>

2282

</table>

2283

</dd></dl>

2284

2285

2286

2287

<tt class="descname">correlate</tt><big>(</big>*fromclauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.correlate" title="Permalink to this definition">¶</a></dt>

2288

<dd>return a new <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> which will correlate the given FROM

2289

clauses to that of an enclosing <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>.

2290

Calling this method turns off the <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> object’s

2291

default behavior of “auto-correlation”. Normally, FROM elements

2292

which appear in a <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> that encloses this one via

2293

its <a class="reference internal" href="../glossary.html#term-where-clause">WHERE clause</a>, ORDER BY, HAVING or

2294

<a class="reference internal" href="../glossary.html#term-columns-clause">columns clause</a> will be omitted from this <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>

2295

object’s <a class="reference internal" href="../glossary.html#term-from-clause">FROM clause</a>.

2296

Setting an explicit correlation collection using the

2297

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.correlate" title="sqlalchemy.sql.expression.Select.correlate"><tt class="xref py py-meth docutils literal">Select.correlate()</tt></a> method provides a fixed list of FROM objects

2298

that can potentially take place in this process.

2299

When <a class="reference internal" href="#sqlalchemy.sql.expression.Select.correlate" title="sqlalchemy.sql.expression.Select.correlate"><tt class="xref py py-meth docutils literal">Select.correlate()</tt></a> is used to apply specific FROM clauses

2300

for correlation, the FROM elements become candidates for

2301

correlation regardless of how deeply nested this <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>

2302

object is, relative to an enclosing <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> which refers to

2303

the same FROM object. This is in contrast to the behavior of

2304

“auto-correlation” which only correlates to an immediate enclosing

2305

<a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>. Multi-level correlation ensures that the link

2306

between enclosed and enclosing <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> is always via

2307

at least one WHERE/ORDER BY/HAVING/columns clause in order for

2308

correlation to take place.

2309

If <tt class="docutils literal">None</tt> is passed, the <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> object will correlate

2310

none of its FROM entries, and all will render unconditionally

2311

in the local FROM clause.

2312

2313

2314

2315

2316

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">*fromclauses – a list of one or more <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>

2317

constructs, or other compatible constructs (i.e. ORM-mapped

2318

classes) to become part of the correlate collection.

2319

2320

Changed in version 0.8.0: ORM-mapped classes are accepted by

2321

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.correlate" title="sqlalchemy.sql.expression.Select.correlate"><tt class="xref py py-meth docutils literal">Select.correlate()</tt></a>.

2322

</div>

2323

</td>

2324

</tr>

2325

</tbody>

2326

</table>

2327

2328

Changed in version 0.8.0: The <a class="reference internal" href="#sqlalchemy.sql.expression.Select.correlate" title="sqlalchemy.sql.expression.Select.correlate"><tt class="xref py py-meth docutils literal">Select.correlate()</tt></a> method no

2329

longer unconditionally removes entries from the FROM clause; instead,

2330

the candidate FROM entries must also be matched by a FROM entry

2331

located in an enclosing <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>, which ultimately encloses

2332

this one as present in the WHERE clause, ORDER BY clause, HAVING

2333

clause, or columns clause of an enclosing <tt class="xref py py-meth docutils literal">Select()</tt>.

2334

</div>

2335

2336

Changed in version 0.8.2: explicit correlation takes place

2337

via any level of nesting of <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> objects; in previous

2338

0.8 versions, correlation would only occur relative to the immediate

2339

enclosing <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> construct.

2340

</div>

2341

2342

See also

2343

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.correlate_except" title="sqlalchemy.sql.expression.Select.correlate_except"><tt class="xref py py-meth docutils literal">Select.correlate_except()</tt></a>

2344

<a class="reference internal" href="tutorial.html#correlated-subqueries">Correlated Subqueries</a>

2345

</div>

2346

</dd></dl>

2347

2348

2349

2350

<tt class="descname">correlate_except</tt><big>(</big>*fromclauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.correlate_except" title="Permalink to this definition">¶</a></dt>

2351

<dd>return a new <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> which will omit the given FROM

2352

clauses from the auto-correlation process.

2353

Calling <a class="reference internal" href="#sqlalchemy.sql.expression.Select.correlate_except" title="sqlalchemy.sql.expression.Select.correlate_except"><tt class="xref py py-meth docutils literal">Select.correlate_except()</tt></a> turns off the

2354

<a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> object’s default behavior of

2355

“auto-correlation” for the given FROM elements. An element

2356

specified here will unconditionally appear in the FROM list, while

2357

all other FROM elements remain subject to normal auto-correlation

2358

behaviors.

2359

2360

Changed in version 0.8.2: The <a class="reference internal" href="#sqlalchemy.sql.expression.Select.correlate_except" title="sqlalchemy.sql.expression.Select.correlate_except"><tt class="xref py py-meth docutils literal">Select.correlate_except()</tt></a>

2361

method was improved to fully prevent FROM clauses specified here

2362

from being omitted from the immediate FROM clause of this

2363

<a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>.

2364

</div>

2365

If <tt class="docutils literal">None</tt> is passed, the <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> object will correlate

2366

all of its FROM entries.

2367

2368

Changed in version 0.8.2: calling <tt class="docutils literal">correlate_except(None)</tt> will

2369

correctly auto-correlate all FROM clauses.

2370

</div>

2371

2372

2373

2374

2375

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">*fromclauses – a list of one or more <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>

2376

constructs, or other compatible constructs (i.e. ORM-mapped

2377

classes) to become part of the correlate-exception collection.</td>

2378

</tr>

2379

</tbody>

2380

</table>

2381

2382

See also

2383

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.correlate" title="sqlalchemy.sql.expression.Select.correlate"><tt class="xref py py-meth docutils literal">Select.correlate()</tt></a>

2384

<a class="reference internal" href="tutorial.html#correlated-subqueries">Correlated Subqueries</a>

2385

</div>

2386

</dd></dl>

2387

2388

2389

2390

<tt class="descname">correspond_on_equivalents</tt><big>(</big>column, equivalents<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.correspond_on_equivalents" title="Permalink to this definition">¶</a></dt>

2391

2392

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.correspond_on_equivalents" title="sqlalchemy.sql.expression.FromClause.correspond_on_equivalents"><tt class="xref py py-meth docutils literal">correspond_on_equivalents()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2393

Return corresponding_column for the given column, or if None

2394

search for a match in the given dictionary.

2395

</dd></dl>

2396

2397

2398

2399

<tt class="descname">corresponding_column</tt><big>(</big>column, require_embedded=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.corresponding_column" title="Permalink to this definition">¶</a></dt>

2400

2401

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.corresponding_column" title="sqlalchemy.sql.expression.FromClause.corresponding_column"><tt class="xref py py-meth docutils literal">corresponding_column()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2402

Given a <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, return the exported

2403

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> object from this <a class="reference internal" href="#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a>

2404

which corresponds to that original

2405

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a> via a common ancestor

2406

column.

2407

2408

2409

2410

2411

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

2412

<li>column – the target <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> to be matched</li>

2413

<li>require_embedded – only return corresponding columns for</li>

2414

</ul>

2415

</td>

2416

</tr>

2417

</tbody>

2418

</table>

2419

the given <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, if the given

2420

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> is actually present within a sub-element

2421

of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>. Normally the column will match if

2422

it merely shares a common ancestor with one of the exported

2423

columns of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

2424

</dd></dl>

2425

2426

2427

2428

<tt class="descname">count</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.count" title="Permalink to this definition">¶</a></dt>

2429

2430

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.count" title="sqlalchemy.sql.expression.FromClause.count"><tt class="xref py py-meth docutils literal">count()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2431

return a SELECT COUNT generated against this

2432

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

2433

</dd></dl>

2434

2435

2436

2437

<tt class="descname">cte</tt><big>(</big>name=None, recursive=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.cte" title="Permalink to this definition">¶</a></dt>

2438

2439

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.cte" title="sqlalchemy.sql.expression.SelectBase.cte"><tt class="xref py py-meth docutils literal">cte()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2440

Return a new <a class="reference internal" href="#sqlalchemy.sql.expression.CTE" title="sqlalchemy.sql.expression.CTE"><tt class="xref py py-class docutils literal">CTE</tt></a>, or Common Table Expression instance.

2441

Common table expressions are a SQL standard whereby SELECT

2442

statements can draw upon secondary statements specified along

2443

with the primary statement, using a clause called “WITH”.

2444

Special semantics regarding UNION can also be employed to

2445

allow “recursive” queries, where a SELECT statement can draw

2446

upon the set of rows that have previously been selected.

2447

SQLAlchemy detects <a class="reference internal" href="#sqlalchemy.sql.expression.CTE" title="sqlalchemy.sql.expression.CTE"><tt class="xref py py-class docutils literal">CTE</tt></a> objects, which are treated

2448

similarly to <a class="reference internal" href="#sqlalchemy.sql.expression.Alias" title="sqlalchemy.sql.expression.Alias"><tt class="xref py py-class docutils literal">Alias</tt></a> objects, as special elements

2449

to be delivered to the FROM clause of the statement as well

2450

as to a WITH clause at the top of the statement.

2451

2452

New in version 0.7.6.

2453

</div>

2454

2455

2456

2457

2458

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

2459

<li>name – name given to the common table expression. Like

2460

<tt class="xref py py-meth docutils literal">_FromClause.alias()</tt>, the name can be left as <tt class="docutils literal">None</tt>

2461

in which case an anonymous symbol will be used at query

2462

compile time.</li>

2463

<li>recursive – if <tt class="docutils literal">True</tt>, will render <tt class="docutils literal">WITH RECURSIVE</tt>.

2464

A recursive common table expression is intended to be used in

2465

conjunction with UNION ALL in order to derive rows

2466

from those already selected.</li>

2467

</ul>

2468

</td>

2469

</tr>

2470

</tbody>

2471

</table>

2472

The following examples illustrate two examples from

2473

Postgresql’s documentation at

2474

<a class="reference external" href="http://www.postgresql.org/docs/8.4/static/queries-with.html">http://www.postgresql.org/docs/8.4/static/queries-with.html</a>.

2475

Example 1, non recursive:

2476

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import Table, Column, String, Integer, MetaData, \

2477

select, func

2478

2479

metadata = MetaData()

2480

2481

orders = Table('orders', metadata,

2482

Column('region', String),

2483

Column('amount', Integer),

2484

Column('product', String),

2485

Column('quantity', Integer)

2486

)

2487

2488

regional_sales = select([

2489

orders.c.region,

2490

func.sum(orders.c.amount).label('total_sales')

2491

]).group_by(orders.c.region).cte("regional_sales")

2492

2493

2494

top_regions = select([regional_sales.c.region]).\

2495

where(

2496

regional_sales.c.total_sales >

2497

select([

2498

func.sum(regional_sales.c.total_sales)/10

2499

])

2500

).cte("top_regions")

2501

2502

statement = select([

2503

orders.c.region,

2504

orders.c.product,

2505

func.sum(orders.c.quantity).label("product_units"),

2506

func.sum(orders.c.amount).label("product_sales")

2507

]).where(orders.c.region.in_(

2508

select([top_regions.c.region])

2509

)).group_by(orders.c.region, orders.c.product)

2510

2511

result = conn.execute(statement).fetchall()</pre></div>

2512

</div>

2513

Example 2, WITH RECURSIVE:

2514

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import Table, Column, String, Integer, MetaData, \

2515

select, func

2516

2517

metadata = MetaData()

2518

2519

parts = Table('parts', metadata,

2520

Column('part', String),

2521

Column('sub_part', String),

2522

Column('quantity', Integer),

2523

)

2524

2525

included_parts = select([

2526

parts.c.sub_part,

2527

parts.c.part,

2528

parts.c.quantity]).\

2529

where(parts.c.part=='our part').\

2530

cte(recursive=True)

2531

2532

2533

incl_alias = included_parts.alias()

2534

parts_alias = parts.alias()

2535

included_parts = included_parts.union_all(

2536

select([

2537

parts_alias.c.part,

2538

parts_alias.c.sub_part,

2539

parts_alias.c.quantity

2540

]).

2541

where(parts_alias.c.part==incl_alias.c.sub_part)

2542

)

2543

2544

statement = select([

2545

included_parts.c.sub_part,

2546

func.sum(included_parts.c.quantity).

2547

label('total_quantity')

2548

]). select_from(included_parts.join(parts,

2549

included_parts.c.part==parts.c.part)).\

2550

group_by(included_parts.c.sub_part)

2551

2552

result = conn.execute(statement).fetchall()</pre></div>

2553

</div>

2554

2555

See also

2556

<a class="reference internal" href="../orm/query.html#sqlalchemy.orm.query.Query.cte" title="sqlalchemy.orm.query.Query.cte"><tt class="xref py py-meth docutils literal">orm.query.Query.cte()</tt></a> - ORM version of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.cte" title="sqlalchemy.sql.expression.SelectBase.cte"><tt class="xref py py-meth docutils literal">SelectBase.cte()</tt></a>.

2557

</div>

2558

</dd></dl>

2559

2560

2561

2562

<tt class="descname">description</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Select.description" title="Permalink to this definition">¶</a></dt>

2563

2564

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.description" title="sqlalchemy.sql.expression.FromClause.description"><tt class="xref py py-attr docutils literal">description</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2565

a brief description of this FromClause.

2566

Used primarily for error message formatting.

2567

</dd></dl>

2568

2569

2570

2571

<tt class="descname">distinct</tt><big>(</big>*expr<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.distinct" title="Permalink to this definition">¶</a></dt>

2572

<dd>Return a new select() construct which will apply DISTINCT to its

2573

columns clause.

2574

2575

2576

2577

2578

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">*expr – optional column expressions. When present,

2579

the Postgresql dialect will render a <tt class="docutils literal">DISTINCT ON (<expressions>>)</tt>

2580

construct.</td>

2581

</tr>

2582

</tbody>

2583

</table>

2584

</dd></dl>

2585

2586

2587

2588

<tt class="descname">except_</tt><big>(</big>other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.except_" title="Permalink to this definition">¶</a></dt>

2589

<dd>return a SQL EXCEPT of this select() construct against the given

2590

selectable.

2591

</dd></dl>

2592

2593

2594

2595

<tt class="descname">except_all</tt><big>(</big>other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.except_all" title="Permalink to this definition">¶</a></dt>

2596

<dd>return a SQL EXCEPT ALL of this select() construct against the

2597

given selectable.

2598

</dd></dl>

2599

2600

2601

2602

<tt class="descname">execute</tt><big>(</big>*multiparams, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.execute" title="Permalink to this definition">¶</a></dt>

2603

2604

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.Executable.execute" title="sqlalchemy.sql.expression.Executable.execute"><tt class="xref py py-meth docutils literal">execute()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a></div>

2605

Compile and execute this <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a>.

2606

</dd></dl>

2607

2608

2609

2610

<tt class="descname">execution_options</tt><big>(</big>**kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.execution_options" title="Permalink to this definition">¶</a></dt>

2611

2612

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.Executable.execution_options" title="sqlalchemy.sql.expression.Executable.execution_options"><tt class="xref py py-meth docutils literal">execution_options()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a></div>

2613

Set non-SQL options for the statement which take effect during

2614

execution.

2615

Execution options can be set on a per-statement or

2616

per <a class="reference internal" href="connections.html#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a> basis. Additionally, the

2617

<a class="reference internal" href="connections.html#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> and ORM <a class="reference internal" href="../orm/query.html#sqlalchemy.orm.query.Query" title="sqlalchemy.orm.query.Query"><tt class="xref py py-class docutils literal">Query</tt></a> objects provide

2618

access to execution options which they in turn configure upon

2619

connections.

2620

The <a class="reference internal" href="#sqlalchemy.sql.expression.Select.execution_options" title="sqlalchemy.sql.expression.Select.execution_options"><tt class="xref py py-meth docutils literal">execution_options()</tt></a> method is generative. A new

2621

instance of this statement is returned that contains the options:

2622

<div class="highlight-python"><div class="highlight"><pre>statement = select([table.c.x, table.c.y])

2623

statement = statement.execution_options(autocommit=True)</pre></div>

2624

</div>

2625

Note that only a subset of possible execution options can be applied

2626

to a statement - these include “autocommit” and “stream_results”,

2627

but not “isolation_level” or “compiled_cache”.

2628

See <a class="reference internal" href="connections.html#sqlalchemy.engine.Connection.execution_options" title="sqlalchemy.engine.Connection.execution_options"><tt class="xref py py-meth docutils literal">Connection.execution_options()</tt></a> for a full list of

2629

possible options.

2630

2631

See also

2632

<a class="reference internal" href="connections.html#sqlalchemy.engine.Connection.execution_options" title="sqlalchemy.engine.Connection.execution_options"><tt class="xref py py-meth docutils literal">Connection.execution_options()</tt></a>

2633

<a class="reference internal" href="../orm/query.html#sqlalchemy.orm.query.Query.execution_options" title="sqlalchemy.orm.query.Query.execution_options"><tt class="xref py py-meth docutils literal">Query.execution_options()</tt></a>

2634

</div>

2635

</dd></dl>

2636

2637

2638

2639

<tt class="descname">foreign_keys</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Select.foreign_keys" title="Permalink to this definition">¶</a></dt>

2640

2641

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.foreign_keys" title="sqlalchemy.sql.expression.FromClause.foreign_keys"><tt class="xref py py-attr docutils literal">foreign_keys</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2642

Return the collection of ForeignKey objects which this

2643

FromClause references.

2644

</dd></dl>

2645

2646

2647

2648

<tt class="descname">froms</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Select.froms" title="Permalink to this definition">¶</a></dt>

2649

<dd>Return the displayed list of FromClause elements.

2650

</dd></dl>

2651

2652

2653

2654

<tt class="descname">get_children</tt><big>(</big>column_collections=True, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.get_children" title="Permalink to this definition">¶</a></dt>

2655

<dd>return child elements as per the ClauseElement specification.

2656

</dd></dl>

2657

2658

2659

2660

<tt class="descname">group_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.group_by" title="Permalink to this definition">¶</a></dt>

2661

2662

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.group_by" title="sqlalchemy.sql.expression.SelectBase.group_by"><tt class="xref py py-meth docutils literal">group_by()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2663

return a new selectable with the given list of GROUP BY

2664

criterion applied.

2665

The criterion will be appended to any pre-existing GROUP BY

2666

criterion.

2667

</dd></dl>

2668

2669

2670

2671

<tt class="descname">having</tt><big>(</big>having<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.having" title="Permalink to this definition">¶</a></dt>

2672

<dd>return a new select() construct with the given expression added to

2673

its HAVING clause, joined to the existing clause via AND, if any.

2674

</dd></dl>

2675

2676

2677

2678

<tt class="descname">inner_columns</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Select.inner_columns" title="Permalink to this definition">¶</a></dt>

2679

<dd>an iterator of all ColumnElement expressions which would

2680

be rendered into the columns clause of the resulting SELECT statement.

2681

</dd></dl>

2682

2683

2684

2685

<tt class="descname">intersect</tt><big>(</big>other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.intersect" title="Permalink to this definition">¶</a></dt>

2686

<dd>return a SQL INTERSECT of this select() construct against the given

2687

selectable.

2688

</dd></dl>

2689

2690

2691

2692

<tt class="descname">intersect_all</tt><big>(</big>other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.intersect_all" title="Permalink to this definition">¶</a></dt>

2693

<dd>return a SQL INTERSECT ALL of this select() construct against the

2694

given selectable.

2695

</dd></dl>

2696

2697

2698

2699

<tt class="descname">join</tt><big>(</big>right, onclause=None, isouter=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.join" title="Permalink to this definition">¶</a></dt>

2700

2701

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">join()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2702

return a join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

2703

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

2704

</dd></dl>

2705

2706

2707

2708

<tt class="descname">label</tt><big>(</big>name<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.label" title="Permalink to this definition">¶</a></dt>

2709

2710

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.label" title="sqlalchemy.sql.expression.SelectBase.label"><tt class="xref py py-meth docutils literal">label()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2711

return a ‘scalar’ representation of this selectable, embedded as a

2712

subquery with a label.

2713

2714

See also

2715

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.as_scalar" title="sqlalchemy.sql.expression.SelectBase.as_scalar"><tt class="xref py py-meth docutils literal">as_scalar()</tt></a>.

2716

</div>

2717

</dd></dl>

2718

2719

2720

2721

<tt class="descname">limit</tt><big>(</big>limit<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.limit" title="Permalink to this definition">¶</a></dt>

2722

2723

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.limit" title="sqlalchemy.sql.expression.SelectBase.limit"><tt class="xref py py-meth docutils literal">limit()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2724

return a new selectable with the given LIMIT criterion

2725

applied.

2726

</dd></dl>

2727

2728

2729

2730

<tt class="descname">locate_all_froms</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Select.locate_all_froms" title="Permalink to this definition">¶</a></dt>

2731

<dd>return a Set of all FromClause elements referenced by this Select.

2732

This set is a superset of that returned by the <tt class="docutils literal">froms</tt> property,

2733

which is specifically for those FromClause elements that would

2734

actually be rendered.

2735

</dd></dl>

2736

2737

2738

2739

<tt class="descname">offset</tt><big>(</big>offset<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.offset" title="Permalink to this definition">¶</a></dt>

2740

2741

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.offset" title="sqlalchemy.sql.expression.SelectBase.offset"><tt class="xref py py-meth docutils literal">offset()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2742

return a new selectable with the given OFFSET criterion

2743

applied.

2744

</dd></dl>

2745

2746

2747

2748

<tt class="descname">order_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.order_by" title="Permalink to this definition">¶</a></dt>

2749

2750

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.order_by" title="sqlalchemy.sql.expression.SelectBase.order_by"><tt class="xref py py-meth docutils literal">order_by()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase" title="sqlalchemy.sql.expression.SelectBase"><tt class="xref py py-class docutils literal">SelectBase</tt></a></div>

2751

return a new selectable with the given list of ORDER BY

2752

criterion applied.

2753

The criterion will be appended to any pre-existing ORDER BY

2754

criterion.

2755

</dd></dl>

2756

2757

2758

2759

<tt class="descname">outerjoin</tt><big>(</big>right, onclause=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.outerjoin" title="Permalink to this definition">¶</a></dt>

2760

2761

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.outerjoin" title="sqlalchemy.sql.expression.FromClause.outerjoin"><tt class="xref py py-meth docutils literal">outerjoin()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2762

return an outer join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

2763

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

2764

</dd></dl>

2765

2766

2767

2768

<tt class="descname">params</tt><big>(</big>*optionaldict, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.params" title="Permalink to this definition">¶</a></dt>

2769

2770

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.params" title="sqlalchemy.sql.expression.ClauseElement.params"><tt class="xref py py-meth docutils literal">params()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

2771

Return a copy with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> elements replaced.

2772

Returns a copy of this ClauseElement with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a>

2773

elements replaced with values taken from the given dictionary:

2774

<div class="highlight-python"><div class="highlight"><pre>>>> clause = column('x') + bindparam('foo')

2775

>>> print clause.compile().params

2776

{'foo':None}

2777

>>> print clause.params({'foo':7}).compile().params

2778

{'foo':7}</pre></div>

2779

</div>

2780

</dd></dl>

2781

2782

2783

2784

<tt class="descname">prefix_with</tt><big>(</big>*expr, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.prefix_with" title="Permalink to this definition">¶</a></dt>

2785

2786

inherited from the <tt class="xref py py-meth docutils literal">prefix_with()</tt> method of <tt class="xref py py-class docutils literal">HasPrefixes</tt></div>

2787

Add one or more expressions following the statement keyword, i.e.

2788

SELECT, INSERT, UPDATE, or DELETE. Generative.

2789

This is used to support backend-specific prefix keywords such as those

2790

provided by MySQL.

2791

E.g.:

2792

<div class="highlight-python"><div class="highlight"><pre>stmt = table.insert().prefix_with("LOW_PRIORITY", dialect="mysql")</pre></div>

2793

</div>

2794

Multiple prefixes can be specified by multiple calls

2795

to <a class="reference internal" href="#sqlalchemy.sql.expression.Select.prefix_with" title="sqlalchemy.sql.expression.Select.prefix_with"><tt class="xref py py-meth docutils literal">prefix_with()</tt></a>.

2796

2797

2798

2799

2800

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

2801

<li>*expr – textual or <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a> construct which

2802

will be rendered following the INSERT, UPDATE, or DELETE

2803

keyword.</li>

2804

<li>**kw – A single keyword ‘dialect’ is accepted. This is an

2805

optional string dialect name which will

2806

limit rendering of this prefix to only that dialect.</li>

2807

</ul>

2808

</td>

2809

</tr>

2810

</tbody>

2811

</table>

2812

</dd></dl>

2813

2814

2815

2816

<tt class="descname">primary_key</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Select.primary_key" title="Permalink to this definition">¶</a></dt>

2817

2818

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.primary_key" title="sqlalchemy.sql.expression.FromClause.primary_key"><tt class="xref py py-attr docutils literal">primary_key</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2819

Return the collection of Column objects which comprise the

2820

primary key of this FromClause.

2821

</dd></dl>

2822

2823

2824

2825

<tt class="descname">reduce_columns</tt><big>(</big>only_synonyms=True<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.reduce_columns" title="Permalink to this definition">¶</a></dt>

2826

<dd>Return a new :func`.select` construct with redundantly

2827

named, equivalently-valued columns removed from the columns clause.

2828

“Redundant” here means two columns where one refers to the

2829

other either based on foreign key, or via a simple equality

2830

comparison in the WHERE clause of the statement. The primary purpose

2831

of this method is to automatically construct a select statement

2832

with all uniquely-named columns, without the need to use

2833

table-qualified labels as <a class="reference internal" href="#sqlalchemy.sql.expression.Select.apply_labels" title="sqlalchemy.sql.expression.Select.apply_labels"><tt class="xref py py-meth docutils literal">apply_labels()</tt></a> does.

2834

When columns are omitted based on foreign key, the referred-to

2835

column is the one that’s kept. When columns are omitted based on

2836

WHERE eqivalence, the first column in the columns clause is the

2837

one that’s kept.

2838

2839

2840

2841

2842

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">only_synonyms – when True, limit the removal of columns

2843

to those which have the same name as the equivalent. Otherwise,

2844

all columns that are equivalent to another are removed.</td>

2845

</tr>

2846

</tbody>

2847

</table>

2848

2849

New in version 0.8.

2850

</div>

2851

</dd></dl>

2852

2853

2854

2855

<tt class="descname">replace_selectable</tt><big>(</big>old, alias<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.replace_selectable" title="Permalink to this definition">¶</a></dt>

2856

2857

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.replace_selectable" title="sqlalchemy.sql.expression.FromClause.replace_selectable"><tt class="xref py py-meth docutils literal">replace_selectable()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2858

replace all occurrences of FromClause ‘old’ with the given Alias

2859

object, returning a copy of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

2860

</dd></dl>

2861

2862

2863

2864

<tt class="descname">scalar</tt><big>(</big>*multiparams, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.scalar" title="Permalink to this definition">¶</a></dt>

2865

2866

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.Executable.scalar" title="sqlalchemy.sql.expression.Executable.scalar"><tt class="xref py py-meth docutils literal">scalar()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a></div>

2867

Compile and execute this <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a>, returning the

2868

result’s scalar representation.

2869

</dd></dl>

2870

2871

2872

2873

<tt class="descname">select</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.select" title="Permalink to this definition">¶</a></dt>

2874

2875

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.select" title="sqlalchemy.sql.expression.FromClause.select"><tt class="xref py py-meth docutils literal">select()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

2876

return a SELECT of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

2877

2878

See also

2879

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> - general purpose

2880

method which allows for arbitrary column lists.

2881

</div>

2882

</dd></dl>

2883

2884

2885

2886

<tt class="descname">select_from</tt><big>(</big>fromclause<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.select_from" title="Permalink to this definition">¶</a></dt>

2887

<dd>return a new <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> construct with the

2888

given FROM expression

2889

merged into its list of FROM objects.

2890

E.g.:

2891

<div class="highlight-python"><div class="highlight"><pre>table1 = table('t1', column('a'))

2892

table2 = table('t2', column('b'))

2893

s = select([table1.c.a]).\

2894

select_from(

2895

table1.join(table2, table1.c.a==table2.c.b)

2896

)</pre></div>

2897

</div>

2898

The “from” list is a unique set on the identity of each element,

2899

so adding an already present <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> or other selectable

2900

will have no effect. Passing a <a class="reference internal" href="#sqlalchemy.sql.expression.Join" title="sqlalchemy.sql.expression.Join"><tt class="xref py py-class docutils literal">Join</tt></a> that refers

2901

to an already present <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> or other selectable will have

2902

the effect of concealing the presence of that selectable as

2903

an individual element in the rendered FROM list, instead

2904

rendering it into a JOIN clause.

2905

While the typical purpose of <a class="reference internal" href="#sqlalchemy.sql.expression.Select.select_from" title="sqlalchemy.sql.expression.Select.select_from"><tt class="xref py py-meth docutils literal">Select.select_from()</tt></a> is to

2906

replace the default, derived FROM clause with a join, it can

2907

also be called with individual table elements, multiple times

2908

if desired, in the case that the FROM clause cannot be fully

2909

derived from the columns clause:

2910

<div class="highlight-python"><div class="highlight"><pre>select([func.count('*')]).select_from(table1)</pre></div>

2911

</div>

2912

</dd></dl>

2913

2914

2915

2916

<tt class="descname">self_group</tt><big>(</big>against=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.self_group" title="Permalink to this definition">¶</a></dt>

2917

<dd>return a ‘grouping’ construct as per the ClauseElement

2918

specification.

2919

This produces an element that can be embedded in an expression. Note

2920

that this method is called automatically as needed when constructing

2921

expressions and should not require explicit use.

2922

</dd></dl>

2923

2924

2925

2926

<tt class="descname">union</tt><big>(</big>other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.union" title="Permalink to this definition">¶</a></dt>

2927

<dd>return a SQL UNION of this select() construct against the given

2928

selectable.

2929

</dd></dl>

2930

2931

2932

2933

<tt class="descname">union_all</tt><big>(</big>other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.union_all" title="Permalink to this definition">¶</a></dt>

2934

<dd>return a SQL UNION ALL of this select() construct against the given

2935

selectable.

2936

</dd></dl>

2937

2938

2939

2940

<tt class="descname">unique_params</tt><big>(</big>*optionaldict, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.unique_params" title="Permalink to this definition">¶</a></dt>

2941

2942

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.unique_params" title="sqlalchemy.sql.expression.ClauseElement.unique_params"><tt class="xref py py-meth docutils literal">unique_params()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

2943

Return a copy with <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> elements replaced.

2944

Same functionality as <tt class="docutils literal">params()</tt>, except adds <cite>unique=True</cite>

2945

to affected bind parameters so that multiple statements can be

2946

used.

2947

</dd></dl>

2948

2949

2950

2951

<tt class="descname">where</tt><big>(</big>whereclause<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.where" title="Permalink to this definition">¶</a></dt>

2952

<dd>return a new select() construct with the given expression added to

2953

its WHERE clause, joined to the existing clause via AND, if any.

2954

</dd></dl>

2955

2956

2957

2958

<tt class="descname">with_hint</tt><big>(</big>selectable, text, dialect_name='*'<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.with_hint" title="Permalink to this definition">¶</a></dt>

2959

<dd>Add an indexing hint for the given selectable to this

2960

<a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a>.

2961

The text of the hint is rendered in the appropriate

2962

location for the database backend in use, relative

2963

to the given <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> or <a class="reference internal" href="#sqlalchemy.sql.expression.Alias" title="sqlalchemy.sql.expression.Alias"><tt class="xref py py-class docutils literal">Alias</tt></a> passed as the

2964

<tt class="docutils literal">selectable</tt> argument. The dialect implementation

2965

typically uses Python string substitution syntax

2966

with the token <tt class="docutils literal">%(name)s</tt> to render the name of

2967

the table or alias. E.g. when using Oracle, the

2968

following:

2969

<div class="highlight-python"><div class="highlight"><pre>select([mytable]).\

2970

with_hint(mytable, "+ index(%(name)s ix_mytable)")</pre></div>

2971

</div>

2972

Would render SQL as:

2973

<div class="highlight-python"><pre>select /*+ index(mytable ix_mytable) */ ... from mytable</pre>

2974

</div>

2975

The <tt class="docutils literal">dialect_name</tt> option will limit the rendering of a particular

2976

hint to a particular backend. Such as, to add hints for both Oracle

2977

and Sybase simultaneously:

2978

<div class="highlight-python"><div class="highlight"><pre>select([mytable]).\

2979

with_hint(mytable, "+ index(%(name)s ix_mytable)", 'oracle').\

2980

with_hint(mytable, "WITH INDEX ix_mytable", 'sybase')</pre></div>

2981

</div>

2982

</dd></dl>

2983

2984

2985

2986

<tt class="descname">with_only_columns</tt><big>(</big>columns<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.Select.with_only_columns" title="Permalink to this definition">¶</a></dt>

2987

<dd>Return a new <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> construct with its columns

2988

clause replaced with the given columns.

2989

2990

Changed in version 0.7.3: Due to a bug fix, this method has a slight

2991

behavioral change as of version 0.7.3.

2992

Prior to version 0.7.3, the FROM clause of

2993

a <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> was calculated upfront and as new columns

2994

were added; in 0.7.3 and later it’s calculated

2995

at compile time, fixing an issue regarding late binding

2996

of columns to parent tables. This changes the behavior of

2997

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.with_only_columns" title="sqlalchemy.sql.expression.Select.with_only_columns"><tt class="xref py py-meth docutils literal">Select.with_only_columns()</tt></a> in that FROM clauses no

2998

longer represented in the new list are dropped,

2999

but this behavior is more consistent in

3000

that the FROM clauses are consistently derived from the

3001

current columns clause. The original intent of this method

3002

is to allow trimming of the existing columns list to be fewer

3003

columns than originally present; the use case of replacing

3004

the columns list with an entirely different one hadn’t

3005

been anticipated until 0.7.3 was released; the usage

3006

guidelines below illustrate how this should be done.

3007

</div>

3008

This method is exactly equivalent to as if the original

3009

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> had been called with the given columns

3010

clause. I.e. a statement:

3011

<div class="highlight-python"><div class="highlight"><pre>s = select([table1.c.a, table1.c.b])

3012

s = s.with_only_columns([table1.c.b])</pre></div>

3013

</div>

3014

should be exactly equivalent to:

3015

<div class="highlight-python"><div class="highlight"><pre>s = select([table1.c.b])</pre></div>

3016

</div>

3017

This means that FROM clauses which are only derived

3018

from the column list will be discarded if the new column

3019

list no longer contains that FROM:

3020

<div class="highlight-python"><div class="highlight"><pre>>>> table1 = table('t1', column('a'), column('b'))

3021

>>> table2 = table('t2', column('a'), column('b'))

3022

>>> s1 = select([table1.c.a, table2.c.b])

3023

>>> print s1

3024

SELECT t1.a, t2.b FROM t1, t2

3025

>>> s2 = s1.with_only_columns([table2.c.b])

3026

>>> print s2

3027

SELECT t2.b FROM t1</pre></div>

3028

</div>

3029

The preferred way to maintain a specific FROM clause

3030

in the construct, assuming it won’t be represented anywhere

3031

else (i.e. not in the WHERE clause, etc.) is to set it using

3032

<a class="reference internal" href="#sqlalchemy.sql.expression.Select.select_from" title="sqlalchemy.sql.expression.Select.select_from"><tt class="xref py py-meth docutils literal">Select.select_from()</tt></a>:

3033

<div class="highlight-python"><div class="highlight"><pre>>>> s1 = select([table1.c.a, table2.c.b]).\

3034

... select_from(table1.join(table2,

3035

... table1.c.a==table2.c.a))

3036

>>> s2 = s1.with_only_columns([table2.c.b])

3037

>>> print s2

3038

SELECT t2.b FROM t1 JOIN t2 ON t1.a=t2.a</pre></div>

3039

</div>

3040

Care should also be taken to use the correct

3041

set of column objects passed to <a class="reference internal" href="#sqlalchemy.sql.expression.Select.with_only_columns" title="sqlalchemy.sql.expression.Select.with_only_columns"><tt class="xref py py-meth docutils literal">Select.with_only_columns()</tt></a>.

3042

Since the method is essentially equivalent to calling the

3043

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> construct in the first place with the given

3044

columns, the columns passed to <a class="reference internal" href="#sqlalchemy.sql.expression.Select.with_only_columns" title="sqlalchemy.sql.expression.Select.with_only_columns"><tt class="xref py py-meth docutils literal">Select.with_only_columns()</tt></a>

3045

should usually be a subset of those which were passed

3046

to the <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> construct, not those which are available

3047

from the <tt class="docutils literal">.c</tt> collection of that <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>. That

3048

is:

3049

<div class="highlight-python"><div class="highlight"><pre>s = select([table1.c.a, table1.c.b]).select_from(table1)

3050

s = s.with_only_columns([table1.c.b])</pre></div>

3051

</div>

3052

and not:

3053

<div class="highlight-python"><div class="highlight"><pre># usually incorrect

3054

s = s.with_only_columns([s.c.b])</pre></div>

3055

</div>

3056

The latter would produce the SQL:

3057

<div class="highlight-python"><pre>SELECT b

3058

FROM (SELECT t1.a AS a, t1.b AS b

3059

FROM t1), t1</pre>

3060

</div>

3061

Since the <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> construct is essentially being

3062

asked to select both from <tt class="docutils literal">table1</tt> as well as itself.

3063

</dd></dl>

3064

3065

</dd></dl>

3066

3067

3068

3069

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">Selectable</tt><a class="headerlink" href="#sqlalchemy.sql.expression.Selectable" title="Permalink to this definition">¶</a></dt>

3070

<dd>Bases: <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.ClauseElement</tt></a>

3071

mark a class as being selectable

3072

</dd></dl>

3073

3074

3075

3076

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">SelectBase</tt><big>(</big>use_labels=False, for_update=False, limit=None, offset=None, order_by=None, group_by=None, bind=None, autocommit=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase" title="Permalink to this definition">¶</a></dt>

3077

<dd>Bases: <a class="reference internal" href="#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.Executable</tt></a>, <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.FromClause</tt></a>

3078

Base class for <a class="reference internal" href="#sqlalchemy.sql.expression.Select" title="sqlalchemy.sql.expression.Select"><tt class="xref py py-class docutils literal">Select</tt></a> and <a class="reference internal" href="#sqlalchemy.sql.expression.CompoundSelect" title="sqlalchemy.sql.expression.CompoundSelect"><tt class="xref py py-class docutils literal">CompoundSelect</tt></a>.

3079

3080

3081

<tt class="descname">append_group_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.append_group_by" title="Permalink to this definition">¶</a></dt>

3082

<dd>Append the given GROUP BY criterion applied to this selectable.

3083

The criterion will be appended to any pre-existing GROUP BY criterion.

3084

This is an in-place mutation method; the

3085

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.group_by" title="sqlalchemy.sql.expression.SelectBase.group_by"><tt class="xref py py-meth docutils literal">group_by()</tt></a> method is preferred, as it provides standard

3086

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

3087

</dd></dl>

3088

3089

3090

3091

<tt class="descname">append_order_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.append_order_by" title="Permalink to this definition">¶</a></dt>

3092

<dd>Append the given ORDER BY criterion applied to this selectable.

3093

The criterion will be appended to any pre-existing ORDER BY criterion.

3094

This is an in-place mutation method; the

3095

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.order_by" title="sqlalchemy.sql.expression.SelectBase.order_by"><tt class="xref py py-meth docutils literal">order_by()</tt></a> method is preferred, as it provides standard

3096

<a class="reference internal" href="../glossary.html#term-method-chaining">method chaining</a>.

3097

</dd></dl>

3098

3099

3100

3101

<tt class="descname">apply_labels</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.apply_labels" title="Permalink to this definition">¶</a></dt>

3102

<dd>return a new selectable with the ‘use_labels’ flag set to True.

3103

This will result in column expressions being generated using labels

3104

against their table name, such as “SELECT somecolumn AS

3105

tablename_somecolumn”. This allows selectables which contain multiple

3106

FROM clauses to produce a unique set of column names regardless of

3107

name conflicts among the individual FROM clauses.

3108

</dd></dl>

3109

3110

3111

3112

<tt class="descname">as_scalar</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.as_scalar" title="Permalink to this definition">¶</a></dt>

3113

<dd>return a ‘scalar’ representation of this selectable, which can be

3114

used as a column expression.

3115

Typically, a select statement which has only one column in its columns

3116

clause is eligible to be used as a scalar expression.

3117

The returned object is an instance of

3118

<tt class="xref py py-class docutils literal">ScalarSelect</tt>.

3119

</dd></dl>

3120

3121

3122

3123

<tt class="descname">autocommit</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.autocommit" title="Permalink to this definition">¶</a></dt>

3124

<dd>return a new selectable with the ‘autocommit’ flag set to

3125

3126

Deprecated since version 0.6: <tt class="xref py py-func docutils literal">autocommit()</tt> is deprecated. Use <tt class="xref py py-func docutils literal">Executable.execution_options()</tt> with the ‘autocommit’ flag.

3127

</div>

3128

True.

3129

</dd></dl>

3130

3131

3132

3133

<tt class="descname">cte</tt><big>(</big>name=None, recursive=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.cte" title="Permalink to this definition">¶</a></dt>

3134

<dd>Return a new <a class="reference internal" href="#sqlalchemy.sql.expression.CTE" title="sqlalchemy.sql.expression.CTE"><tt class="xref py py-class docutils literal">CTE</tt></a>, or Common Table Expression instance.

3135

Common table expressions are a SQL standard whereby SELECT

3136

statements can draw upon secondary statements specified along

3137

with the primary statement, using a clause called “WITH”.

3138

Special semantics regarding UNION can also be employed to

3139

allow “recursive” queries, where a SELECT statement can draw

3140

upon the set of rows that have previously been selected.

3141

SQLAlchemy detects <a class="reference internal" href="#sqlalchemy.sql.expression.CTE" title="sqlalchemy.sql.expression.CTE"><tt class="xref py py-class docutils literal">CTE</tt></a> objects, which are treated

3142

similarly to <a class="reference internal" href="#sqlalchemy.sql.expression.Alias" title="sqlalchemy.sql.expression.Alias"><tt class="xref py py-class docutils literal">Alias</tt></a> objects, as special elements

3143

to be delivered to the FROM clause of the statement as well

3144

as to a WITH clause at the top of the statement.

3145

3146

New in version 0.7.6.

3147

</div>

3148

3149

3150

3151

3152

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

3153

<li>name – name given to the common table expression. Like

3154

<tt class="xref py py-meth docutils literal">_FromClause.alias()</tt>, the name can be left as <tt class="docutils literal">None</tt>

3155

in which case an anonymous symbol will be used at query

3156

compile time.</li>

3157

<li>recursive – if <tt class="docutils literal">True</tt>, will render <tt class="docutils literal">WITH RECURSIVE</tt>.

3158

A recursive common table expression is intended to be used in

3159

conjunction with UNION ALL in order to derive rows

3160

from those already selected.</li>

3161

</ul>

3162

</td>

3163

</tr>

3164

</tbody>

3165

</table>

3166

The following examples illustrate two examples from

3167

Postgresql’s documentation at

3168

<a class="reference external" href="http://www.postgresql.org/docs/8.4/static/queries-with.html">http://www.postgresql.org/docs/8.4/static/queries-with.html</a>.

3169

Example 1, non recursive:

3170

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import Table, Column, String, Integer, MetaData, \

3171

select, func

3172

3173

metadata = MetaData()

3174

3175

orders = Table('orders', metadata,

3176

Column('region', String),

3177

Column('amount', Integer),

3178

Column('product', String),

3179

Column('quantity', Integer)

3180

)

3181

3182

regional_sales = select([

3183

orders.c.region,

3184

func.sum(orders.c.amount).label('total_sales')

3185

]).group_by(orders.c.region).cte("regional_sales")

3186

3187

3188

top_regions = select([regional_sales.c.region]).\

3189

where(

3190

regional_sales.c.total_sales >

3191

select([

3192

func.sum(regional_sales.c.total_sales)/10

3193

])

3194

).cte("top_regions")

3195

3196

statement = select([

3197

orders.c.region,

3198

orders.c.product,

3199

func.sum(orders.c.quantity).label("product_units"),

3200

func.sum(orders.c.amount).label("product_sales")

3201

]).where(orders.c.region.in_(

3202

select([top_regions.c.region])

3203

)).group_by(orders.c.region, orders.c.product)

3204

3205

result = conn.execute(statement).fetchall()</pre></div>

3206

</div>

3207

Example 2, WITH RECURSIVE:

3208

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import Table, Column, String, Integer, MetaData, \

3209

select, func

3210

3211

metadata = MetaData()

3212

3213

parts = Table('parts', metadata,

3214

Column('part', String),

3215

Column('sub_part', String),

3216

Column('quantity', Integer),

3217

)

3218

3219

included_parts = select([

3220

parts.c.sub_part,

3221

parts.c.part,

3222

parts.c.quantity]).\

3223

where(parts.c.part=='our part').\

3224

cte(recursive=True)

3225

3226

3227

incl_alias = included_parts.alias()

3228

parts_alias = parts.alias()

3229

included_parts = included_parts.union_all(

3230

select([

3231

parts_alias.c.part,

3232

parts_alias.c.sub_part,

3233

parts_alias.c.quantity

3234

]).

3235

where(parts_alias.c.part==incl_alias.c.sub_part)

3236

)

3237

3238

statement = select([

3239

included_parts.c.sub_part,

3240

func.sum(included_parts.c.quantity).

3241

label('total_quantity')

3242

]). select_from(included_parts.join(parts,

3243

included_parts.c.part==parts.c.part)).\

3244

group_by(included_parts.c.sub_part)

3245

3246

result = conn.execute(statement).fetchall()</pre></div>

3247

</div>

3248

3249

See also

3250

<a class="reference internal" href="../orm/query.html#sqlalchemy.orm.query.Query.cte" title="sqlalchemy.orm.query.Query.cte"><tt class="xref py py-meth docutils literal">orm.query.Query.cte()</tt></a> - ORM version of <a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.cte" title="sqlalchemy.sql.expression.SelectBase.cte"><tt class="xref py py-meth docutils literal">SelectBase.cte()</tt></a>.

3251

</div>

3252

</dd></dl>

3253

3254

3255

3256

<tt class="descname">group_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.group_by" title="Permalink to this definition">¶</a></dt>

3257

<dd>return a new selectable with the given list of GROUP BY

3258

criterion applied.

3259

The criterion will be appended to any pre-existing GROUP BY

3260

criterion.

3261

</dd></dl>

3262

3263

3264

3265

<tt class="descname">label</tt><big>(</big>name<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.label" title="Permalink to this definition">¶</a></dt>

3266

<dd>return a ‘scalar’ representation of this selectable, embedded as a

3267

subquery with a label.

3268

3269

See also

3270

<a class="reference internal" href="#sqlalchemy.sql.expression.SelectBase.as_scalar" title="sqlalchemy.sql.expression.SelectBase.as_scalar"><tt class="xref py py-meth docutils literal">as_scalar()</tt></a>.

3271

</div>

3272

</dd></dl>

3273

3274

3275

3276

<tt class="descname">limit</tt><big>(</big>limit<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.limit" title="Permalink to this definition">¶</a></dt>

3277

<dd>return a new selectable with the given LIMIT criterion

3278

applied.

3279

</dd></dl>

3280

3281

3282

3283

<tt class="descname">offset</tt><big>(</big>offset<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.offset" title="Permalink to this definition">¶</a></dt>

3284

<dd>return a new selectable with the given OFFSET criterion

3285

applied.

3286

</dd></dl>

3287

3288

3289

3290

<tt class="descname">order_by</tt><big>(</big>*clauses<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.SelectBase.order_by" title="Permalink to this definition">¶</a></dt>

3291

<dd>return a new selectable with the given list of ORDER BY

3292

criterion applied.

3293

The criterion will be appended to any pre-existing ORDER BY

3294

criterion.

3295

</dd></dl>

3296

3297

</dd></dl>

3298

3299

3300

3301

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">TableClause</tt><big>(</big>name, *columns<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause" title="Permalink to this definition">¶</a></dt>

3302

<dd>Bases: <tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.Immutable</tt>, <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">sqlalchemy.sql.expression.FromClause</tt></a>

3303

Represents a minimal “table” construct.

3304

The constructor for <a class="reference internal" href="#sqlalchemy.sql.expression.TableClause" title="sqlalchemy.sql.expression.TableClause"><tt class="xref py py-class docutils literal">TableClause</tt></a> is the

3305

<a class="reference internal" href="#sqlalchemy.sql.expression.table" title="sqlalchemy.sql.expression.table"><tt class="xref py py-func docutils literal">table()</tt></a> function. This produces

3306

a lightweight table object that has only a name and a

3307

collection of columns, which are typically produced

3308

by the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.column" title="sqlalchemy.sql.expression.column"><tt class="xref py py-func docutils literal">column()</tt></a> function:

3309

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy.sql import table, column

3310

3311

user = table("user",

3312

column("id"),

3313

column("name"),

3314

column("description"),

3315

)</pre></div>

3316

</div>

3317

The <a class="reference internal" href="#sqlalchemy.sql.expression.TableClause" title="sqlalchemy.sql.expression.TableClause"><tt class="xref py py-class docutils literal">TableClause</tt></a> construct serves as the base for

3318

the more commonly used <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> object, providing

3319

the usual set of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> services including

3320

the <tt class="docutils literal">.c.</tt> collection and statement generation methods.

3321

It does not provide all the additional schema-level services

3322

of <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>, including constraints, references to other

3323

tables, or support for <a class="reference internal" href="metadata.html#sqlalchemy.schema.MetaData" title="sqlalchemy.schema.MetaData"><tt class="xref py py-class docutils literal">MetaData</tt></a>-level services. It’s useful

3324

on its own as an ad-hoc construct used to generate quick SQL

3325

statements when a more fully fledged <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>

3326

is not on hand.

3327

3328

3329

<tt class="descname">alias</tt><big>(</big>name=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.alias" title="Permalink to this definition">¶</a></dt>

3330

3331

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.alias" title="sqlalchemy.sql.expression.FromClause.alias"><tt class="xref py py-meth docutils literal">alias()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3332

return an alias of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

3333

This is shorthand for calling:

3334

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy import alias

3335

a = alias(self, name=name)</pre></div>

3336

</div>

3337

See <a class="reference internal" href="#sqlalchemy.sql.expression.alias" title="sqlalchemy.sql.expression.alias"><tt class="xref py py-func docutils literal">alias()</tt></a> for details.

3338

</dd></dl>

3339

3340

3341

3342

3343

3344

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.c" title="sqlalchemy.sql.expression.FromClause.c"><tt class="xref py py-attr docutils literal">c</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3345

An alias for the <a class="reference internal" href="#sqlalchemy.sql.expression.TableClause.columns" title="sqlalchemy.sql.expression.TableClause.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute.

3346

</dd></dl>

3347

3348

3349

3350

<tt class="descname">columns</tt><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.columns" title="Permalink to this definition">¶</a></dt>

3351

3352

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.columns" title="sqlalchemy.sql.expression.FromClause.columns"><tt class="xref py py-attr docutils literal">columns</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3353

A named-based collection of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> objects

3354

maintained by this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

3355

The <a class="reference internal" href="#sqlalchemy.sql.expression.TableClause.columns" title="sqlalchemy.sql.expression.TableClause.columns"><tt class="xref py py-attr docutils literal">columns</tt></a>, or <a class="reference internal" href="#sqlalchemy.sql.expression.TableClause.c" title="sqlalchemy.sql.expression.TableClause.c"><tt class="xref py py-attr docutils literal">c</tt></a> collection, is the gateway

3356

to the construction of SQL expressions using table-bound or

3357

other selectable-bound columns:

3358

<div class="highlight-python"><div class="highlight"><pre>select([mytable]).where(mytable.c.somecolumn == 5)</pre></div>

3359

</div>

3360

</dd></dl>

3361

3362

3363

3364

<tt class="descname">compare</tt><big>(</big>other, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.compare" title="Permalink to this definition">¶</a></dt>

3365

3366

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compare" title="sqlalchemy.sql.expression.ClauseElement.compare"><tt class="xref py py-meth docutils literal">compare()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

3367

Compare this ClauseElement to the given ClauseElement.

3368

Subclasses should override the default behavior, which is a

3369

straight identity comparison.

3370

**kw are arguments consumed by subclass compare() methods and

3371

may be used to modify the criteria for comparison.

3372

(see <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>)

3373

</dd></dl>

3374

3375

3376

3377

<tt class="descname">compile</tt><big>(</big>bind=None, dialect=None, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.compile" title="Permalink to this definition">¶</a></dt>

3378

3379

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.compile" title="sqlalchemy.sql.expression.ClauseElement.compile"><tt class="xref py py-meth docutils literal">compile()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

3380

Compile this SQL expression.

3381

The return value is a <a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object.

3382

Calling <tt class="docutils literal">str()</tt> or <tt class="docutils literal">unicode()</tt> on the returned value will yield a

3383

string representation of the result. The

3384

<a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Compiled" title="sqlalchemy.engine.interfaces.Compiled"><tt class="xref py py-class docutils literal">Compiled</tt></a> object also can return a

3385

dictionary of bind parameter names and values

3386

using the <tt class="docutils literal">params</tt> accessor.

3387

3388

3389

3390

3391

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

3392

<li>bind – An <tt class="docutils literal">Engine</tt> or <tt class="docutils literal">Connection</tt> from which a

3393

<tt class="docutils literal">Compiled</tt> will be acquired. This argument takes precedence over

3394

this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if any.</li>

3395

<li>column_keys – Used for INSERT and UPDATE statements, a list of

3396

column names which should be present in the VALUES clause of the

3397

compiled statement. If <tt class="docutils literal">None</tt>, all columns from the target table

3398

object are rendered.</li>

3399

<li>dialect – A <tt class="docutils literal">Dialect</tt> instance from which a <tt class="docutils literal">Compiled</tt>

3400

will be acquired. This argument takes precedence over the <cite>bind</cite>

3401

argument as well as this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>‘s bound engine, if

3402

any.</li>

3403

<li>inline – Used for INSERT statements, for a dialect which does

3404

not support inline retrieval of newly generated primary key

3405

columns, will force the expression used to create the new primary

3406

key value to be rendered inline within the INSERT statement’s

3407

VALUES clause. This typically refers to Sequence execution but may

3408

also refer to any server-side default generation function

3409

associated with a primary key <cite>Column</cite>.</li>

3410

</ul>

3411

</td>

3412

</tr>

3413

</tbody>

3414

</table>

3415

</dd></dl>

3416

3417

3418

3419

<tt class="descname">correspond_on_equivalents</tt><big>(</big>column, equivalents<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.correspond_on_equivalents" title="Permalink to this definition">¶</a></dt>

3420

3421

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.correspond_on_equivalents" title="sqlalchemy.sql.expression.FromClause.correspond_on_equivalents"><tt class="xref py py-meth docutils literal">correspond_on_equivalents()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3422

Return corresponding_column for the given column, or if None

3423

search for a match in the given dictionary.

3424

</dd></dl>

3425

3426

3427

3428

<tt class="descname">corresponding_column</tt><big>(</big>column, require_embedded=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.corresponding_column" title="Permalink to this definition">¶</a></dt>

3429

3430

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.corresponding_column" title="sqlalchemy.sql.expression.FromClause.corresponding_column"><tt class="xref py py-meth docutils literal">corresponding_column()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3431

Given a <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, return the exported

3432

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> object from this <a class="reference internal" href="#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a>

3433

which corresponds to that original

3434

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a> via a common ancestor

3435

column.

3436

3437

3438

3439

3440

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

3441

<li>column – the target <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> to be matched</li>

3442

<li>require_embedded – only return corresponding columns for</li>

3443

</ul>

3444

</td>

3445

</tr>

3446

</tbody>

3447

</table>

3448

the given <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>, if the given

3449

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> is actually present within a sub-element

3450

of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>. Normally the column will match if

3451

it merely shares a common ancestor with one of the exported

3452

columns of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

3453

</dd></dl>

3454

3455

3456

3457

<tt class="descname">count</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.count" title="Permalink to this definition">¶</a></dt>

3458

<dd>return a SELECT COUNT generated against this

3459

<a class="reference internal" href="#sqlalchemy.sql.expression.TableClause" title="sqlalchemy.sql.expression.TableClause"><tt class="xref py py-class docutils literal">TableClause</tt></a>.

3460

</dd></dl>

3461

3462

3463

3464

<tt class="descname">delete</tt><big>(</big>whereclause=None, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.delete" title="Permalink to this definition">¶</a></dt>

3465

<dd>Generate a <a class="reference internal" href="dml.html#sqlalchemy.sql.expression.delete" title="sqlalchemy.sql.expression.delete"><tt class="xref py py-func docutils literal">delete()</tt></a> construct against this

3466

<a class="reference internal" href="#sqlalchemy.sql.expression.TableClause" title="sqlalchemy.sql.expression.TableClause"><tt class="xref py py-class docutils literal">TableClause</tt></a>.

3467

E.g.:

3468

<div class="highlight-python"><div class="highlight"><pre>table.delete().where(table.c.id==7)</pre></div>

3469

</div>

3470

See <a class="reference internal" href="dml.html#sqlalchemy.sql.expression.delete" title="sqlalchemy.sql.expression.delete"><tt class="xref py py-func docutils literal">delete()</tt></a> for argument and usage information.

3471

</dd></dl>

3472

3473

3474

3475

<tt class="descname">foreign_keys</tt><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.foreign_keys" title="Permalink to this definition">¶</a></dt>

3476

3477

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.foreign_keys" title="sqlalchemy.sql.expression.FromClause.foreign_keys"><tt class="xref py py-attr docutils literal">foreign_keys</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3478

Return the collection of ForeignKey objects which this

3479

FromClause references.

3480

</dd></dl>

3481

3482

3483

3484

<tt class="descname">implicit_returning</tt> = False<a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.implicit_returning" title="Permalink to this definition">¶</a></dt>

3485

<dd><a class="reference internal" href="#sqlalchemy.sql.expression.TableClause" title="sqlalchemy.sql.expression.TableClause"><tt class="xref py py-class docutils literal">TableClause</tt></a> doesn’t support having a primary key or column

3486

-level defaults, so implicit returning doesn’t apply.

3487

</dd></dl>

3488

3489

3490

3491

<tt class="descname">insert</tt><big>(</big>values=None, inline=False, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.insert" title="Permalink to this definition">¶</a></dt>

3492

<dd>Generate an <a class="reference internal" href="dml.html#sqlalchemy.sql.expression.insert" title="sqlalchemy.sql.expression.insert"><tt class="xref py py-func docutils literal">insert()</tt></a> construct against this

3493

<a class="reference internal" href="#sqlalchemy.sql.expression.TableClause" title="sqlalchemy.sql.expression.TableClause"><tt class="xref py py-class docutils literal">TableClause</tt></a>.

3494

E.g.:

3495

<div class="highlight-python"><div class="highlight"><pre>table.insert().values(name='foo')</pre></div>

3496

</div>

3497

See <a class="reference internal" href="dml.html#sqlalchemy.sql.expression.insert" title="sqlalchemy.sql.expression.insert"><tt class="xref py py-func docutils literal">insert()</tt></a> for argument and usage information.

3498

</dd></dl>

3499

3500

3501

3502

<tt class="descname">is_derived_from</tt><big>(</big>fromclause<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.is_derived_from" title="Permalink to this definition">¶</a></dt>

3503

3504

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.is_derived_from" title="sqlalchemy.sql.expression.FromClause.is_derived_from"><tt class="xref py py-meth docutils literal">is_derived_from()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3505

Return True if this FromClause is ‘derived’ from the given

3506

FromClause.

3507

An example would be an Alias of a Table is derived from that Table.

3508

</dd></dl>

3509

3510

3511

3512

<tt class="descname">join</tt><big>(</big>right, onclause=None, isouter=False<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.join" title="Permalink to this definition">¶</a></dt>

3513

3514

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.join" title="sqlalchemy.sql.expression.FromClause.join"><tt class="xref py py-meth docutils literal">join()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3515

return a join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

3516

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

3517

</dd></dl>

3518

3519

3520

3521

<tt class="descname">outerjoin</tt><big>(</big>right, onclause=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.outerjoin" title="Permalink to this definition">¶</a></dt>

3522

3523

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.outerjoin" title="sqlalchemy.sql.expression.FromClause.outerjoin"><tt class="xref py py-meth docutils literal">outerjoin()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3524

return an outer join of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a> against another

3525

<a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

3526

</dd></dl>

3527

3528

3529

3530

<tt class="descname">primary_key</tt><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.primary_key" title="Permalink to this definition">¶</a></dt>

3531

3532

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.primary_key" title="sqlalchemy.sql.expression.FromClause.primary_key"><tt class="xref py py-attr docutils literal">primary_key</tt></a> attribute of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3533

Return the collection of Column objects which comprise the

3534

primary key of this FromClause.

3535

</dd></dl>

3536

3537

3538

3539

<tt class="descname">replace_selectable</tt><big>(</big>old, alias<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.replace_selectable" title="Permalink to this definition">¶</a></dt>

3540

3541

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.replace_selectable" title="sqlalchemy.sql.expression.FromClause.replace_selectable"><tt class="xref py py-meth docutils literal">replace_selectable()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3542

replace all occurrences of FromClause ‘old’ with the given Alias

3543

object, returning a copy of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

3544

</dd></dl>

3545

3546

3547

3548

<tt class="descname">select</tt><big>(</big>whereclause=None, **params<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.select" title="Permalink to this definition">¶</a></dt>

3549

3550

inherited from the <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause.select" title="sqlalchemy.sql.expression.FromClause.select"><tt class="xref py py-meth docutils literal">select()</tt></a> method of <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a></div>

3551

return a SELECT of this <a class="reference internal" href="#sqlalchemy.sql.expression.FromClause" title="sqlalchemy.sql.expression.FromClause"><tt class="xref py py-class docutils literal">FromClause</tt></a>.

3552

3553

See also

3554

<a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> - general purpose

3555

method which allows for arbitrary column lists.

3556

</div>

3557

</dd></dl>

3558

3559

3560

3561

<tt class="descname">self_group</tt><big>(</big>against=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.self_group" title="Permalink to this definition">¶</a></dt>

3562

3563

inherited from the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement.self_group" title="sqlalchemy.sql.expression.ClauseElement.self_group"><tt class="xref py py-meth docutils literal">self_group()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

3564

Apply a ‘grouping’ to this <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>.

3565

This method is overridden by subclasses to return a

3566

“grouping” construct, i.e. parenthesis. In particular

3567

it’s used by “binary” expressions to provide a grouping

3568

around themselves when placed into a larger expression,

3569

as well as by <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> constructs when placed into

3570

the FROM clause of another <a class="reference internal" href="#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a>. (Note that

3571

subqueries should be normally created using the

3572

<tt class="xref py py-func docutils literal">Select.alias()</tt> method, as many platforms require

3573

nested SELECT statements to be named).

3574

As expressions are composed together, the application of

3575

<a class="reference internal" href="#sqlalchemy.sql.expression.TableClause.self_group" title="sqlalchemy.sql.expression.TableClause.self_group"><tt class="xref py py-meth docutils literal">self_group()</tt></a> is automatic - end-user code should never

3576

need to use this method directly. Note that SQLAlchemy’s

3577

clause constructs take operator precedence into account -

3578

so parenthesis might not be needed, for example, in

3579

an expression like <tt class="docutils literal">x OR (y AND z)</tt> - AND takes precedence

3580

over OR.

3581

The base <a class="reference internal" href="#sqlalchemy.sql.expression.TableClause.self_group" title="sqlalchemy.sql.expression.TableClause.self_group"><tt class="xref py py-meth docutils literal">self_group()</tt></a> method of <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>

3582

just returns self.

3583

</dd></dl>

3584

3585

3586

3587

<tt class="descname">update</tt><big>(</big>whereclause=None, values=None, inline=False, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.TableClause.update" title="Permalink to this definition">¶</a></dt>

3588

<dd>Generate an <a class="reference internal" href="dml.html#sqlalchemy.sql.expression.update" title="sqlalchemy.sql.expression.update"><tt class="xref py py-func docutils literal">update()</tt></a> construct against this

3589

<a class="reference internal" href="#sqlalchemy.sql.expression.TableClause" title="sqlalchemy.sql.expression.TableClause"><tt class="xref py py-class docutils literal">TableClause</tt></a>.

3590

E.g.:

3591

<div class="highlight-python"><div class="highlight"><pre>table.update().where(table.c.id==7).values(name='foo')</pre></div>

3592

</div>

3593

See <a class="reference internal" href="dml.html#sqlalchemy.sql.expression.update" title="sqlalchemy.sql.expression.update"><tt class="xref py py-func docutils literal">update()</tt></a> for argument and usage information.

3594

</dd></dl>

3595

3596

</dd></dl>

3597

3598

</div>

3599

3600

</div>

3601

3602

</div>

3603

3604

3605

<a href="sqlelement.html" title="previous chapter">Column Elements and Expressions</a>

3607

<a href="dml.html" title="next chapter">Insert, Updates, Deletes</a>

3609

3610

3611

3612

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2b1.

3613

</div>

3614

</div>

3615

3616

</div>

3617

3618

3619

</body>

3620

</html>

3621

3622