~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

Column Elements and Expressions

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="expression_api.html" title="previous chapter">SQL Statements and Expressions API</a>

82

</li>

83

<li>Next:

84

<a href="selectable.html" title="next chapter">Selectables, Tables, FROM objects</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/sqlelement.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

Column Elements and Expressions

101

102

103

<h2>

104

105

Column Elements and Expressions

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="#">Column Elements and Expressions</a></li>

118

</ul>

119

120

121

<h4>Previous Topic</h4>

122

123

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

124

125

<h4>Next Topic</h4>

126

127

<a href="selectable.html" title="next chapter">Selectables, Tables, FROM objects</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>Column Elements and Expressions<a class="headerlink" href="#module-sqlalchemy.sql.expression" title="Permalink to this headline">¶</a></h1>

146

The most fundamental part of the SQL expression API are the “column elements”,

147

which allow for basic SQL expression support. The core of all SQL expression

148

constructs is the <a class="reference internal" href="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>, which is the base for several

149

sub-branches. The <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> class is the fundamental unit

150

used to construct any kind of typed SQL expression.

151

152

153

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

154

<dd>Join a list of clauses together using the <tt class="docutils literal">AND</tt> operator.

155

The <tt class="docutils literal">&</tt> operator is also overloaded on all <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>

156

subclasses to produce the

157

same result.

158

</dd></dl>

159

160

161

162

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

163

<dd>Return an ascending <tt class="docutils literal">ORDER BY</tt> clause element.

164

e.g.:

165

<div class="highlight-python"><div class="highlight"><pre>someselect.order_by(asc(table1.mycol))</pre></div>

166

</div>

167

produces:

168

<div class="highlight-python"><pre>ORDER BY mycol ASC</pre>

169

</div>

170

</dd></dl>

171

172

173

174

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">between</tt><big>(</big>ctest, cleft, cright<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.between" title="Permalink to this definition">¶</a></dt>

175

<dd>Return a <tt class="docutils literal">BETWEEN</tt> predicate clause.

176

Equivalent of SQL <tt class="docutils literal">clausetest BETWEEN clauseleft AND clauseright</tt>.

177

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

178

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

179

similar functionality.

180

</dd></dl>

181

182

183

184

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">bindparam</tt><big>(</big>key, value=<symbol 'NO_ARG>, type_=None, unique=False, required=<symbol 'NO_ARG>, quote=None, callable_=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.bindparam" title="Permalink to this definition">¶</a></dt>

185

<dd>Create a bind parameter clause with the given key.

186

187

188

189

190

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

191

<li>key – the key for this bind param. Will be used in the generated

192

SQL statement for dialects that use named parameters. This

193

value may be modified when part of a compilation operation,

194

if other <a class="reference internal" href="#sqlalchemy.sql.expression.BindParameter" title="sqlalchemy.sql.expression.BindParameter"><tt class="xref py py-class docutils literal">BindParameter</tt></a> objects exist with the same

195

key, or if its length is too long and truncation is

196

required.</li>

197

<li>value – Initial value for this bind param. This value may be

198

overridden by the dictionary of parameters sent to statement

199

compilation/execution.

200

Defaults to <tt class="docutils literal">None</tt>, however if neither <tt class="docutils literal">value</tt> nor

201

<tt class="docutils literal">callable</tt> are passed explicitly, the <tt class="docutils literal">required</tt> flag will be

202

set to <tt class="docutils literal">True</tt> which has the effect of requiring a value be present

203

when the statement is actually executed.

204

205

Changed in version 0.8: The <tt class="docutils literal">required</tt> flag is set to <tt class="docutils literal">True</tt>

206

automatically if <tt class="docutils literal">value</tt> or <tt class="docutils literal">callable</tt> is not passed.

207

</div>

208

</li>

209

<li>callable_ – A callable function that takes the place of “value”. The function

210

will be called at statement execution time to determine the

211

ultimate value. Used for scenarios where the actual bind

212

value cannot be determined at the point at which the clause

213

construct is created, but embedded bind values are still desirable.</li>

214

<li>type_ – A <tt class="docutils literal">TypeEngine</tt> object that will be used to pre-process the

215

value corresponding to this <a class="reference internal" href="#sqlalchemy.sql.expression.BindParameter" title="sqlalchemy.sql.expression.BindParameter"><tt class="xref py py-class docutils literal">BindParameter</tt></a> at

216

execution time.</li>

217

<li>unique – if True, the key name of this BindParamClause will be

218

modified if another <a class="reference internal" href="#sqlalchemy.sql.expression.BindParameter" title="sqlalchemy.sql.expression.BindParameter"><tt class="xref py py-class docutils literal">BindParameter</tt></a> of the same name

219

already has been located within the containing

220

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

221

<li>required – If <tt class="docutils literal">True</tt>, a value is required at execution time. If not passed,

222

is set to <tt class="docutils literal">True</tt> or <tt class="docutils literal">False</tt> based on whether or not

223

one of <tt class="docutils literal">value</tt> or <tt class="docutils literal">callable</tt> were passed..

224

225

Changed in version 0.8: If the <tt class="docutils literal">required</tt> flag is not specified,

226

it will be set automatically to <tt class="docutils literal">True</tt> or <tt class="docutils literal">False</tt> depending

227

on whether or not the <tt class="docutils literal">value</tt> or <tt class="docutils literal">callable</tt> parameters

228

were specified.

229

</div>

230

</li>

231

<li>quote – True if this parameter name requires quoting and is not

232

currently known as a SQLAlchemy reserved word; this currently

233

only applies to the Oracle backend.</li>

234

</ul>

235

</td>

236

</tr>

237

</tbody>

238

</table>

239

</dd></dl>

240

241

242

243

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

244

<dd>Produce a <tt class="docutils literal">CASE</tt> statement.

245

246

<dt>whens</dt>

247

<dd>A sequence of pairs, or alternatively a dict,

248

to be translated into “WHEN / THEN” clauses.</dd>

249

<dt>value</dt>

250

<dd>Optional for simple case statements, produces

251

a column expression as in “CASE <expr> WHEN ...”</dd>

252

253

<dd>Optional as well, for case defaults produces

254

the “ELSE” portion of the “CASE” statement.</dd>

255

</dl>

256

The expressions used for THEN and ELSE,

257

when specified as strings, will be interpreted

258

as bound values. To specify textual SQL expressions

259

for these, use the <a class="reference internal" href="#sqlalchemy.sql.expression.literal_column" title="sqlalchemy.sql.expression.literal_column"><tt class="xref py py-func docutils literal">literal_column()</tt></a>

260

construct.

261

The expressions used for the WHEN criterion

262

may only be literal strings when “value” is

263

present, i.e. CASE table.somecol WHEN “x” THEN “y”.

264

Otherwise, literal strings are not accepted

265

in this position, and either the text(<string>)

266

or literal(<string>) constructs must be used to

267

interpret raw string values.

268

Usage examples:

269

<div class="highlight-python"><div class="highlight"><pre>case([(orderline.c.qty > 100, item.c.specialprice),

270

(orderline.c.qty > 10, item.c.bulkprice)

271

], else_=item.c.regularprice)

272

case(value=emp.c.type, whens={

273

'engineer': emp.c.salary * 1.1,

274

'manager': emp.c.salary * 3,

275

})</pre></div>

276

</div>

277

Using <a class="reference internal" href="#sqlalchemy.sql.expression.literal_column" title="sqlalchemy.sql.expression.literal_column"><tt class="xref py py-func docutils literal">literal_column()</tt></a>, to allow for databases that

278

do not support bind parameters in the <tt class="docutils literal">then</tt> clause. The type

279

can be specified which determines the type of the <a class="reference internal" href="#sqlalchemy.sql.expression.case" title="sqlalchemy.sql.expression.case"><tt class="xref py py-func docutils literal">case()</tt></a> construct

280

overall:

281

<div class="highlight-python"><div class="highlight"><pre>case([(orderline.c.qty > 100,

282

literal_column("'greaterthan100'", String)),

283

(orderline.c.qty > 10, literal_column("'greaterthan10'",

284

String))

285

], else_=literal_column("'lethan10'", String))</pre></div>

286

</div>

287

</dd></dl>

288

289

290

291

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

292

<dd>Return a <tt class="docutils literal">CAST</tt> function.

293

Equivalent of SQL <tt class="docutils literal">CAST(clause AS totype)</tt>.

294

Use with a <a class="reference internal" href="types.html#sqlalchemy.types.TypeEngine" title="sqlalchemy.types.TypeEngine"><tt class="xref py py-class docutils literal">TypeEngine</tt></a> subclass, i.e:

295

<div class="highlight-python"><div class="highlight"><pre>cast(table.c.unit_price * table.c.qty, Numeric(10,4))</pre></div>

296

</div>

297

or:

298

<div class="highlight-python"><div class="highlight"><pre>cast(table.c.timestamp, DATE)</pre></div>

299

</div>

300

</dd></dl>

301

302

303

304

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

305

<dd>Return a textual column clause, as would be in the columns clause of a

306

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

307

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

308

represents the “syntactical” portion of the schema-level

309

<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> object. It is often used directly

310

within <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> constructs or with lightweight

311

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

312

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

313

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

314

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

315

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

316

</div>

317

318

319

320

321

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

322

<li>text – the name of the column. Quoting rules will be applied

323

to the clause like any other column name. For textual column constructs

324

that are not to be quoted, use the <a class="reference internal" href="#sqlalchemy.sql.expression.literal_column" title="sqlalchemy.sql.expression.literal_column"><tt class="xref py py-func docutils literal">literal_column()</tt></a> function.</li>

325

<li>type_ – an optional <a class="reference internal" href="types.html#sqlalchemy.types.TypeEngine" title="sqlalchemy.types.TypeEngine"><tt class="xref py py-class docutils literal">TypeEngine</tt></a> object

326

which will provide result-set translation for this column.</li>

327

</ul>

328

</td>

329

</tr>

330

</tbody>

331

</table>

332

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

333

</dd></dl>

334

335

336

337

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

338

<dd>Return the clause <tt class="docutils literal">expression COLLATE collation</tt>.

339

e.g.:

340

<div class="highlight-python"><div class="highlight"><pre>collate(mycolumn, 'utf8_bin')</pre></div>

341

</div>

342

produces:

343

<div class="highlight-python"><pre>mycolumn COLLATE utf8_bin</pre>

344

</div>

345

</dd></dl>

346

347

348

349

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

350

<dd>Return a descending <tt class="docutils literal">ORDER BY</tt> clause element.

351

e.g.:

352

<div class="highlight-python"><div class="highlight"><pre>someselect.order_by(desc(table1.mycol))</pre></div>

353

</div>

354

produces:

355

<div class="highlight-python"><pre>ORDER BY mycol DESC</pre>

356

</div>

357

</dd></dl>

358

359

360

361

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

362

<dd>Return a <tt class="docutils literal">DISTINCT</tt> clause.

363

e.g.:

364

<div class="highlight-python"><div class="highlight"><pre>distinct(a)</pre></div>

365

</div>

366

renders:

367

<div class="highlight-python"><pre>DISTINCT a</pre>

368

</div>

369

</dd></dl>

370

371

372

373

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

374

<dd>Return the clause <tt class="docutils literal">extract(field FROM expr)</tt>.

375

</dd></dl>

376

377

378

379

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

380

<dd>Return a <tt class="xref py py-class docutils literal">False_</tt> object, which compiles to <tt class="docutils literal">false</tt>, or the

381

boolean equivalent for the target dialect.

382

</dd></dl>

383

384

385

386

<tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">func</tt> = <sqlalchemy.sql.expression._FunctionGenerator object at 0x10216cf90><a class="headerlink" href="#sqlalchemy.sql.expression.func" title="Permalink to this definition">¶</a></dt>

387

<dd>Generate SQL function expressions.

388

<a class="reference internal" href="#sqlalchemy.sql.expression.func" title="sqlalchemy.sql.expression.func"><tt class="xref py py-data docutils literal">func</tt></a> is a special object instance which generates SQL

389

functions based on name-based attributes, e.g.:

390

<div class="highlight-python"><div class="highlight"><pre>>>> print func.count(1)

391

count(:param_1)</pre></div>

392

</div>

393

The element is a column-oriented SQL element like any other, and is

394

used in that way:

395

<div class="highlight-python"><div class="highlight"><pre>>>> print select([func.count(table.c.id)])

396

SELECT count(sometable.id) FROM sometable</pre></div>

397

</div>

398

Any name can be given to <a class="reference internal" href="#sqlalchemy.sql.expression.func" title="sqlalchemy.sql.expression.func"><tt class="xref py py-data docutils literal">func</tt></a>. If the function name is unknown to

399

SQLAlchemy, it will be rendered exactly as is. For common SQL functions

400

which SQLAlchemy is aware of, the name may be interpreted as a generic

401

function which will be compiled appropriately to the target database:

402

<div class="highlight-python"><div class="highlight"><pre>>>> print func.current_timestamp()

403

CURRENT_TIMESTAMP</pre></div>

404

</div>

405

To call functions which are present in dot-separated packages,

406

specify them in the same manner:

407

<div class="highlight-python"><div class="highlight"><pre>>>> print func.stats.yield_curve(5, 10)

408

stats.yield_curve(:yield_curve_1, :yield_curve_2)</pre></div>

409

</div>

410

SQLAlchemy can be made aware of the return type of functions to enable

411

type-specific lexical and result-based behavior. For example, to ensure

412

that a string-based function returns a Unicode value and is similarly

413

treated as a string in expressions, specify

414

<a class="reference internal" href="types.html#sqlalchemy.types.Unicode" title="sqlalchemy.types.Unicode"><tt class="xref py py-class docutils literal">Unicode</tt></a> as the type:

415

<div class="highlight-python"><div class="highlight"><pre>>>> print func.my_string(u'hi', type_=Unicode) + ' ' + \

416

... func.my_string(u'there', type_=Unicode)

417

my_string(:my_string_1) || :my_string_2 || my_string(:my_string_3)</pre></div>

418

</div>

419

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

420

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

421

This object meets the “column” interface, including comparison and labeling

422

functions. The object can also be passed the <a class="reference internal" href="connections.html#sqlalchemy.engine.Connectable.execute" title="sqlalchemy.engine.Connectable.execute"><tt class="xref py py-meth docutils literal">execute()</tt></a>

423

method of a <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> or <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>, where it will be

424

wrapped inside of a SELECT statement first:

425

<div class="highlight-python"><div class="highlight"><pre>print connection.execute(func.current_timestamp()).scalar()</pre></div>

426

</div>

427

In a few exception cases, the <a class="reference internal" href="#sqlalchemy.sql.expression.func" title="sqlalchemy.sql.expression.func"><tt class="xref py py-data docutils literal">func</tt></a> accessor

428

will redirect a name to a built-in expression such as <a class="reference internal" href="#sqlalchemy.sql.expression.cast" title="sqlalchemy.sql.expression.cast"><tt class="xref py py-func docutils literal">cast()</tt></a>

429

or <a class="reference internal" href="#sqlalchemy.sql.expression.extract" title="sqlalchemy.sql.expression.extract"><tt class="xref py py-func docutils literal">extract()</tt></a>, as these names have well-known meaning

430

but are not exactly the same as “functions” from a SQLAlchemy

431

perspective.

432

433

New in version 0.8: <a class="reference internal" href="#sqlalchemy.sql.expression.func" title="sqlalchemy.sql.expression.func"><tt class="xref py py-data docutils literal">func</tt></a> can return non-function expression

434

constructs for common quasi-functional names like <a class="reference internal" href="#sqlalchemy.sql.expression.cast" title="sqlalchemy.sql.expression.cast"><tt class="xref py py-func docutils literal">cast()</tt></a>

435

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

436

</div>

437

Functions which are interpreted as “generic” functions know how to

438

calculate their return type automatically. For a listing of known generic

439

functions, see <a class="reference internal" href="functions.html#generic-functions">SQL and Generic Functions</a>.

440

</dd></dl>

441

442

443

444

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

445

<dd>Return a <tt class="xref py py-class docutils literal">Label</tt> object for the

446

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

447

A label changes the name of an element in the columns clause of a

448

<tt class="docutils literal">SELECT</tt> statement, typically via the <tt class="docutils literal">AS</tt> SQL keyword.

449

This functionality is more conveniently available via the

450

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

451

452

453

<dd>label name</dd>

454

455

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

456

</dl>

457

</dd></dl>

458

459

460

461

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

462

<dd>Return a literal clause, bound to a bind parameter.

463

Literal clauses are created automatically when non- <a class="reference internal" href="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>

464

objects (such as strings, ints, dates, etc.) are used in a comparison

465

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

466

subclass, such as a <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> object.

467

Use this function to force the

468

generation of a literal clause, which will be created as a

469

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

470

471

472

473

474

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

475

<li>value – the value to be bound. Can be any Python object supported by

476

the underlying DB-API, or is translatable via the given type argument.</li>

477

<li>type_ – an optional <a class="reference internal" href="types.html#sqlalchemy.types.TypeEngine" title="sqlalchemy.types.TypeEngine"><tt class="xref py py-class docutils literal">TypeEngine</tt></a> which

478

will provide bind-parameter translation for this literal.</li>

479

</ul>

480

</td>

481

</tr>

482

</tbody>

483

</table>

484

</dd></dl>

485

486

487

488

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

489

<dd>Return a textual column expression, as would be in the columns

490

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

491

The object returned supports further expressions in the same way as any

492

other column object, including comparison, math and string operations.

493

The type_ parameter is important to determine proper expression behavior

494

(such as, ‘+’ means string concatenation or numerical addition based on

495

the type).

496

497

498

499

500

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

501

<li>text – the text of the expression; can be any SQL expression.

502

Quoting rules will not be applied. To specify a column-name expression

503

which should be subject to quoting rules, use the <a class="reference internal" href="#sqlalchemy.sql.expression.column" title="sqlalchemy.sql.expression.column"><tt class="xref py py-func docutils literal">column()</tt></a>

504

function.</li>

505

<li>type_ – an optional <a class="reference internal" href="types.html#sqlalchemy.types.TypeEngine" title="sqlalchemy.types.TypeEngine"><tt class="xref py py-class docutils literal">TypeEngine</tt></a>

506

object which will

507

provide result-set translation and additional expression semantics for

508

this column. If left as None the type will be NullType.</li>

509

</ul>

510

</td>

511

</tr>

512

</tbody>

513

</table>

514

</dd></dl>

515

516

517

518

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

519

<dd>Return a negation of the given clause, i.e. <tt class="docutils literal">NOT(clause)</tt>.

520

The <tt class="docutils literal">~</tt> operator is also overloaded on all

521

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

522

same result.

523

</dd></dl>

524

525

526

527

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

528

<dd>Return a <tt class="xref py py-class docutils literal">Null</tt> object, which compiles to <tt class="docutils literal">NULL</tt>.

529

</dd></dl>

530

531

532

533

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

534

<dd>Return a NULLS FIRST <tt class="docutils literal">ORDER BY</tt> clause element.

535

e.g.:

536

<div class="highlight-python"><div class="highlight"><pre>someselect.order_by(desc(table1.mycol).nullsfirst())</pre></div>

537

</div>

538

produces:

539

<div class="highlight-python"><pre>ORDER BY mycol DESC NULLS FIRST</pre>

540

</div>

541

</dd></dl>

542

543

544

545

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

546

<dd>Return a NULLS LAST <tt class="docutils literal">ORDER BY</tt> clause element.

547

e.g.:

548

<div class="highlight-python"><div class="highlight"><pre>someselect.order_by(desc(table1.mycol).nullslast())</pre></div>

549

</div>

550

produces:

551

<div class="highlight-python"><pre>ORDER BY mycol DESC NULLS LAST</pre>

552

</div>

553

</dd></dl>

554

555

556

557

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

558

<dd>Join a list of clauses together using the <tt class="docutils literal">OR</tt> operator.

559

The <tt class="docutils literal">|</tt> operator is also overloaded on all

560

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

561

same result.

562

</dd></dl>

563

564

565

566

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

567

<dd>Create an ‘OUT’ parameter for usage in functions (stored procedures),

568

for databases which support them.

569

The <tt class="docutils literal">outparam</tt> can be used like a regular function parameter.

570

The “output” value will be available from the

571

<a class="reference internal" href="connections.html#sqlalchemy.engine.ResultProxy" title="sqlalchemy.engine.ResultProxy"><tt class="xref py py-class docutils literal">ResultProxy</tt></a> object via its <tt class="docutils literal">out_parameters</tt>

572

attribute, which returns a dictionary containing the values.

573

</dd></dl>

574

575

576

577

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

578

<dd>Produce an OVER clause against a function.

579

Used against aggregate or so-called “window” functions,

580

for database backends that support window functions.

581

E.g.:

582

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

583

over(func.row_number(), order_by='x')</pre></div>

584

</div>

585

Would produce “ROW_NUMBER() OVER(ORDER BY x)”.

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>func – a <tt class="xref py py-class docutils literal">FunctionElement</tt> construct, typically

592

generated by <a class="reference internal" href="#sqlalchemy.sql.expression.func" title="sqlalchemy.sql.expression.func"><tt class="xref py py-data docutils literal">func</tt></a>.</li>

593

<li>partition_by – a column element or string, or a list

594

of such, that will be used as the PARTITION BY clause

595

of the OVER construct.</li>

596

<li>order_by – a column element or string, or a list

597

of such, that will be used as the ORDER BY clause

598

of the OVER construct.</li>

599

</ul>

600

</td>

601

</tr>

602

</tbody>

603

</table>

604

This function is also available from the <a class="reference internal" href="#sqlalchemy.sql.expression.func" title="sqlalchemy.sql.expression.func"><tt class="xref py py-data docutils literal">func</tt></a>

605

construct itself via the <tt class="xref py py-meth docutils literal">FunctionElement.over()</tt> method.

606

607

New in version 0.7.

608

</div>

609

</dd></dl>

610

611

612

613

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

614

<dd>Create a SQL construct that is represented by a literal string.

615

E.g.:

616

<div class="highlight-python"><div class="highlight"><pre>t = text("SELECT * FROM users")

617

result = connection.execute(t)</pre></div>

618

</div>

619

The advantages <a class="reference internal" href="#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a> provides over a plain string are

620

backend-neutral support for bind parameters, per-statement

621

execution options, as well as

622

bind parameter and result-column typing behavior, allowing

623

SQLAlchemy type constructs to play a role when executing

624

a statement that is specified literally.

625

Bind parameters are specified by name, using the format <tt class="docutils literal">:name</tt>.

626

E.g.:

627

<div class="highlight-python"><div class="highlight"><pre>t = text("SELECT * FROM users WHERE id=:user_id")

628

result = connection.execute(t, user_id=12)</pre></div>

629

</div>

630

To invoke SQLAlchemy typing logic for bind parameters, the

631

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

632

constructs which specify the type for a given name:

633

<div class="highlight-python"><div class="highlight"><pre>t = text("SELECT id FROM users WHERE updated_at>:updated",

634

bindparams=[bindparam('updated', DateTime())]

635

)</pre></div>

636

</div>

637

Typing during result row processing is also an important concern.

638

Result column types

639

are specified using the <tt class="docutils literal">typemap</tt> dictionary, where the keys

640

match the names of columns. These names are taken from what

641

the DBAPI returns as <tt class="docutils literal">cursor.description</tt>:

642

<div class="highlight-python"><div class="highlight"><pre>t = text("SELECT id, name FROM users",

643

typemap={

644

'id':Integer,

645

'name':Unicode

646

}

647

)</pre></div>

648

</div>

649

The <a class="reference internal" href="#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a> construct is used internally for most cases when

650

a literal string is specified for part of a larger query, such as

651

within <a class="reference internal" href="selectable.html#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.update" title="sqlalchemy.sql.expression.update"><tt class="xref py py-func docutils literal">update()</tt></a>,

652

<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> or <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>. In those cases, the same

653

bind parameter syntax is applied:

654

<div class="highlight-python"><div class="highlight"><pre>s = select([users.c.id, users.c.name]).where("id=:user_id")

655

result = connection.execute(s, user_id=12)</pre></div>

656

</div>

657

Using <a class="reference internal" href="#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a> explicitly usually implies the construction

658

of a full, standalone statement. As such, SQLAlchemy refers

659

to it as an <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a> object, and it supports

660

the <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Executable.execution_options" title="sqlalchemy.sql.expression.Executable.execution_options"><tt class="xref py py-meth docutils literal">Executable.execution_options()</tt></a> method. For example,

661

a <a class="reference internal" href="#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a> construct that should be subject to “autocommit”

662

can be set explicitly so using the <tt class="docutils literal">autocommit</tt> option:

663

<div class="highlight-python"><div class="highlight"><pre>t = text("EXEC my_procedural_thing()").\

664

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

665

</div>

666

Note that SQLAlchemy’s usual “autocommit” behavior applies to

667

<a class="reference internal" href="#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a> constructs - that is, statements which begin

668

with a phrase such as <tt class="docutils literal">INSERT</tt>, <tt class="docutils literal">UPDATE</tt>, <tt class="docutils literal">DELETE</tt>,

669

or a variety of other phrases specific to certain backends, will

670

be eligible for autocommit if no transaction is in progress.

671

672

673

674

675

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

676

<li>text – the text of the SQL statement to be created. use <tt class="docutils literal">:<param></tt>

677

to specify bind parameters; they will be compiled to their

678

engine-specific format.</li>

679

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

680

to set the autocommit option.</li>

681

<li>bind – an optional connection or engine to be used for this text query.</li>

682

<li>bindparams – a list of <a class="reference internal" href="#sqlalchemy.sql.expression.bindparam" title="sqlalchemy.sql.expression.bindparam"><tt class="xref py py-func docutils literal">bindparam()</tt></a> instances which can be used to define

683

the types and/or initial values for the bind parameters within

684

the textual statement; the keynames of the bindparams must match

685

those within the text of the statement. The types will be used

686

for pre-processing on bind values.</li>

687

<li>typemap – a dictionary mapping the names of columns represented in the

688

columns clause of a <tt class="docutils literal">SELECT</tt> statement to type objects,

689

which will be used to perform post-processing on columns within

690

the result set. This argument applies to any expression

691

that returns result sets.</li>

692

</ul>

693

</td>

694

</tr>

695

</tbody>

696

</table>

697

</dd></dl>

698

699

700

701

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

702

<dd>Return a <tt class="xref py py-class docutils literal">True_</tt> object, which compiles to <tt class="docutils literal">true</tt>, or the

703

boolean equivalent for the target dialect.

704

</dd></dl>

705

706

707

708

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

709

<dd>Return a SQL tuple.

710

Main usage is to produce a composite IN construct:

711

<div class="highlight-python"><div class="highlight"><pre>tuple_(table.c.col1, table.c.col2).in_(

712

[(1, 2), (5, 12), (10, 19)]

713

)</pre></div>

714

</div>

715

716

Warning

717

The composite IN construct is not supported by all backends,

718

and is currently known to work on Postgresql and MySQL,

719

but not SQLite. Unsupported backends will raise

720

a subclass of <a class="reference internal" href="exceptions.html#sqlalchemy.exc.DBAPIError" title="sqlalchemy.exc.DBAPIError"><tt class="xref py py-class docutils literal">DBAPIError</tt></a> when such

721

an expression is invoked.

722

</div>

723

</dd></dl>

724

725

726

727

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

728

<dd>Coerce the given expression into the given type,

729

on the Python side only.

730

<a class="reference internal" href="#sqlalchemy.sql.expression.type_coerce" title="sqlalchemy.sql.expression.type_coerce"><tt class="xref py py-func docutils literal">type_coerce()</tt></a> is roughly similar to <a class="reference internal" href="#sqlalchemy.sql.expression.cast" title="sqlalchemy.sql.expression.cast"><tt class="xref py py-func docutils literal">cast()</tt></a>, except no

731

“CAST” expression is rendered - the given type is only applied towards

732

expression typing and against received result values.

733

e.g.:

734

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy.types import TypeDecorator

735

import uuid

736

737

class AsGuid(TypeDecorator):

738

impl = String

739

740

def process_bind_param(self, value, dialect):

741

if value is not None:

742

return str(value)

743

else:

744

return None

745

746

def process_result_value(self, value, dialect):

747

if value is not None:

748

return uuid.UUID(value)

749

else:

750

return None

751

752

conn.execute(

753

select([type_coerce(mytable.c.ident, AsGuid)]).\

754

where(

755

type_coerce(mytable.c.ident, AsGuid) ==

756

uuid.uuid3(uuid.NAMESPACE_URL, 'bar')

757

)

758

)</pre></div>

759

</div>

760

</dd></dl>

761

762

763

764

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

765

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

766

Represent an expression that is <tt class="docutils literal">LEFT <operator> RIGHT</tt>.

767

A <a class="reference internal" href="#sqlalchemy.sql.expression.BinaryExpression" title="sqlalchemy.sql.expression.BinaryExpression"><tt class="xref py py-class docutils literal">BinaryExpression</tt></a> is generated automatically

768

whenever two column expressions are used in a Python binary expresion:

769

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

770

>>> column('a') + column('b')

771

<sqlalchemy.sql.expression.BinaryExpression object at 0x101029dd0>

772

>>> print column('a') + column('b')

773

a + b</pre></div>

774

</div>

775

776

777

778

779

<tr class="field-odd field"><th class="field-name" colspan="2">Inherited-members :</th></tr>

780

781

</tr>

782

</tbody>

783

</table>

784

785

786

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

787

<dd>Compare this <a class="reference internal" href="#sqlalchemy.sql.expression.BinaryExpression" title="sqlalchemy.sql.expression.BinaryExpression"><tt class="xref py py-class docutils literal">BinaryExpression</tt></a> against the

788

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

789

</dd></dl>

790

791

</dd></dl>

792

793

794

795

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">BindParameter</tt><big>(</big>key, value, type_=None, unique=False, callable_=None, isoutparam=False, required=False, quote=None, _compared_to_operator=None, _compared_to_type=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.BindParameter" title="Permalink to this definition">¶</a></dt>

796

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

797

Represent a bind parameter.

798

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

799

800

801

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

802

803

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

804

Implement the <tt class="docutils literal">==</tt> operator.

805

In a column context, produces the clause <tt class="docutils literal">a = b</tt>.

806

If the target is <tt class="docutils literal">None</tt>, produces <tt class="docutils literal">a IS NULL</tt>.

807

</dd></dl>

808

809

810

811

<tt class="descname">__init__</tt><big>(</big>key, value, type_=None, unique=False, callable_=None, isoutparam=False, required=False, quote=None, _compared_to_operator=None, _compared_to_type=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.BindParameter.__init__" title="Permalink to this definition">¶</a></dt>

812

<dd>Construct a BindParameter.

813

814

815

816

817

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

818

<li>key – the key for this bind param. Will be used in the generated

819

SQL statement for dialects that use named parameters. This

820

value may be modified when part of a compilation operation,

821

if other <a class="reference internal" href="#sqlalchemy.sql.expression.BindParameter" title="sqlalchemy.sql.expression.BindParameter"><tt class="xref py py-class docutils literal">BindParameter</tt></a> objects exist with the same

822

key, or if its length is too long and truncation is

823

required.</li>

824

<li>value – Initial value for this bind param. This value may be

825

overridden by the dictionary of parameters sent to statement

826

compilation/execution.</li>

827

<li>callable_ – A callable function that takes the place of “value”. The function

828

will be called at statement execution time to determine the

829

ultimate value. Used for scenarios where the actual bind

830

value cannot be determined at the point at which the clause

831

construct is created, but embedded bind values are still desirable.</li>

832

<li>type_ – A <tt class="docutils literal">TypeEngine</tt> object that will be used to pre-process the

833

value corresponding to this <a class="reference internal" href="#sqlalchemy.sql.expression.BindParameter" title="sqlalchemy.sql.expression.BindParameter"><tt class="xref py py-class docutils literal">BindParameter</tt></a> at

834

execution time.</li>

835

<li>unique – if True, the key name of this BindParamClause will be

836

modified if another <a class="reference internal" href="#sqlalchemy.sql.expression.BindParameter" title="sqlalchemy.sql.expression.BindParameter"><tt class="xref py py-class docutils literal">BindParameter</tt></a> of the same name

837

already has been located within the containing

838

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

839

<li>quote – True if this parameter name requires quoting and is not

840

currently known as a SQLAlchemy reserved word; this currently

841

only applies to the Oracle backend.</li>

842

<li>required – a value is required at execution time.</li>

843

<li>isoutparam – if True, the parameter should be treated like a stored procedure

844

“OUT” parameter.</li>

845

</ul>

846

</td>

847

</tr>

848

</tbody>

849

</table>

850

</dd></dl>

851

852

853

854

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

855

856

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

857

Implement the <tt class="docutils literal"><=</tt> operator.

858

In a column context, produces the clause <tt class="docutils literal">a <= b</tt>.

859

</dd></dl>

860

861

862

863

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

864

865

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

866

Implement the <tt class="docutils literal"><</tt> operator.

867

In a column context, produces the clause <tt class="docutils literal">a < b</tt>.

868

</dd></dl>

869

870

871

872

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

873

874

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

875

Implement the <tt class="docutils literal">!=</tt> operator.

876

In a column context, produces the clause <tt class="docutils literal">a != b</tt>.

877

If the target is <tt class="docutils literal">None</tt>, produces <tt class="docutils literal">a IS NOT NULL</tt>.

878

</dd></dl>

879

880

881

882

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

883

884

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

885

provides a constant ‘anonymous label’ for this ColumnElement.

886

This is a label() expression which will be named at compile time.

887

The same label() is returned each time anon_label is called so

888

that expressions can reference anon_label multiple times, producing

889

the same label name at compile time.

890

the compiler uses this function automatically at compile time

891

for expressions that are known to be ‘unnamed’ like binary

892

expressions and function calls.

893

</dd></dl>

894

895

896

897

898

899

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

900

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

901

parent object.

902

</dd></dl>

903

904

905

906

<tt class="descname">between</tt><big>(</big>cleft, cright<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.BindParameter.between" title="Permalink to this definition">¶</a></dt>

907

908

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

909

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

910

the parent object, given the lower and upper range.

911

</dd></dl>

912

913

914

915

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

916

917

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

918

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

919

the parent object, given the collation string.

920

</dd></dl>

921

922

923

924

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

925

<dd>Compare this <a class="reference internal" href="#sqlalchemy.sql.expression.BindParameter" title="sqlalchemy.sql.expression.BindParameter"><tt class="xref py py-class docutils literal">BindParameter</tt></a> to the given

926

clause.

927

</dd></dl>

928

929

930

931

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

932

933

inherited from the <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

934

Compile this SQL expression.

935

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.

936

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

937

string representation of the result. The

938

<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

939

dictionary of bind parameter names and values

940

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

941

942

943

944

945

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

946

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

947

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

948

this <a class="reference internal" href="#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>

949

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

950

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

951

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

952

object are rendered.</li>

953

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

954

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

955

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

956

any.</li>

957

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

958

not support inline retrieval of newly generated primary key

959

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

960

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

961

VALUES clause. This typically refers to Sequence execution but may

962

also refer to any server-side default generation function

963

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

964

</ul>

965

</td>

966

</tr>

967

</tbody>

968

</table>

969

</dd></dl>

970

971

972

973

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

974

975

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

976

Implement the ‘concat’ operator.

977

In a column context, produces the clause <tt class="docutils literal">a || b</tt>,

978

or uses the <tt class="docutils literal">concat()</tt> operator on MySQL.

979

</dd></dl>

980

981

982

983

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

984

985

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

986

Implement the ‘contains’ operator.

987

In a column context, produces the clause <tt class="docutils literal">LIKE '%<other>%'</tt>

988

</dd></dl>

989

990

991

992

993

994

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

995

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

996

parent object.

997

</dd></dl>

998

999

1000

1001

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

1002

1003

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

1004

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

1005

parent object.

1006

</dd></dl>

1007

1008

1009

1010

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

1011

<dd>Return the value of this bound parameter,

1012

taking into account if the <tt class="docutils literal">callable</tt> parameter

1013

was set.

1014

The <tt class="docutils literal">callable</tt> value will be evaluated

1015

and returned if present, else <tt class="docutils literal">value</tt>.

1016

</dd></dl>

1017

1018

1019

1020

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

1021

1022

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

1023

Implement the ‘endswith’ operator.

1024

In a column context, produces the clause <tt class="docutils literal">LIKE '%<other>'</tt>

1025

</dd></dl>

1026

1027

1028

1029

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

1030

1031

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

1032

Return a column expression.

1033

Part of the inspection interface; returns self.

1034

</dd></dl>

1035

1036

1037

1038

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

1039

1040

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

1041

Return immediate child elements of this <a class="reference internal" href="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>.

1042

This is used for visit traversal.

1043

**kwargs may contain flags that change the collection that is

1044

returned, for example to return a subset of items in order to

1045

cut down on larger traversals, or to return child items from a

1046

different context (such as schema-level collections instead of

1047

clause-level).

1048

</dd></dl>

1049

1050

1051

1052

<tt class="descname">ilike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.BindParameter.ilike" title="Permalink to this definition">¶</a></dt>

1053

1054

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

1055

Implement the <tt class="docutils literal">ilike</tt> operator.

1056

In a column context, produces the clause <tt class="docutils literal">a ILIKE other</tt>.

1057

E.g.:

1058

<div class="highlight-python"><div class="highlight"><pre>select([sometable]).where(sometable.c.column.ilike("%foobar%"))</pre></div>

1059

</div>

1060

1061

1062

1063

1064

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

1065

<li>other – expression to be compared</li>

1066

<li>escape – optional escape character, renders the <tt class="docutils literal">ESCAPE</tt>

1067

keyword, e.g.:

1068

<div class="highlight-python"><div class="highlight"><pre>somecolumn.ilike("foo/%bar", escape="/")</pre></div>

1069

</div>

1070

</li>

1071

</ul>

1072

</td>

1073

</tr>

1074

</tbody>

1075

</table>

1076

1077

See also

1078

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

1079

</div>

1080

</dd></dl>

1081

1082

1083

1084

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

1085

1086

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

1087

Implement the <tt class="docutils literal">in</tt> operator.

1088

In a column context, produces the clause <tt class="docutils literal">a IN other</tt>.

1089

“other” may be a tuple/list of column expressions,

1090

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

1091

</dd></dl>

1092

1093

1094

1095

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

1096

1097

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

1098

Implement the <tt class="docutils literal">IS</tt> operator.

1099

Normally, <tt class="docutils literal">IS</tt> is generated automatically when comparing to a

1100

value of <tt class="docutils literal">None</tt>, which resolves to <tt class="docutils literal">NULL</tt>. However, explicit

1101

usage of <tt class="docutils literal">IS</tt> may be desirable if comparing to boolean values

1102

on certain platforms.

1103

1104

New in version 0.7.9.

1105

</div>

1106

1107

See also

1108

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

1109

</div>

1110

</dd></dl>

1111

1112

1113

1114

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

1115

1116

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

1117

Implement the <tt class="docutils literal">IS NOT</tt> operator.

1118

Normally, <tt class="docutils literal">IS NOT</tt> is generated automatically when comparing to a

1119

value of <tt class="docutils literal">None</tt>, which resolves to <tt class="docutils literal">NULL</tt>. However, explicit

1120

usage of <tt class="docutils literal">IS NOT</tt> may be desirable if comparing to boolean values

1121

on certain platforms.

1122

1123

New in version 0.7.9.

1124

</div>

1125

1126

See also

1127

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

1128

</div>

1129

</dd></dl>

1130

1131

1132

1133

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

1134

1135

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

1136

Produce a column label, i.e. <tt class="docutils literal"><columnname> AS <name></tt>.

1137

This is a shortcut to the <a class="reference internal" href="#sqlalchemy.sql.expression.label" title="sqlalchemy.sql.expression.label"><tt class="xref py py-func docutils literal">label()</tt></a> function.

1138

if ‘name’ is None, an anonymous label name will be generated.

1139

</dd></dl>

1140

1141

1142

1143

<tt class="descname">like</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.BindParameter.like" title="Permalink to this definition">¶</a></dt>

1144

1145

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

1146

Implement the <tt class="docutils literal">like</tt> operator.

1147

In a column context, produces the clause <tt class="docutils literal">a LIKE other</tt>.

1148

E.g.:

1149

<div class="highlight-python"><div class="highlight"><pre>select([sometable]).where(sometable.c.column.like("%foobar%"))</pre></div>

1150

</div>

1151

1152

1153

1154

1155

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

1156

<li>other – expression to be compared</li>

1157

<li>escape – optional escape character, renders the <tt class="docutils literal">ESCAPE</tt>

1158

keyword, e.g.:

1159

<div class="highlight-python"><div class="highlight"><pre>somecolumn.like("foo/%bar", escape="/")</pre></div>

1160

</div>

1161

</li>

1162

</ul>

1163

</td>

1164

</tr>

1165

</tbody>

1166

</table>

1167

1168

See also

1169

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

1170

</div>

1171

</dd></dl>

1172

1173

1174

1175

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

1176

1177

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

1178

Implements the ‘match’ operator.

1179

In a column context, this produces a MATCH clause, i.e.

1180

<tt class="docutils literal">MATCH '<other>'</tt>. The allowed contents of <tt class="docutils literal">other</tt>

1181

are database backend specific.

1182

</dd></dl>

1183

1184

1185

1186

<tt class="descname">notilike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.BindParameter.notilike" title="Permalink to this definition">¶</a></dt>

1187

1188

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

1189

implement the <tt class="docutils literal">NOT ILIKE</tt> operator.

1190

This is equivalent to using negation with

1191

<a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.ilike" title="sqlalchemy.sql.operators.ColumnOperators.ilike"><tt class="xref py py-meth docutils literal">ColumnOperators.ilike()</tt></a>, i.e. <tt class="docutils literal">~x.ilike(y)</tt>.

1192

1193

New in version 0.8.

1194

</div>

1195

1196

See also

1197

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

1198

</div>

1199

</dd></dl>

1200

1201

1202

1203

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

1204

1205

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

1206

implement the <tt class="docutils literal">NOT IN</tt> operator.

1207

This is equivalent to using negation with <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.in_" title="sqlalchemy.sql.operators.ColumnOperators.in_"><tt class="xref py py-meth docutils literal">ColumnOperators.in_()</tt></a>,

1208

i.e. <tt class="docutils literal">~x.in_(y)</tt>.

1209

1210

New in version 0.8.

1211

</div>

1212

1213

See also

1214

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

1215

</div>

1216

</dd></dl>

1217

1218

1219

1220

<tt class="descname">notlike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.BindParameter.notlike" title="Permalink to this definition">¶</a></dt>

1221

1222

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

1223

implement the <tt class="docutils literal">NOT LIKE</tt> operator.

1224

This is equivalent to using negation with

1225

<a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.like" title="sqlalchemy.sql.operators.ColumnOperators.like"><tt class="xref py py-meth docutils literal">ColumnOperators.like()</tt></a>, i.e. <tt class="docutils literal">~x.like(y)</tt>.

1226

1227

New in version 0.8.

1228

</div>

1229

1230

See also

1231

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

1232

</div>

1233

</dd></dl>

1234

1235

1236

1237

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

1238

1239

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

1240

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

1241

parent object.

1242

</dd></dl>

1243

1244

1245

1246

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

1247

1248

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

1249

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

1250

parent object.

1251

</dd></dl>

1252

1253

1254

1255

<tt class="descname">op</tt><big>(</big>opstring, precedence=0<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.BindParameter.op" title="Permalink to this definition">¶</a></dt>

1256

1257

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

1258

produce a generic operator function.

1259

e.g.:

1260

<div class="highlight-python"><div class="highlight"><pre>somecolumn.op("*")(5)</pre></div>

1261

</div>

1262

produces:

1263

<div class="highlight-python"><div class="highlight"><pre>somecolumn * 5</pre></div>

1264

</div>

1265

This function can also be used to make bitwise operators explicit. For

1266

example:

1267

<div class="highlight-python"><div class="highlight"><pre>somecolumn.op('&')(0xff)</pre></div>

1268

</div>

1269

is a bitwise AND of the value in <tt class="docutils literal">somecolumn</tt>.

1270

1271

1272

1273

1274

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

1275

<li>operator – a string which will be output as the infix operator

1276

between this element and the expression passed to the

1277

generated function.</li>

1278

<li>precedence – precedence to apply to the operator, when

1279

parenthesizing expressions. A lower number will cause the expression

1280

to be parenthesized when applied against another operator with

1281

higher precedence. The default value of <tt class="docutils literal">0</tt> is lower than all

1282

operators except for the comma (<tt class="docutils literal">,</tt>) and <tt class="docutils literal">AS</tt> operators.

1283

A value of 100 will be higher or equal to all operators, and -100

1284

will be lower than or equal to all operators.

1285

1286

New in version 0.8: - added the ‘precedence’ argument.

1287

</div>

1288

</li>

1289

</ul>

1290

</td>

1291

</tr>

1292

</tbody>

1293

</table>

1294

1295

See also

1296

<a class="reference internal" href="types.html#types-operators">Redefining and Creating New Operators</a>

1297

</div>

1298

</dd></dl>

1299

1300

1301

1302

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

1303

1304

inherited from the <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1305

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

1306

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

1307

elements replaced with values taken from the given dictionary:

1308

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

1309

>>> print clause.compile().params

1310

{'foo':None}

1311

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

1312

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

1313

</div>

1314

</dd></dl>

1315

1316

1317

1318

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

1319

1320

inherited from the <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1321

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

1322

This method is overridden by subclasses to return a

1323

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

1324

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

1325

around themselves when placed into a larger expression,

1326

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

1327

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

1328

subqueries should be normally created using the

1329

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

1330

nested SELECT statements to be named).

1331

As expressions are composed together, the application of

1332

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

1333

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

1334

clause constructs take operator precedence into account -

1335

so parenthesis might not be needed, for example, in

1336

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

1337

over OR.

1338

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

1339

just returns self.

1340

</dd></dl>

1341

1342

1343

1344

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

1345

1346

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

1347

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

1348

has a common ancestor to this <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>.

1349

</dd></dl>

1350

1351

1352

1353

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

1354

1355

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

1356

Implement the <tt class="docutils literal">startwith</tt> operator.

1357

In a column context, produces the clause <tt class="docutils literal">LIKE '<other>%'</tt>

1358

</dd></dl>

1359

1360

1361

1362

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

1363

1364

inherited from the <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1365

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

1366

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

1367

to affected bind parameters so that multiple statements can be

1368

used.

1369

</dd></dl>

1370

1371

</dd></dl>

1372

1373

1374

1375

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

1376

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

1377

Base class for elements of a programmatically constructed SQL

1378

expression.

1379

1380

1381

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

1382

<dd>Compare this ClauseElement to the given ClauseElement.

1383

Subclasses should override the default behavior, which is a

1384

straight identity comparison.

1385

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

1386

may be used to modify the criteria for comparison.

1387

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

1388

</dd></dl>

1389

1390

1391

1392

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

1393

<dd>Compile this SQL expression.

1394

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.

1395

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

1396

string representation of the result. The

1397

<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

1398

dictionary of bind parameter names and values

1399

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

1400

1401

1402

1403

1404

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

1405

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

1406

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

1407

this <a class="reference internal" href="#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>

1408

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

1409

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

1410

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

1411

object are rendered.</li>

1412

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

1413

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

1414

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

1415

any.</li>

1416

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

1417

not support inline retrieval of newly generated primary key

1418

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

1419

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

1420

VALUES clause. This typically refers to Sequence execution but may

1421

also refer to any server-side default generation function

1422

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

1423

</ul>

1424

</td>

1425

</tr>

1426

</tbody>

1427

</table>

1428

</dd></dl>

1429

1430

1431

1432

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

1433

<dd>Return immediate child elements of this <a class="reference internal" href="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>.

1434

This is used for visit traversal.

1435

**kwargs may contain flags that change the collection that is

1436

returned, for example to return a subset of items in order to

1437

cut down on larger traversals, or to return child items from a

1438

different context (such as schema-level collections instead of

1439

clause-level).

1440

</dd></dl>

1441

1442

1443

1444

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

1445

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

1446

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

1447

elements replaced with values taken from the given dictionary:

1448

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

1449

>>> print clause.compile().params

1450

{'foo':None}

1451

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

1452

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

1453

</div>

1454

</dd></dl>

1455

1456

1457

1458

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

1459

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

1460

This method is overridden by subclasses to return a

1461

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

1462

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

1463

around themselves when placed into a larger expression,

1464

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

1465

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

1466

subqueries should be normally created using the

1467

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

1468

nested SELECT statements to be named).

1469

As expressions are composed together, the application of

1470

<a class="reference internal" href="#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> is automatic - end-user code should never

1471

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

1472

clause constructs take operator precedence into account -

1473

so parenthesis might not be needed, for example, in

1474

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

1475

over OR.

1476

The base <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>

1477

just returns self.

1478

</dd></dl>

1479

1480

1481

1482

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

1483

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

1484

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

1485

to affected bind parameters so that multiple statements can be

1486

used.

1487

</dd></dl>

1488

1489

</dd></dl>

1490

1491

1492

1493

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

1494

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

1495

Describe a list of clauses, separated by an operator.

1496

By default, is comma-separated, such as a column listing.

1497

1498

1499

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

1500

<dd>Compare this <a class="reference internal" href="#sqlalchemy.sql.expression.ClauseList" title="sqlalchemy.sql.expression.ClauseList"><tt class="xref py py-class docutils literal">ClauseList</tt></a> to the given <a class="reference internal" href="#sqlalchemy.sql.expression.ClauseList" title="sqlalchemy.sql.expression.ClauseList"><tt class="xref py py-class docutils literal">ClauseList</tt></a>,

1501

including a comparison of all the clause items.

1502

</dd></dl>

1503

1504

</dd></dl>

1505

1506

1507

1508

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

1509

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

1510

Represents a generic column expression from any textual string.

1511

This includes columns associated with tables, aliases and select

1512

statements, but also any arbitrary text. May or may not be bound

1513

to an underlying <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a>.

1514

<a class="reference internal" href="#sqlalchemy.sql.expression.ColumnClause" title="sqlalchemy.sql.expression.ColumnClause"><tt class="xref py py-class docutils literal">ColumnClause</tt></a> is constructed by itself typically via

1515

the <a class="reference internal" href="#sqlalchemy.sql.expression.column" title="sqlalchemy.sql.expression.column"><tt class="xref py py-func docutils literal">column()</tt></a> function. It may be placed directly

1516

into constructs such as <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> constructs:

1517

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

1518

1519

c1, c2 = column("c1"), column("c2")

1520

s = select([c1, c2]).where(c1==5)</pre></div>

1521

</div>

1522

There is also a variant on <a class="reference internal" href="#sqlalchemy.sql.expression.column" title="sqlalchemy.sql.expression.column"><tt class="xref py py-func docutils literal">column()</tt></a> known

1523

as <a class="reference internal" href="#sqlalchemy.sql.expression.literal_column" title="sqlalchemy.sql.expression.literal_column"><tt class="xref py py-func docutils literal">literal_column()</tt></a> - the difference is that

1524

in the latter case, the string value is assumed to be an exact

1525

expression, rather than a column name, so that no quoting rules

1526

or similar are applied:

1527

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy.sql import literal_column, select

1528

1529

s = select([literal_column("5 + 7")])</pre></div>

1530

</div>

1531

<a class="reference internal" href="#sqlalchemy.sql.expression.ColumnClause" title="sqlalchemy.sql.expression.ColumnClause"><tt class="xref py py-class docutils literal">ColumnClause</tt></a> can also be used in a table-like

1532

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

1533

with the <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.table" title="sqlalchemy.sql.expression.table"><tt class="xref py py-func docutils literal">table()</tt></a> function, to produce

1534

a “lightweight” form of table metadata:

1535

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

1536

1537

user = table("user",

1538

column("id"),

1539

column("name"),

1540

column("description"),

1541

)</pre></div>

1542

</div>

1543

The above construct can be created in an ad-hoc fashion and is

1544

not associated with any <a class="reference internal" href="metadata.html#sqlalchemy.schema.MetaData" title="sqlalchemy.schema.MetaData"><tt class="xref py py-class docutils literal">schema.MetaData</tt></a>, unlike it’s

1545

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

1546

1547

1548

1549

1550

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

1551

<li>text – the text of the element.</li>

1552

<li>selectable – parent selectable.</li>

1553

<li>type – <a class="reference internal" href="types.html#sqlalchemy.types.TypeEngine" title="sqlalchemy.types.TypeEngine"><tt class="xref py py-class docutils literal">types.TypeEngine</tt></a> object which can associate

1554

this <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnClause" title="sqlalchemy.sql.expression.ColumnClause"><tt class="xref py py-class docutils literal">ColumnClause</tt></a> with a type.</li>

1555

<li>is_literal – if True, the <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnClause" title="sqlalchemy.sql.expression.ColumnClause"><tt class="xref py py-class docutils literal">ColumnClause</tt></a> is assumed to

1556

be an exact expression that will be delivered to the output with no

1557

quoting rules applied regardless of case sensitive settings. the

1558

<a class="reference internal" href="#sqlalchemy.sql.expression.literal_column" title="sqlalchemy.sql.expression.literal_column"><tt class="xref py py-func docutils literal">literal_column()</tt></a> function is usually used to create such a

1559

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

1560

</ul>

1561

</td>

1562

</tr>

1563

</tbody>

1564

</table>

1565

1566

1567

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

1568

1569

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

1570

Implement the <tt class="docutils literal">==</tt> operator.

1571

In a column context, produces the clause <tt class="docutils literal">a = b</tt>.

1572

If the target is <tt class="docutils literal">None</tt>, produces <tt class="docutils literal">a IS NULL</tt>.

1573

</dd></dl>

1574

1575

1576

1577

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

1578

1579

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

1580

Implement the <tt class="docutils literal"><=</tt> operator.

1581

In a column context, produces the clause <tt class="docutils literal">a <= b</tt>.

1582

</dd></dl>

1583

1584

1585

1586

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

1587

1588

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

1589

Implement the <tt class="docutils literal"><</tt> operator.

1590

In a column context, produces the clause <tt class="docutils literal">a < b</tt>.

1591

</dd></dl>

1592

1593

1594

1595

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

1596

1597

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

1598

Implement the <tt class="docutils literal">!=</tt> operator.

1599

In a column context, produces the clause <tt class="docutils literal">a != b</tt>.

1600

If the target is <tt class="docutils literal">None</tt>, produces <tt class="docutils literal">a IS NOT NULL</tt>.

1601

</dd></dl>

1602

1603

1604

1605

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

1606

1607

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

1608

provides a constant ‘anonymous label’ for this ColumnElement.

1609

This is a label() expression which will be named at compile time.

1610

The same label() is returned each time anon_label is called so

1611

that expressions can reference anon_label multiple times, producing

1612

the same label name at compile time.

1613

the compiler uses this function automatically at compile time

1614

for expressions that are known to be ‘unnamed’ like binary

1615

expressions and function calls.

1616

</dd></dl>

1617

1618

1619

1620

1621

1622

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

1623

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

1624

parent object.

1625

</dd></dl>

1626

1627

1628

1629

<tt class="descname">between</tt><big>(</big>cleft, cright<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnClause.between" title="Permalink to this definition">¶</a></dt>

1630

1631

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

1632

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

1633

the parent object, given the lower and upper range.

1634

</dd></dl>

1635

1636

1637

1638

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

1639

1640

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

1641

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

1642

the parent object, given the collation string.

1643

</dd></dl>

1644

1645

1646

1647

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

1648

1649

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

1650

Compare this ColumnElement to another.

1651

Special arguments understood:

1652

1653

1654

1655

1656

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

1657

<li>use_proxies – when True, consider two columns that

1658

share a common base column as equivalent (i.e. shares_lineage())</li>

1659

<li>equivalents – a dictionary of columns as keys mapped to sets

1660

of columns. If the given “other” column is present in this

1661

dictionary, if any of the columns in the corresponding set() pass the

1662

comparison test, the result is True. This is used to expand the

1663

comparison to other columns that may be known to be equivalent to

1664

this one via foreign key or other criterion.</li>

1665

</ul>

1666

</td>

1667

</tr>

1668

</tbody>

1669

</table>

1670

</dd></dl>

1671

1672

1673

1674

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

1675

1676

inherited from the <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

1677

Compile this SQL expression.

1678

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.

1679

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

1680

string representation of the result. The

1681

<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

1682

dictionary of bind parameter names and values

1683

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

1684

1685

1686

1687

1688

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

1689

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

1690

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

1691

this <a class="reference internal" href="#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>

1692

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

1693

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

1694

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

1695

object are rendered.</li>

1696

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

1697

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

1698

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

1699

any.</li>

1700

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

1701

not support inline retrieval of newly generated primary key

1702

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

1703

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

1704

VALUES clause. This typically refers to Sequence execution but may

1705

also refer to any server-side default generation function

1706

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

1707

</ul>

1708

</td>

1709

</tr>

1710

</tbody>

1711

</table>

1712

</dd></dl>

1713

1714

1715

1716

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

1717

1718

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

1719

Implement the ‘concat’ operator.

1720

In a column context, produces the clause <tt class="docutils literal">a || b</tt>,

1721

or uses the <tt class="docutils literal">concat()</tt> operator on MySQL.

1722

</dd></dl>

1723

1724

1725

1726

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

1727

1728

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

1729

Implement the ‘contains’ operator.

1730

In a column context, produces the clause <tt class="docutils literal">LIKE '%<other>%'</tt>

1731

</dd></dl>

1732

1733

1734

1735

1736

1737

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

1738

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

1739

parent object.

1740

</dd></dl>

1741

1742

1743

1744

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

1745

1746

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

1747

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

1748

parent object.

1749

</dd></dl>

1750

1751

1752

1753

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

1754

1755

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

1756

Implement the ‘endswith’ operator.

1757

In a column context, produces the clause <tt class="docutils literal">LIKE '%<other>'</tt>

1758

</dd></dl>

1759

1760

1761

1762

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

1763

1764

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

1765

Return a column expression.

1766

Part of the inspection interface; returns self.

1767

</dd></dl>

1768

1769

1770

1771

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

1772

1773

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

1774

Return immediate child elements of this <a class="reference internal" href="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>.

1775

This is used for visit traversal.

1776

**kwargs may contain flags that change the collection that is

1777

returned, for example to return a subset of items in order to

1778

cut down on larger traversals, or to return child items from a

1779

different context (such as schema-level collections instead of

1780

clause-level).

1781

</dd></dl>

1782

1783

1784

1785

<tt class="descname">ilike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnClause.ilike" title="Permalink to this definition">¶</a></dt>

1786

1787

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

1788

Implement the <tt class="docutils literal">ilike</tt> operator.

1789

In a column context, produces the clause <tt class="docutils literal">a ILIKE other</tt>.

1790

E.g.:

1791

<div class="highlight-python"><div class="highlight"><pre>select([sometable]).where(sometable.c.column.ilike("%foobar%"))</pre></div>

1792

</div>

1793

1794

1795

1796

1797

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

1798

<li>other – expression to be compared</li>

1799

<li>escape – optional escape character, renders the <tt class="docutils literal">ESCAPE</tt>

1800

keyword, e.g.:

1801

<div class="highlight-python"><div class="highlight"><pre>somecolumn.ilike("foo/%bar", escape="/")</pre></div>

1802

</div>

1803

</li>

1804

</ul>

1805

</td>

1806

</tr>

1807

</tbody>

1808

</table>

1809

1810

See also

1811

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

1812

</div>

1813

</dd></dl>

1814

1815

1816

1817

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

1818

1819

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

1820

Implement the <tt class="docutils literal">in</tt> operator.

1821

In a column context, produces the clause <tt class="docutils literal">a IN other</tt>.

1822

“other” may be a tuple/list of column expressions,

1823

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

1824

</dd></dl>

1825

1826

1827

1828

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

1829

1830

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

1831

Implement the <tt class="docutils literal">IS</tt> operator.

1832

Normally, <tt class="docutils literal">IS</tt> is generated automatically when comparing to a

1833

value of <tt class="docutils literal">None</tt>, which resolves to <tt class="docutils literal">NULL</tt>. However, explicit

1834

usage of <tt class="docutils literal">IS</tt> may be desirable if comparing to boolean values

1835

on certain platforms.

1836

1837

New in version 0.7.9.

1838

</div>

1839

1840

See also

1841

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

1842

</div>

1843

</dd></dl>

1844

1845

1846

1847

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

1848

1849

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

1850

Implement the <tt class="docutils literal">IS NOT</tt> operator.

1851

Normally, <tt class="docutils literal">IS NOT</tt> is generated automatically when comparing to a

1852

value of <tt class="docutils literal">None</tt>, which resolves to <tt class="docutils literal">NULL</tt>. However, explicit

1853

usage of <tt class="docutils literal">IS NOT</tt> may be desirable if comparing to boolean values

1854

on certain platforms.

1855

1856

New in version 0.7.9.

1857

</div>

1858

1859

See also

1860

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

1861

</div>

1862

</dd></dl>

1863

1864

1865

1866

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

1867

1868

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

1869

Produce a column label, i.e. <tt class="docutils literal"><columnname> AS <name></tt>.

1870

This is a shortcut to the <a class="reference internal" href="#sqlalchemy.sql.expression.label" title="sqlalchemy.sql.expression.label"><tt class="xref py py-func docutils literal">label()</tt></a> function.

1871

if ‘name’ is None, an anonymous label name will be generated.

1872

</dd></dl>

1873

1874

1875

1876

<tt class="descname">like</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnClause.like" title="Permalink to this definition">¶</a></dt>

1877

1878

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

1879

Implement the <tt class="docutils literal">like</tt> operator.

1880

In a column context, produces the clause <tt class="docutils literal">a LIKE other</tt>.

1881

E.g.:

1882

<div class="highlight-python"><div class="highlight"><pre>select([sometable]).where(sometable.c.column.like("%foobar%"))</pre></div>

1883

</div>

1884

1885

1886

1887

1888

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

1889

<li>other – expression to be compared</li>

1890

<li>escape – optional escape character, renders the <tt class="docutils literal">ESCAPE</tt>

1891

keyword, e.g.:

1892

<div class="highlight-python"><div class="highlight"><pre>somecolumn.like("foo/%bar", escape="/")</pre></div>

1893

</div>

1894

</li>

1895

</ul>

1896

</td>

1897

</tr>

1898

</tbody>

1899

</table>

1900

1901

See also

1902

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

1903

</div>

1904

</dd></dl>

1905

1906

1907

1908

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

1909

1910

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

1911

Implements the ‘match’ operator.

1912

In a column context, this produces a MATCH clause, i.e.

1913

<tt class="docutils literal">MATCH '<other>'</tt>. The allowed contents of <tt class="docutils literal">other</tt>

1914

are database backend specific.

1915

</dd></dl>

1916

1917

1918

1919

<tt class="descname">notilike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnClause.notilike" title="Permalink to this definition">¶</a></dt>

1920

1921

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

1922

implement the <tt class="docutils literal">NOT ILIKE</tt> operator.

1923

This is equivalent to using negation with

1924

<a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.ilike" title="sqlalchemy.sql.operators.ColumnOperators.ilike"><tt class="xref py py-meth docutils literal">ColumnOperators.ilike()</tt></a>, i.e. <tt class="docutils literal">~x.ilike(y)</tt>.

1925

1926

New in version 0.8.

1927

</div>

1928

1929

See also

1930

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

1931

</div>

1932

</dd></dl>

1933

1934

1935

1936

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

1937

1938

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

1939

implement the <tt class="docutils literal">NOT IN</tt> operator.

1940

This is equivalent to using negation with <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.in_" title="sqlalchemy.sql.operators.ColumnOperators.in_"><tt class="xref py py-meth docutils literal">ColumnOperators.in_()</tt></a>,

1941

i.e. <tt class="docutils literal">~x.in_(y)</tt>.

1942

1943

New in version 0.8.

1944

</div>

1945

1946

See also

1947

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

1948

</div>

1949

</dd></dl>

1950

1951

1952

1953

<tt class="descname">notlike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnClause.notlike" title="Permalink to this definition">¶</a></dt>

1954

1955

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

1956

implement the <tt class="docutils literal">NOT LIKE</tt> operator.

1957

This is equivalent to using negation with

1958

<a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.like" title="sqlalchemy.sql.operators.ColumnOperators.like"><tt class="xref py py-meth docutils literal">ColumnOperators.like()</tt></a>, i.e. <tt class="docutils literal">~x.like(y)</tt>.

1959

1960

New in version 0.8.

1961

</div>

1962

1963

See also

1964

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

1965

</div>

1966

</dd></dl>

1967

1968

1969

1970

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

1971

1972

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

1973

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

1974

parent object.

1975

</dd></dl>

1976

1977

1978

1979

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

1980

1981

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

1982

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

1983

parent object.

1984

</dd></dl>

1985

1986

1987

1988

<tt class="descname">op</tt><big>(</big>opstring, precedence=0<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnClause.op" title="Permalink to this definition">¶</a></dt>

1989

1990

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

1991

produce a generic operator function.

1992

e.g.:

1993

<div class="highlight-python"><div class="highlight"><pre>somecolumn.op("*")(5)</pre></div>

1994

</div>

1995

produces:

1996

<div class="highlight-python"><div class="highlight"><pre>somecolumn * 5</pre></div>

1997

</div>

1998

This function can also be used to make bitwise operators explicit. For

1999

example:

2000

<div class="highlight-python"><div class="highlight"><pre>somecolumn.op('&')(0xff)</pre></div>

2001

</div>

2002

is a bitwise AND of the value in <tt class="docutils literal">somecolumn</tt>.

2003

2004

2005

2006

2007

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

2008

<li>operator – a string which will be output as the infix operator

2009

between this element and the expression passed to the

2010

generated function.</li>

2011

<li>precedence – precedence to apply to the operator, when

2012

parenthesizing expressions. A lower number will cause the expression

2013

to be parenthesized when applied against another operator with

2014

higher precedence. The default value of <tt class="docutils literal">0</tt> is lower than all

2015

operators except for the comma (<tt class="docutils literal">,</tt>) and <tt class="docutils literal">AS</tt> operators.

2016

A value of 100 will be higher or equal to all operators, and -100

2017

will be lower than or equal to all operators.

2018

2019

New in version 0.8: - added the ‘precedence’ argument.

2020

</div>

2021

</li>

2022

</ul>

2023

</td>

2024

</tr>

2025

</tbody>

2026

</table>

2027

2028

See also

2029

<a class="reference internal" href="types.html#types-operators">Redefining and Creating New Operators</a>

2030

</div>

2031

</dd></dl>

2032

2033

2034

2035

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

2036

2037

inherited from the <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

2038

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

2039

This method is overridden by subclasses to return a

2040

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

2041

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

2042

around themselves when placed into a larger expression,

2043

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

2044

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

2045

subqueries should be normally created using the

2046

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

2047

nested SELECT statements to be named).

2048

As expressions are composed together, the application of

2049

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

2050

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

2051

clause constructs take operator precedence into account -

2052

so parenthesis might not be needed, for example, in

2053

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

2054

over OR.

2055

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

2056

just returns self.

2057

</dd></dl>

2058

2059

2060

2061

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

2062

2063

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

2064

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

2065

has a common ancestor to this <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>.

2066

</dd></dl>

2067

2068

2069

2070

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

2071

2072

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

2073

Implement the <tt class="docutils literal">startwith</tt> operator.

2074

In a column context, produces the clause <tt class="docutils literal">LIKE '<other>%'</tt>

2075

</dd></dl>

2076

2077

</dd></dl>

2078

2079

2080

2081

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

2082

<dd>Bases: <tt class="xref py py-class docutils literal">sqlalchemy.util._collections.OrderedProperties</tt>

2083

An ordered dictionary that stores a list of ColumnElement

2084

instances.

2085

Overrides the <tt class="docutils literal">__eq__()</tt> method to produce SQL clauses between

2086

sets of correlated columns.

2087

2088

2089

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

2090

<dd>Add a column to this collection.

2091

The key attribute of the column will be used as the hash key

2092

for this dictionary.

2093

</dd></dl>

2094

2095

2096

2097

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

2098

<dd>add the given column to this collection, removing unaliased

2099

versions of this column as well as existing columns with the

2100

same key.

2101

2102

<div>e.g.:

2103

<div class="highlight-python"><div class="highlight"><pre>t = Table('sometable', metadata, Column('col1', Integer))

2104

t.columns.replace(Column('col1', Integer, key='columnone'))</pre></div>

2105

</div>

2106

will remove the original ‘col1’ from the collection, and add

2107

the new column under the name ‘columnname’.

2108

</div></blockquote>

2109

Used by schema.Column to override columns during table reflection.

2110

</dd></dl>

2111

2112

</dd></dl>

2113

2114

2115

2116

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

2117

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

2118

Represent a column-oriented SQL expression suitable for usage in the

2119

“columns” clause, WHERE clause etc. of a statement.

2120

While the most familiar kind of <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> is the

2121

<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> object, <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> serves as the basis

2122

for any unit that may be present in a SQL expression, including

2123

the expressions themselves, SQL functions, bound parameters,

2124

literal expressions, keywords such as <tt class="docutils literal">NULL</tt>, etc.

2125

<a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> is the ultimate base class for all such elements.

2126

A <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> provides the ability to generate new

2127

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

2128

objects using Python expressions. This means that Python operators

2129

such as <tt class="docutils literal">==</tt>, <tt class="docutils literal">!=</tt> and <tt class="docutils literal"><</tt> are overloaded to mimic SQL operations,

2130

and allow the instantiation of further <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> instances

2131

which are composed from other, more fundamental <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>

2132

objects. For example, two <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnClause" title="sqlalchemy.sql.expression.ColumnClause"><tt class="xref py py-class docutils literal">ColumnClause</tt></a> objects can be added

2133

together with the addition operator <tt class="docutils literal">+</tt> to produce

2134

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

2135

Both <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnClause" title="sqlalchemy.sql.expression.ColumnClause"><tt class="xref py py-class docutils literal">ColumnClause</tt></a> and <a class="reference internal" href="#sqlalchemy.sql.expression.BinaryExpression" title="sqlalchemy.sql.expression.BinaryExpression"><tt class="xref py py-class docutils literal">BinaryExpression</tt></a> are subclasses

2136

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

2137

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

2138

>>> column('a') + column('b')

2139

<sqlalchemy.sql.expression.BinaryExpression object at 0x101029dd0>

2140

>>> print column('a') + column('b')

2141

a + b</pre></div>

2142

</div>

2143

<a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> supports the ability to be a proxy element,

2144

which indicates that the <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> may be associated with

2145

a <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a> which was derived from another <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a>.

2146

An example of a “derived” <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Selectable" title="sqlalchemy.sql.expression.Selectable"><tt class="xref py py-class docutils literal">Selectable</tt></a> is an <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Alias" title="sqlalchemy.sql.expression.Alias"><tt class="xref py py-class docutils literal">Alias</tt></a> of a

2147

<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>. For the ambitious, an in-depth

2148

discussion of this concept can be found at

2149

<a class="reference external" href="http://techspot.zzzeek.org/2008/01/23/expression-transformations/">Expression Transformations</a>.

2150

2151

2152

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

2153

2154

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

2155

Implement the <tt class="docutils literal">==</tt> operator.

2156

In a column context, produces the clause <tt class="docutils literal">a = b</tt>.

2157

If the target is <tt class="docutils literal">None</tt>, produces <tt class="docutils literal">a IS NULL</tt>.

2158

</dd></dl>

2159

2160

2161

2162

2163

2164

inherited from the <tt class="xref py py-attr docutils literal">__init__</tt> attribute of <tt class="xref py py-class docutils literal">object</tt></div>

2165

x.__init__(...) initializes x; see help(type(x)) for signature

2166

</dd></dl>

2167

2168

2169

2170

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

2171

2172

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

2173

Implement the <tt class="docutils literal"><=</tt> operator.

2174

In a column context, produces the clause <tt class="docutils literal">a <= b</tt>.

2175

</dd></dl>

2176

2177

2178

2179

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

2180

2181

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

2182

Implement the <tt class="docutils literal"><</tt> operator.

2183

In a column context, produces the clause <tt class="docutils literal">a < b</tt>.

2184

</dd></dl>

2185

2186

2187

2188

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

2189

2190

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

2191

Implement the <tt class="docutils literal">!=</tt> operator.

2192

In a column context, produces the clause <tt class="docutils literal">a != b</tt>.

2193

If the target is <tt class="docutils literal">None</tt>, produces <tt class="docutils literal">a IS NOT NULL</tt>.

2194

</dd></dl>

2195

2196

2197

2198

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

2199

<dd>provides a constant ‘anonymous label’ for this ColumnElement.

2200

This is a label() expression which will be named at compile time.

2201

The same label() is returned each time anon_label is called so

2202

that expressions can reference anon_label multiple times, producing

2203

the same label name at compile time.

2204

the compiler uses this function automatically at compile time

2205

for expressions that are known to be ‘unnamed’ like binary

2206

expressions and function calls.

2207

</dd></dl>

2208

2209

2210

2211

2212

2213

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

2214

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

2215

parent object.

2216

</dd></dl>

2217

2218

2219

2220

<tt class="descname">between</tt><big>(</big>cleft, cright<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnElement.between" title="Permalink to this definition">¶</a></dt>

2221

2222

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

2223

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

2224

the parent object, given the lower and upper range.

2225

</dd></dl>

2226

2227

2228

2229

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

2230

2231

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

2232

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

2233

the parent object, given the collation string.

2234

</dd></dl>

2235

2236

2237

2238

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

2239

<dd>Compare this ColumnElement to another.

2240

Special arguments understood:

2241

2242

2243

2244

2245

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

2246

<li>use_proxies – when True, consider two columns that

2247

share a common base column as equivalent (i.e. shares_lineage())</li>

2248

<li>equivalents – a dictionary of columns as keys mapped to sets

2249

of columns. If the given “other” column is present in this

2250

dictionary, if any of the columns in the corresponding set() pass the

2251

comparison test, the result is True. This is used to expand the

2252

comparison to other columns that may be known to be equivalent to

2253

this one via foreign key or other criterion.</li>

2254

</ul>

2255

</td>

2256

</tr>

2257

</tbody>

2258

</table>

2259

</dd></dl>

2260

2261

2262

2263

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

2264

2265

inherited from the <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

2266

Compile this SQL expression.

2267

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.

2268

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

2269

string representation of the result. The

2270

<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

2271

dictionary of bind parameter names and values

2272

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

2273

2274

2275

2276

2277

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

2278

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

2279

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

2280

this <a class="reference internal" href="#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>

2281

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

2282

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

2283

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

2284

object are rendered.</li>

2285

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

2286

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

2287

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

2288

any.</li>

2289

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

2290

not support inline retrieval of newly generated primary key

2291

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

2292

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

2293

VALUES clause. This typically refers to Sequence execution but may

2294

also refer to any server-side default generation function

2295

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

2296

</ul>

2297

</td>

2298

</tr>

2299

</tbody>

2300

</table>

2301

</dd></dl>

2302

2303

2304

2305

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

2306

2307

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

2308

Implement the ‘concat’ operator.

2309

In a column context, produces the clause <tt class="docutils literal">a || b</tt>,

2310

or uses the <tt class="docutils literal">concat()</tt> operator on MySQL.

2311

</dd></dl>

2312

2313

2314

2315

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

2316

2317

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

2318

Implement the ‘contains’ operator.

2319

In a column context, produces the clause <tt class="docutils literal">LIKE '%<other>%'</tt>

2320

</dd></dl>

2321

2322

2323

2324

2325

2326

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

2327

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

2328

parent object.

2329

</dd></dl>

2330

2331

2332

2333

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

2334

2335

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

2336

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

2337

parent object.

2338

</dd></dl>

2339

2340

2341

2342

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

2343

2344

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

2345

Implement the ‘endswith’ operator.

2346

In a column context, produces the clause <tt class="docutils literal">LIKE '%<other>'</tt>

2347

</dd></dl>

2348

2349

2350

2351

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

2352

<dd>Return a column expression.

2353

Part of the inspection interface; returns self.

2354

</dd></dl>

2355

2356

2357

2358

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

2359

2360

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

2361

Return immediate child elements of this <a class="reference internal" href="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>.

2362

This is used for visit traversal.

2363

**kwargs may contain flags that change the collection that is

2364

returned, for example to return a subset of items in order to

2365

cut down on larger traversals, or to return child items from a

2366

different context (such as schema-level collections instead of

2367

clause-level).

2368

</dd></dl>

2369

2370

2371

2372

<tt class="descname">ilike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnElement.ilike" title="Permalink to this definition">¶</a></dt>

2373

2374

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

2375

Implement the <tt class="docutils literal">ilike</tt> operator.

2376

In a column context, produces the clause <tt class="docutils literal">a ILIKE other</tt>.

2377

E.g.:

2378

<div class="highlight-python"><div class="highlight"><pre>select([sometable]).where(sometable.c.column.ilike("%foobar%"))</pre></div>

2379

</div>

2380

2381

2382

2383

2384

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

2385

<li>other – expression to be compared</li>

2386

<li>escape – optional escape character, renders the <tt class="docutils literal">ESCAPE</tt>

2387

keyword, e.g.:

2388

<div class="highlight-python"><div class="highlight"><pre>somecolumn.ilike("foo/%bar", escape="/")</pre></div>

2389

</div>

2390

</li>

2391

</ul>

2392

</td>

2393

</tr>

2394

</tbody>

2395

</table>

2396

2397

See also

2398

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

2399

</div>

2400

</dd></dl>

2401

2402

2403

2404

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

2405

2406

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

2407

Implement the <tt class="docutils literal">in</tt> operator.

2408

In a column context, produces the clause <tt class="docutils literal">a IN other</tt>.

2409

“other” may be a tuple/list of column expressions,

2410

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

2411

</dd></dl>

2412

2413

2414

2415

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

2416

2417

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

2418

Implement the <tt class="docutils literal">IS</tt> operator.

2419

Normally, <tt class="docutils literal">IS</tt> is generated automatically when comparing to a

2420

value of <tt class="docutils literal">None</tt>, which resolves to <tt class="docutils literal">NULL</tt>. However, explicit

2421

usage of <tt class="docutils literal">IS</tt> may be desirable if comparing to boolean values

2422

on certain platforms.

2423

2424

New in version 0.7.9.

2425

</div>

2426

2427

See also

2428

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

2429

</div>

2430

</dd></dl>

2431

2432

2433

2434

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

2435

2436

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

2437

Implement the <tt class="docutils literal">IS NOT</tt> operator.

2438

Normally, <tt class="docutils literal">IS NOT</tt> is generated automatically when comparing to a

2439

value of <tt class="docutils literal">None</tt>, which resolves to <tt class="docutils literal">NULL</tt>. However, explicit

2440

usage of <tt class="docutils literal">IS NOT</tt> may be desirable if comparing to boolean values

2441

on certain platforms.

2442

2443

New in version 0.7.9.

2444

</div>

2445

2446

See also

2447

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

2448

</div>

2449

</dd></dl>

2450

2451

2452

2453

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

2454

<dd>Produce a column label, i.e. <tt class="docutils literal"><columnname> AS <name></tt>.

2455

This is a shortcut to the <a class="reference internal" href="#sqlalchemy.sql.expression.label" title="sqlalchemy.sql.expression.label"><tt class="xref py py-func docutils literal">label()</tt></a> function.

2456

if ‘name’ is None, an anonymous label name will be generated.

2457

</dd></dl>

2458

2459

2460

2461

<tt class="descname">like</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnElement.like" title="Permalink to this definition">¶</a></dt>

2462

2463

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

2464

Implement the <tt class="docutils literal">like</tt> operator.

2465

In a column context, produces the clause <tt class="docutils literal">a LIKE other</tt>.

2466

E.g.:

2467

<div class="highlight-python"><div class="highlight"><pre>select([sometable]).where(sometable.c.column.like("%foobar%"))</pre></div>

2468

</div>

2469

2470

2471

2472

2473

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

2474

<li>other – expression to be compared</li>

2475

<li>escape – optional escape character, renders the <tt class="docutils literal">ESCAPE</tt>

2476

keyword, e.g.:

2477

<div class="highlight-python"><div class="highlight"><pre>somecolumn.like("foo/%bar", escape="/")</pre></div>

2478

</div>

2479

</li>

2480

</ul>

2481

</td>

2482

</tr>

2483

</tbody>

2484

</table>

2485

2486

See also

2487

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

2488

</div>

2489

</dd></dl>

2490

2491

2492

2493

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

2494

2495

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

2496

Implements the ‘match’ operator.

2497

In a column context, this produces a MATCH clause, i.e.

2498

<tt class="docutils literal">MATCH '<other>'</tt>. The allowed contents of <tt class="docutils literal">other</tt>

2499

are database backend specific.

2500

</dd></dl>

2501

2502

2503

2504

<tt class="descname">notilike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnElement.notilike" title="Permalink to this definition">¶</a></dt>

2505

2506

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

2507

implement the <tt class="docutils literal">NOT ILIKE</tt> operator.

2508

This is equivalent to using negation with

2509

<a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.ilike" title="sqlalchemy.sql.operators.ColumnOperators.ilike"><tt class="xref py py-meth docutils literal">ColumnOperators.ilike()</tt></a>, i.e. <tt class="docutils literal">~x.ilike(y)</tt>.

2510

2511

New in version 0.8.

2512

</div>

2513

2514

See also

2515

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

2516

</div>

2517

</dd></dl>

2518

2519

2520

2521

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

2522

2523

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

2524

implement the <tt class="docutils literal">NOT IN</tt> operator.

2525

This is equivalent to using negation with <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.in_" title="sqlalchemy.sql.operators.ColumnOperators.in_"><tt class="xref py py-meth docutils literal">ColumnOperators.in_()</tt></a>,

2526

i.e. <tt class="docutils literal">~x.in_(y)</tt>.

2527

2528

New in version 0.8.

2529

</div>

2530

2531

See also

2532

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

2533

</div>

2534

</dd></dl>

2535

2536

2537

2538

<tt class="descname">notlike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnElement.notlike" title="Permalink to this definition">¶</a></dt>

2539

2540

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

2541

implement the <tt class="docutils literal">NOT LIKE</tt> operator.

2542

This is equivalent to using negation with

2543

<a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.like" title="sqlalchemy.sql.operators.ColumnOperators.like"><tt class="xref py py-meth docutils literal">ColumnOperators.like()</tt></a>, i.e. <tt class="docutils literal">~x.like(y)</tt>.

2544

2545

New in version 0.8.

2546

</div>

2547

2548

See also

2549

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

2550

</div>

2551

</dd></dl>

2552

2553

2554

2555

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

2556

2557

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

2558

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

2559

parent object.

2560

</dd></dl>

2561

2562

2563

2564

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

2565

2566

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

2567

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

2568

parent object.

2569

</dd></dl>

2570

2571

2572

2573

<tt class="descname">op</tt><big>(</big>opstring, precedence=0<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.ColumnElement.op" title="Permalink to this definition">¶</a></dt>

2574

2575

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

2576

produce a generic operator function.

2577

e.g.:

2578

<div class="highlight-python"><div class="highlight"><pre>somecolumn.op("*")(5)</pre></div>

2579

</div>

2580

produces:

2581

<div class="highlight-python"><div class="highlight"><pre>somecolumn * 5</pre></div>

2582

</div>

2583

This function can also be used to make bitwise operators explicit. For

2584

example:

2585

<div class="highlight-python"><div class="highlight"><pre>somecolumn.op('&')(0xff)</pre></div>

2586

</div>

2587

is a bitwise AND of the value in <tt class="docutils literal">somecolumn</tt>.

2588

2589

2590

2591

2592

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

2593

<li>operator – a string which will be output as the infix operator

2594

between this element and the expression passed to the

2595

generated function.</li>

2596

<li>precedence – precedence to apply to the operator, when

2597

parenthesizing expressions. A lower number will cause the expression

2598

to be parenthesized when applied against another operator with

2599

higher precedence. The default value of <tt class="docutils literal">0</tt> is lower than all

2600

operators except for the comma (<tt class="docutils literal">,</tt>) and <tt class="docutils literal">AS</tt> operators.

2601

A value of 100 will be higher or equal to all operators, and -100

2602

will be lower than or equal to all operators.

2603

2604

New in version 0.8: - added the ‘precedence’ argument.

2605

</div>

2606

</li>

2607

</ul>

2608

</td>

2609

</tr>

2610

</tbody>

2611

</table>

2612

2613

See also

2614

<a class="reference internal" href="types.html#types-operators">Redefining and Creating New Operators</a>

2615

</div>

2616

</dd></dl>

2617

2618

2619

2620

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

2621

2622

inherited from the <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

2623

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

2624

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

2625

elements replaced with values taken from the given dictionary:

2626

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

2627

>>> print clause.compile().params

2628

{'foo':None}

2629

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

2630

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

2631

</div>

2632

</dd></dl>

2633

2634

2635

2636

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

2637

2638

inherited from the <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

2639

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

2640

This method is overridden by subclasses to return a

2641

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

2642

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

2643

around themselves when placed into a larger expression,

2644

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

2645

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

2646

subqueries should be normally created using the

2647

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

2648

nested SELECT statements to be named).

2649

As expressions are composed together, the application of

2650

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

2651

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

2652

clause constructs take operator precedence into account -

2653

so parenthesis might not be needed, for example, in

2654

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

2655

over OR.

2656

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

2657

just returns self.

2658

</dd></dl>

2659

2660

2661

2662

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

2663

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

2664

has a common ancestor to this <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>.

2665

</dd></dl>

2666

2667

2668

2669

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

2670

2671

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

2672

Implement the <tt class="docutils literal">startwith</tt> operator.

2673

In a column context, produces the clause <tt class="docutils literal">LIKE '<other>%'</tt>

2674

</dd></dl>

2675

2676

2677

2678

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

2679

2680

inherited from the <a class="reference internal" href="#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="#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a></div>

2681

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

2682

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

2683

to affected bind parameters so that multiple statements can be

2684

used.

2685

</dd></dl>

2686

2687

</dd></dl>

2688

2689

2690

2691

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

2692

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

2693

Defines boolean, comparison, and other operators for

2694

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

2695

By default, all methods call down to

2696

<a class="reference internal" href="#sqlalchemy.sql.operators.Operators.operate" title="sqlalchemy.sql.operators.Operators.operate"><tt class="xref py py-meth docutils literal">operate()</tt></a> or <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.reverse_operate" title="sqlalchemy.sql.operators.ColumnOperators.reverse_operate"><tt class="xref py py-meth docutils literal">reverse_operate()</tt></a>,

2697

passing in the appropriate operator function from the

2698

Python builtin <tt class="docutils literal">operator</tt> module or

2699

a SQLAlchemy-specific operator function from

2700

<tt class="xref py py-mod docutils literal">sqlalchemy.expression.operators</tt>. For example

2701

the <tt class="docutils literal">__eq__</tt> function:

2702

<div class="highlight-python"><div class="highlight"><pre>def __eq__(self, other):

2703

return self.operate(operators.eq, other)</pre></div>

2704

</div>

2705

Where <tt class="docutils literal">operators.eq</tt> is essentially:

2706

<div class="highlight-python"><div class="highlight"><pre>def eq(a, b):

2707

return a == b</pre></div>

2708

</div>

2709

The core column expression unit <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a>

2710

overrides <a class="reference internal" href="#sqlalchemy.sql.operators.Operators.operate" title="sqlalchemy.sql.operators.Operators.operate"><tt class="xref py py-meth docutils literal">Operators.operate()</tt></a> and others

2711

to return further <a class="reference internal" href="#sqlalchemy.sql.expression.ColumnElement" title="sqlalchemy.sql.expression.ColumnElement"><tt class="xref py py-class docutils literal">ColumnElement</tt></a> constructs,

2712

so that the <tt class="docutils literal">==</tt> operation above is replaced by a clause

2713

construct.

2714

See also:

2715

<a class="reference internal" href="types.html#types-operators">Redefining and Creating New Operators</a>

2716

<a class="reference internal" href="types.html#sqlalchemy.types.TypeEngine.comparator_factory" title="sqlalchemy.types.TypeEngine.comparator_factory"><tt class="xref py py-attr docutils literal">TypeEngine.comparator_factory</tt></a>

2717

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

2718

<a class="reference internal" href="../orm/internals.html#sqlalchemy.orm.interfaces.PropComparator" title="sqlalchemy.orm.interfaces.PropComparator"><tt class="xref py py-class docutils literal">PropComparator</tt></a>

2719

2720

2721

<tt class="descname">__add__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__add__" title="Permalink to this definition">¶</a></dt>

2722

<dd>Implement the <tt class="docutils literal">+</tt> operator.

2723

In a column context, produces the clause <tt class="docutils literal">a + b</tt>

2724

if the parent object has non-string affinity.

2725

If the parent object has a string affinity,

2726

produces the concatenation operator, <tt class="docutils literal">a || b</tt> -

2727

see <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.concat" title="sqlalchemy.sql.operators.ColumnOperators.concat"><tt class="xref py py-meth docutils literal">ColumnOperators.concat()</tt></a>.

2728

</dd></dl>

2729

2730

2731

2732

<tt class="descname">__and__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__and__" title="Permalink to this definition">¶</a></dt>

2733

2734

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

2735

Implement the <tt class="docutils literal">&</tt> operator.

2736

When used with SQL expressions, results in an

2737

AND operation, equivalent to

2738

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

2739

2740

</div>

2741

is equivalent to:

2742

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

2743

and_(a, b)</pre></div>

2744

</div>

2745

Care should be taken when using <tt class="docutils literal">&</tt> regarding

2746

operator precedence; the <tt class="docutils literal">&</tt> operator has the highest precedence.

2747

The operands should be enclosed in parenthesis if they contain

2748

further sub expressions:

2749

2750

</div>

2751

</dd></dl>

2752

2753

2754

2755

<tt class="descname">__delattr__</tt><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__delattr__" title="Permalink to this definition">¶</a></dt>

2756

2757

inherited from the <tt class="xref py py-attr docutils literal">__delattr__</tt> attribute of <tt class="xref py py-class docutils literal">object</tt></div>

2758

x.__delattr__(‘name’) <==> del x.name

2759

</dd></dl>

2760

2761

2762

2763

<tt class="descname">__div__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__div__" title="Permalink to this definition">¶</a></dt>

2764

<dd>Implement the <tt class="docutils literal">/</tt> operator.

2765

In a column context, produces the clause <tt class="docutils literal">a / b</tt>.

2766

</dd></dl>

2767

2768

2769

2770

<tt class="descname">__eq__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__eq__" title="Permalink to this definition">¶</a></dt>

2771

<dd>Implement the <tt class="docutils literal">==</tt> operator.

2772

In a column context, produces the clause <tt class="docutils literal">a = b</tt>.

2773

If the target is <tt class="docutils literal">None</tt>, produces <tt class="docutils literal">a IS NULL</tt>.

2774

</dd></dl>

2775

2776

2777

2778

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

2779

2780

inherited from the <tt class="xref py py-meth docutils literal">__format__()</tt> method of <tt class="xref py py-class docutils literal">object</tt></div>

2781

default object formatter

2782

</dd></dl>

2783

2784

2785

2786

<tt class="descname">__ge__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__ge__" title="Permalink to this definition">¶</a></dt>

2787

<dd>Implement the <tt class="docutils literal">>=</tt> operator.

2788

In a column context, produces the clause <tt class="docutils literal">a >= b</tt>.

2789

</dd></dl>

2790

2791

2792

2793

<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__getattribute__" title="Permalink to this definition">¶</a></dt>

2794

2795

inherited from the <tt class="xref py py-attr docutils literal">__getattribute__</tt> attribute of <tt class="xref py py-class docutils literal">object</tt></div>

2796

x.__getattribute__(‘name’) <==> x.name

2797

</dd></dl>

2798

2799

2800

2801

<tt class="descname">__getitem__</tt><big>(</big>index<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__getitem__" title="Permalink to this definition">¶</a></dt>

2802

<dd>Implement the [] operator.

2803

This can be used by some database-specific types

2804

such as Postgresql ARRAY and HSTORE.

2805

</dd></dl>

2806

2807

2808

2809

<tt class="descname">__gt__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__gt__" title="Permalink to this definition">¶</a></dt>

2810

<dd>Implement the <tt class="docutils literal">></tt> operator.

2811

In a column context, produces the clause <tt class="docutils literal">a > b</tt>.

2812

</dd></dl>

2813

2814

2815

2816

2817

<dd>x.__hash__() <==> hash(x)

2818

</dd></dl>

2819

2820

2821

2822

2823

2824

inherited from the <tt class="xref py py-attr docutils literal">__init__</tt> attribute of <tt class="xref py py-class docutils literal">object</tt></div>

2825

x.__init__(...) initializes x; see help(type(x)) for signature

2826

</dd></dl>

2827

2828

2829

2830

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

2831

2832

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

2833

Implement the <tt class="docutils literal">~</tt> operator.

2834

When used with SQL expressions, results in a

2835

NOT operation, equivalent to

2836

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

2837

2838

</div>

2839

is equivalent to:

2840

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

2841

not_(a)</pre></div>

2842

</div>

2843

</dd></dl>

2844

2845

2846

2847

<tt class="descname">__le__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__le__" title="Permalink to this definition">¶</a></dt>

2848

<dd>Implement the <tt class="docutils literal"><=</tt> operator.

2849

In a column context, produces the clause <tt class="docutils literal">a <= b</tt>.

2850

</dd></dl>

2851

2852

2853

2854

<tt class="descname">__lshift__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__lshift__" title="Permalink to this definition">¶</a></dt>

2855

<dd>implement the << operator.

2856

Not used by SQLAlchemy core, this is provided

2857

for custom operator systems which want to use

2858

<< as an extension point.

2859

</dd></dl>

2860

2861

2862

2863

<tt class="descname">__lt__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__lt__" title="Permalink to this definition">¶</a></dt>

2864

<dd>Implement the <tt class="docutils literal"><</tt> operator.

2865

In a column context, produces the clause <tt class="docutils literal">a < b</tt>.

2866

</dd></dl>

2867

2868

2869

2870

<tt class="descname">__mod__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__mod__" title="Permalink to this definition">¶</a></dt>

2871

<dd>Implement the <tt class="docutils literal">%</tt> operator.

2872

In a column context, produces the clause <tt class="docutils literal">a % b</tt>.

2873

</dd></dl>

2874

2875

2876

2877

<tt class="descname">__mul__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__mul__" title="Permalink to this definition">¶</a></dt>

2878

<dd>Implement the <tt class="docutils literal">*</tt> operator.

2879

In a column context, produces the clause <tt class="docutils literal">a * b</tt>.

2880

</dd></dl>

2881

2882

2883

2884

<tt class="descname">__ne__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__ne__" title="Permalink to this definition">¶</a></dt>

2885

<dd>Implement the <tt class="docutils literal">!=</tt> operator.

2886

In a column context, produces the clause <tt class="docutils literal">a != b</tt>.

2887

If the target is <tt class="docutils literal">None</tt>, produces <tt class="docutils literal">a IS NOT NULL</tt>.

2888

</dd></dl>

2889

2890

2891

2892

2893

<dd>Implement the <tt class="docutils literal">-</tt> operator.

2894

In a column context, produces the clause <tt class="docutils literal">-a</tt>.

2895

</dd></dl>

2896

2897

2898

2899

static <tt class="descname">__new__</tt><big>(</big>S, ...<big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__new__" title="Permalink to this definition">¶</a></dt>

2900

2901

inherited from the <tt class="xref py py-meth docutils literal">__new__()</tt> method of <tt class="xref py py-class docutils literal">object</tt></div>

2902

</dd></dl>

2903

2904

2905

2906

<tt class="descname">__or__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__or__" title="Permalink to this definition">¶</a></dt>

2907

2908

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

2909

Implement the <tt class="docutils literal">|</tt> operator.

2910

When used with SQL expressions, results in an

2911

OR operation, equivalent to

2912

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

2913

2914

</div>

2915

is equivalent to:

2916

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

2917

or_(a, b)</pre></div>

2918

</div>

2919

Care should be taken when using <tt class="docutils literal">|</tt> regarding

2920

operator precedence; the <tt class="docutils literal">|</tt> operator has the highest precedence.

2921

The operands should be enclosed in parenthesis if they contain

2922

further sub expressions:

2923

2924

</div>

2925

</dd></dl>

2926

2927

2928

2929

<tt class="descname">__radd__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__radd__" title="Permalink to this definition">¶</a></dt>

2930

<dd>Implement the <tt class="docutils literal">+</tt> operator in reverse.

2931

See <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.__add__" title="sqlalchemy.sql.operators.ColumnOperators.__add__"><tt class="xref py py-meth docutils literal">ColumnOperators.__add__()</tt></a>.

2932

</dd></dl>

2933

2934

2935

2936

<tt class="descname">__rdiv__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__rdiv__" title="Permalink to this definition">¶</a></dt>

2937

<dd>Implement the <tt class="docutils literal">/</tt> operator in reverse.

2938

See <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.__div__" title="sqlalchemy.sql.operators.ColumnOperators.__div__"><tt class="xref py py-meth docutils literal">ColumnOperators.__div__()</tt></a>.

2939

</dd></dl>

2940

2941

2942

2943

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

2944

2945

inherited from the <tt class="xref py py-meth docutils literal">__reduce__()</tt> method of <tt class="xref py py-class docutils literal">object</tt></div>

2946

helper for pickle

2947

</dd></dl>

2948

2949

2950

2951

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

2952

2953

inherited from the <tt class="xref py py-meth docutils literal">__reduce_ex__()</tt> method of <tt class="xref py py-class docutils literal">object</tt></div>

2954

helper for pickle

2955

</dd></dl>

2956

2957

2958

2959

2960

2961

inherited from the <tt class="xref py py-attr docutils literal">__repr__</tt> attribute of <tt class="xref py py-class docutils literal">object</tt></div>

2962

x.__repr__() <==> repr(x)

2963

</dd></dl>

2964

2965

2966

2967

<tt class="descname">__rmul__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__rmul__" title="Permalink to this definition">¶</a></dt>

2968

<dd>Implement the <tt class="docutils literal">*</tt> operator in reverse.

2969

See <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.__mul__" title="sqlalchemy.sql.operators.ColumnOperators.__mul__"><tt class="xref py py-meth docutils literal">ColumnOperators.__mul__()</tt></a>.

2970

</dd></dl>

2971

2972

2973

2974

<tt class="descname">__rshift__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__rshift__" title="Permalink to this definition">¶</a></dt>

2975

<dd>implement the >> operator.

2976

Not used by SQLAlchemy core, this is provided

2977

for custom operator systems which want to use

2978

>> as an extension point.

2979

</dd></dl>

2980

2981

2982

2983

<tt class="descname">__rsub__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__rsub__" title="Permalink to this definition">¶</a></dt>

2984

<dd>Implement the <tt class="docutils literal">-</tt> operator in reverse.

2985

See <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.__sub__" title="sqlalchemy.sql.operators.ColumnOperators.__sub__"><tt class="xref py py-meth docutils literal">ColumnOperators.__sub__()</tt></a>.

2986

</dd></dl>

2987

2988

2989

2990

<tt class="descname">__rtruediv__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__rtruediv__" title="Permalink to this definition">¶</a></dt>

2991

<dd>Implement the <tt class="docutils literal">//</tt> operator in reverse.

2992

See <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.__truediv__" title="sqlalchemy.sql.operators.ColumnOperators.__truediv__"><tt class="xref py py-meth docutils literal">ColumnOperators.__truediv__()</tt></a>.

2993

</dd></dl>

2994

2995

2996

2997

<tt class="descname">__setattr__</tt><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__setattr__" title="Permalink to this definition">¶</a></dt>

2998

2999

inherited from the <tt class="xref py py-attr docutils literal">__setattr__</tt> attribute of <tt class="xref py py-class docutils literal">object</tt></div>

3000

x.__setattr__(‘name’, value) <==> x.name = value

3001

</dd></dl>

3002

3003

3004

3005

<tt class="descname">__sizeof__</tt><big>(</big><big>)</big> → int<a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__sizeof__" title="Permalink to this definition">¶</a></dt>

3006

3007

inherited from the <tt class="xref py py-meth docutils literal">__sizeof__()</tt> method of <tt class="xref py py-class docutils literal">object</tt></div>

3008

size of object in memory, in bytes

3009

</dd></dl>

3010

3011

3012

3013

3014

3015

inherited from the <tt class="xref py py-attr docutils literal">__str__</tt> attribute of <tt class="xref py py-class docutils literal">object</tt></div>

3016

x.__str__() <==> str(x)

3017

</dd></dl>

3018

3019

3020

3021

<tt class="descname">__sub__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__sub__" title="Permalink to this definition">¶</a></dt>

3022

<dd>Implement the <tt class="docutils literal">-</tt> operator.

3023

In a column context, produces the clause <tt class="docutils literal">a - b</tt>.

3024

</dd></dl>

3025

3026

3027

3028

static <tt class="descname">__subclasshook__</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__subclasshook__" title="Permalink to this definition">¶</a></dt>

3029

3030

inherited from the <tt class="xref py py-meth docutils literal">__subclasshook__()</tt> method of <tt class="xref py py-class docutils literal">object</tt></div>

3031

Abstract classes can override this to customize issubclass().

3032

This is invoked early on by abc.ABCMeta.__subclasscheck__().

3033

It should return True, False or NotImplemented. If it returns

3034

NotImplemented, the normal algorithm is used. Otherwise, it

3035

overrides the normal algorithm (and the outcome is cached).

3036

</dd></dl>

3037

3038

3039

3040

<tt class="descname">__truediv__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__truediv__" title="Permalink to this definition">¶</a></dt>

3041

<dd>Implement the <tt class="docutils literal">//</tt> operator.

3042

In a column context, produces the clause <tt class="docutils literal">a / b</tt>.

3043

</dd></dl>

3044

3045

3046

3047

<tt class="descname">__weakref__</tt><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.__weakref__" title="Permalink to this definition">¶</a></dt>

3048

3049

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

3050

list of weak references to the object (if defined)

3051

</dd></dl>

3052

3053

3054

3055

3056

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

3057

parent object.

3058

</dd></dl>

3059

3060

3061

3062

<tt class="descname">between</tt><big>(</big>cleft, cright<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.between" title="Permalink to this definition">¶</a></dt>

3063

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

3064

the parent object, given the lower and upper range.

3065

</dd></dl>

3066

3067

3068

3069

<tt class="descname">collate</tt><big>(</big>collation<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.collate" title="Permalink to this definition">¶</a></dt>

3070

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

3071

the parent object, given the collation string.

3072

</dd></dl>

3073

3074

3075

3076

<tt class="descname">concat</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.concat" title="Permalink to this definition">¶</a></dt>

3077

<dd>Implement the ‘concat’ operator.

3078

In a column context, produces the clause <tt class="docutils literal">a || b</tt>,

3079

or uses the <tt class="docutils literal">concat()</tt> operator on MySQL.

3080

</dd></dl>

3081

3082

3083

3084

<tt class="descname">contains</tt><big>(</big>other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.contains" title="Permalink to this definition">¶</a></dt>

3085

<dd>Implement the ‘contains’ operator.

3086

In a column context, produces the clause <tt class="docutils literal">LIKE '%<other>%'</tt>

3087

</dd></dl>

3088

3089

3090

3091

3092

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

3093

parent object.

3094

</dd></dl>

3095

3096

3097

3098

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

3099

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

3100

parent object.

3101

</dd></dl>

3102

3103

3104

3105

<tt class="descname">endswith</tt><big>(</big>other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.endswith" title="Permalink to this definition">¶</a></dt>

3106

<dd>Implement the ‘endswith’ operator.

3107

In a column context, produces the clause <tt class="docutils literal">LIKE '%<other>'</tt>

3108

</dd></dl>

3109

3110

3111

3112

<tt class="descname">ilike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.ilike" title="Permalink to this definition">¶</a></dt>

3113

<dd>Implement the <tt class="docutils literal">ilike</tt> operator.

3114

In a column context, produces the clause <tt class="docutils literal">a ILIKE other</tt>.

3115

E.g.:

3116

<div class="highlight-python"><div class="highlight"><pre>select([sometable]).where(sometable.c.column.ilike("%foobar%"))</pre></div>

3117

</div>

3118

3119

3120

3121

3122

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

3123

<li>other – expression to be compared</li>

3124

<li>escape – optional escape character, renders the <tt class="docutils literal">ESCAPE</tt>

3125

keyword, e.g.:

3126

<div class="highlight-python"><div class="highlight"><pre>somecolumn.ilike("foo/%bar", escape="/")</pre></div>

3127

</div>

3128

</li>

3129

</ul>

3130

</td>

3131

</tr>

3132

</tbody>

3133

</table>

3134

3135

See also

3136

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

3137

</div>

3138

</dd></dl>

3139

3140

3141

3142

<tt class="descname">in_</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.in_" title="Permalink to this definition">¶</a></dt>

3143

<dd>Implement the <tt class="docutils literal">in</tt> operator.

3144

In a column context, produces the clause <tt class="docutils literal">a IN other</tt>.

3145

“other” may be a tuple/list of column expressions,

3146

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

3147

</dd></dl>

3148

3149

3150

3151

<tt class="descname">is_</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.is_" title="Permalink to this definition">¶</a></dt>

3152

<dd>Implement the <tt class="docutils literal">IS</tt> operator.

3153

Normally, <tt class="docutils literal">IS</tt> is generated automatically when comparing to a

3154

value of <tt class="docutils literal">None</tt>, which resolves to <tt class="docutils literal">NULL</tt>. However, explicit

3155

usage of <tt class="docutils literal">IS</tt> may be desirable if comparing to boolean values

3156

on certain platforms.

3157

3158

New in version 0.7.9.

3159

</div>

3160

3161

See also

3162

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

3163

</div>

3164

</dd></dl>

3165

3166

3167

3168

<tt class="descname">isnot</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.isnot" title="Permalink to this definition">¶</a></dt>

3169

<dd>Implement the <tt class="docutils literal">IS NOT</tt> operator.

3170

Normally, <tt class="docutils literal">IS NOT</tt> is generated automatically when comparing to a

3171

value of <tt class="docutils literal">None</tt>, which resolves to <tt class="docutils literal">NULL</tt>. However, explicit

3172

usage of <tt class="docutils literal">IS NOT</tt> may be desirable if comparing to boolean values

3173

on certain platforms.

3174

3175

New in version 0.7.9.

3176

</div>

3177

3178

See also

3179

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

3180

</div>

3181

</dd></dl>

3182

3183

3184

3185

<tt class="descname">like</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.like" title="Permalink to this definition">¶</a></dt>

3186

<dd>Implement the <tt class="docutils literal">like</tt> operator.

3187

In a column context, produces the clause <tt class="docutils literal">a LIKE other</tt>.

3188

E.g.:

3189

<div class="highlight-python"><div class="highlight"><pre>select([sometable]).where(sometable.c.column.like("%foobar%"))</pre></div>

3190

</div>

3191

3192

3193

3194

3195

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

3196

<li>other – expression to be compared</li>

3197

<li>escape – optional escape character, renders the <tt class="docutils literal">ESCAPE</tt>

3198

keyword, e.g.:

3199

<div class="highlight-python"><div class="highlight"><pre>somecolumn.like("foo/%bar", escape="/")</pre></div>

3200

</div>

3201

</li>

3202

</ul>

3203

</td>

3204

</tr>

3205

</tbody>

3206

</table>

3207

3208

See also

3209

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

3210

</div>

3211

</dd></dl>

3212

3213

3214

3215

<tt class="descname">match</tt><big>(</big>other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.match" title="Permalink to this definition">¶</a></dt>

3216

<dd>Implements the ‘match’ operator.

3217

In a column context, this produces a MATCH clause, i.e.

3218

<tt class="docutils literal">MATCH '<other>'</tt>. The allowed contents of <tt class="docutils literal">other</tt>

3219

are database backend specific.

3220

</dd></dl>

3221

3222

3223

3224

<tt class="descname">notilike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.notilike" title="Permalink to this definition">¶</a></dt>

3225

<dd>implement the <tt class="docutils literal">NOT ILIKE</tt> operator.

3226

This is equivalent to using negation with

3227

<a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.ilike" title="sqlalchemy.sql.operators.ColumnOperators.ilike"><tt class="xref py py-meth docutils literal">ColumnOperators.ilike()</tt></a>, i.e. <tt class="docutils literal">~x.ilike(y)</tt>.

3228

3229

New in version 0.8.

3230

</div>

3231

3232

See also

3233

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

3234

</div>

3235

</dd></dl>

3236

3237

3238

3239

<tt class="descname">notin_</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.notin_" title="Permalink to this definition">¶</a></dt>

3240

<dd>implement the <tt class="docutils literal">NOT IN</tt> operator.

3241

This is equivalent to using negation with <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.in_" title="sqlalchemy.sql.operators.ColumnOperators.in_"><tt class="xref py py-meth docutils literal">ColumnOperators.in_()</tt></a>,

3242

i.e. <tt class="docutils literal">~x.in_(y)</tt>.

3243

3244

New in version 0.8.

3245

</div>

3246

3247

See also

3248

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

3249

</div>

3250

</dd></dl>

3251

3252

3253

3254

<tt class="descname">notlike</tt><big>(</big>other, escape=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.notlike" title="Permalink to this definition">¶</a></dt>

3255

<dd>implement the <tt class="docutils literal">NOT LIKE</tt> operator.

3256

This is equivalent to using negation with

3257

<a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.like" title="sqlalchemy.sql.operators.ColumnOperators.like"><tt class="xref py py-meth docutils literal">ColumnOperators.like()</tt></a>, i.e. <tt class="docutils literal">~x.like(y)</tt>.

3258

3259

New in version 0.8.

3260

</div>

3261

3262

See also

3263

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

3264

</div>

3265

</dd></dl>

3266

3267

3268

3269

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

3270

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

3271

parent object.

3272

</dd></dl>

3273

3274

3275

3276

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

3277

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

3278

parent object.

3279

</dd></dl>

3280

3281

3282

3283

<tt class="descname">op</tt><big>(</big>opstring, precedence=0<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.op" title="Permalink to this definition">¶</a></dt>

3284

3285

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

3286

produce a generic operator function.

3287

e.g.:

3288

<div class="highlight-python"><div class="highlight"><pre>somecolumn.op("*")(5)</pre></div>

3289

</div>

3290

produces:

3291

<div class="highlight-python"><div class="highlight"><pre>somecolumn * 5</pre></div>

3292

</div>

3293

This function can also be used to make bitwise operators explicit. For

3294

example:

3295

<div class="highlight-python"><div class="highlight"><pre>somecolumn.op('&')(0xff)</pre></div>

3296

</div>

3297

is a bitwise AND of the value in <tt class="docutils literal">somecolumn</tt>.

3298

3299

3300

3301

3302

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

3303

<li>operator – a string which will be output as the infix operator

3304

between this element and the expression passed to the

3305

generated function.</li>

3306

<li>precedence – precedence to apply to the operator, when

3307

parenthesizing expressions. A lower number will cause the expression

3308

to be parenthesized when applied against another operator with

3309

higher precedence. The default value of <tt class="docutils literal">0</tt> is lower than all

3310

operators except for the comma (<tt class="docutils literal">,</tt>) and <tt class="docutils literal">AS</tt> operators.

3311

A value of 100 will be higher or equal to all operators, and -100

3312

will be lower than or equal to all operators.

3313

3314

New in version 0.8: - added the ‘precedence’ argument.

3315

</div>

3316

</li>

3317

</ul>

3318

</td>

3319

</tr>

3320

</tbody>

3321

</table>

3322

3323

See also

3324

<a class="reference internal" href="types.html#types-operators">Redefining and Creating New Operators</a>

3325

</div>

3326

</dd></dl>

3327

3328

3329

3330

<tt class="descname">operate</tt><big>(</big>op, *other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.operate" title="Permalink to this definition">¶</a></dt>

3331

3332

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

3333

Operate on an argument.

3334

This is the lowest level of operation, raises

3335

<tt class="xref py py-class docutils literal">NotImplementedError</tt> by default.

3336

Overriding this on a subclass can allow common

3337

behavior to be applied to all operations.

3338

For example, overriding <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators" title="sqlalchemy.sql.operators.ColumnOperators"><tt class="xref py py-class docutils literal">ColumnOperators</tt></a>

3339

to apply <tt class="docutils literal">func.lower()</tt> to the left and right

3340

side:

3341

<div class="highlight-python"><div class="highlight"><pre>class MyComparator(ColumnOperators):

3342

def operate(self, op, other):

3343

return op(func.lower(self), func.lower(other))</pre></div>

3344

</div>

3345

3346

3347

3348

3349

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

3350

<li>op – Operator callable.</li>

3351

<li>*other – the ‘other’ side of the operation. Will

3352

be a single scalar for most operations.</li>

3353

<li>**kwargs – modifiers. These may be passed by special

3354

operators such as <tt class="xref py py-meth docutils literal">ColumnOperators.contains()</tt>.</li>

3355

</ul>

3356

</td>

3357

</tr>

3358

</tbody>

3359

</table>

3360

</dd></dl>

3361

3362

3363

3364

<tt class="descname">reverse_operate</tt><big>(</big>op, other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.reverse_operate" title="Permalink to this definition">¶</a></dt>

3365

3366

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

3367

Reverse operate on an argument.

3368

Usage is the same as <tt class="xref py py-meth docutils literal">operate()</tt>.

3369

</dd></dl>

3370

3371

3372

3373

<tt class="descname">startswith</tt><big>(</big>other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.startswith" title="Permalink to this definition">¶</a></dt>

3374

<dd>Implement the <tt class="docutils literal">startwith</tt> operator.

3375

In a column context, produces the clause <tt class="docutils literal">LIKE '<other>%'</tt>

3376

</dd></dl>

3377

3378

3379

3380

<tt class="descname">timetuple</tt> = None<a class="headerlink" href="#sqlalchemy.sql.operators.ColumnOperators.timetuple" title="Permalink to this definition">¶</a></dt>

3381

<dd>Hack, allows datetime objects to be compared on the LHS.

3382

</dd></dl>

3383

3384

</dd></dl>

3385

3386

3387

3388

class <tt class="descclassname">sqlalchemy.sql.operators.</tt><tt class="descname">custom_op</tt><big>(</big>opstring, precedence=0<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.custom_op" title="Permalink to this definition">¶</a></dt>

3389

<dd>Represent a ‘custom’ operator.

3390

<a class="reference internal" href="#sqlalchemy.sql.operators.custom_op" title="sqlalchemy.sql.operators.custom_op"><tt class="xref py py-class docutils literal">custom_op</tt></a> is normally instantitated when the

3391

<a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators.op" title="sqlalchemy.sql.operators.ColumnOperators.op"><tt class="xref py py-meth docutils literal">ColumnOperators.op()</tt></a> method is used to create a

3392

custom operator callable. The class can also be used directly

3393

when programmatically constructing expressions. E.g.

3394

to represent the “factorial” operation:

3395

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy.sql import UnaryExpression

3396

from sqlalchemy.sql import operators

3397

from sqlalchemy import Numeric

3398

3399

unary = UnaryExpression(table.c.somecolumn,

3400

modifier=operators.custom_op("!"),

3401

type_=Numeric)</pre></div>

3402

</div>

3403

</dd></dl>

3404

3405

3406

3407

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

3408

<dd>Base of comparison and logical operators.

3409

Implements base methods <tt class="xref py py-meth docutils literal">operate()</tt> and <tt class="xref py py-meth docutils literal">reverse_operate()</tt>,

3410

as well as <tt class="xref py py-meth docutils literal">__and__()</tt>, <tt class="xref py py-meth docutils literal">__or__()</tt>, <tt class="xref py py-meth docutils literal">__invert__()</tt>.

3411

Usually is used via its most common subclass

3412

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

3413

3414

3415

<tt class="descname">__and__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.Operators.__and__" title="Permalink to this definition">¶</a></dt>

3416

<dd>Implement the <tt class="docutils literal">&</tt> operator.

3417

When used with SQL expressions, results in an

3418

AND operation, equivalent to

3419

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

3420

3421

</div>

3422

is equivalent to:

3423

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

3424

and_(a, b)</pre></div>

3425

</div>

3426

Care should be taken when using <tt class="docutils literal">&</tt> regarding

3427

operator precedence; the <tt class="docutils literal">&</tt> operator has the highest precedence.

3428

The operands should be enclosed in parenthesis if they contain

3429

further sub expressions:

3430

3431

</div>

3432

</dd></dl>

3433

3434

3435

3436

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

3437

<dd>Implement the <tt class="docutils literal">~</tt> operator.

3438

When used with SQL expressions, results in a

3439

NOT operation, equivalent to

3440

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

3441

3442

</div>

3443

is equivalent to:

3444

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

3445

not_(a)</pre></div>

3446

</div>

3447

</dd></dl>

3448

3449

3450

3451

<tt class="descname">__or__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.Operators.__or__" title="Permalink to this definition">¶</a></dt>

3452

<dd>Implement the <tt class="docutils literal">|</tt> operator.

3453

When used with SQL expressions, results in an

3454

OR operation, equivalent to

3455

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

3456

3457

</div>

3458

is equivalent to:

3459

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

3460

or_(a, b)</pre></div>

3461

</div>

3462

Care should be taken when using <tt class="docutils literal">|</tt> regarding

3463

operator precedence; the <tt class="docutils literal">|</tt> operator has the highest precedence.

3464

The operands should be enclosed in parenthesis if they contain

3465

further sub expressions:

3466

3467

</div>

3468

</dd></dl>

3469

3470

3471

3472

<tt class="descname">__weakref__</tt><a class="headerlink" href="#sqlalchemy.sql.operators.Operators.__weakref__" title="Permalink to this definition">¶</a></dt>

3473

<dd>list of weak references to the object (if defined)

3474

</dd></dl>

3475

3476

3477

3478

<tt class="descname">op</tt><big>(</big>opstring, precedence=0<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.Operators.op" title="Permalink to this definition">¶</a></dt>

3479

<dd>produce a generic operator function.

3480

e.g.:

3481

<div class="highlight-python"><div class="highlight"><pre>somecolumn.op("*")(5)</pre></div>

3482

</div>

3483

produces:

3484

<div class="highlight-python"><div class="highlight"><pre>somecolumn * 5</pre></div>

3485

</div>

3486

This function can also be used to make bitwise operators explicit. For

3487

example:

3488

<div class="highlight-python"><div class="highlight"><pre>somecolumn.op('&')(0xff)</pre></div>

3489

</div>

3490

is a bitwise AND of the value in <tt class="docutils literal">somecolumn</tt>.

3491

3492

3493

3494

3495

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

3496

<li>operator – a string which will be output as the infix operator

3497

between this element and the expression passed to the

3498

generated function.</li>

3499

<li>precedence – precedence to apply to the operator, when

3500

parenthesizing expressions. A lower number will cause the expression

3501

to be parenthesized when applied against another operator with

3502

higher precedence. The default value of <tt class="docutils literal">0</tt> is lower than all

3503

operators except for the comma (<tt class="docutils literal">,</tt>) and <tt class="docutils literal">AS</tt> operators.

3504

A value of 100 will be higher or equal to all operators, and -100

3505

will be lower than or equal to all operators.

3506

3507

New in version 0.8: - added the ‘precedence’ argument.

3508

</div>

3509

</li>

3510

</ul>

3511

</td>

3512

</tr>

3513

</tbody>

3514

</table>

3515

3516

See also

3517

<a class="reference internal" href="types.html#types-operators">Redefining and Creating New Operators</a>

3518

</div>

3519

</dd></dl>

3520

3521

3522

3523

<tt class="descname">operate</tt><big>(</big>op, *other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.Operators.operate" title="Permalink to this definition">¶</a></dt>

3524

<dd>Operate on an argument.

3525

This is the lowest level of operation, raises

3526

<tt class="xref py py-class docutils literal">NotImplementedError</tt> by default.

3527

Overriding this on a subclass can allow common

3528

behavior to be applied to all operations.

3529

For example, overriding <a class="reference internal" href="#sqlalchemy.sql.operators.ColumnOperators" title="sqlalchemy.sql.operators.ColumnOperators"><tt class="xref py py-class docutils literal">ColumnOperators</tt></a>

3530

to apply <tt class="docutils literal">func.lower()</tt> to the left and right

3531

side:

3532

<div class="highlight-python"><div class="highlight"><pre>class MyComparator(ColumnOperators):

3533

def operate(self, op, other):

3534

return op(func.lower(self), func.lower(other))</pre></div>

3535

</div>

3536

3537

3538

3539

3540

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

3541

<li>op – Operator callable.</li>

3542

<li>*other – the ‘other’ side of the operation. Will

3543

be a single scalar for most operations.</li>

3544

<li>**kwargs – modifiers. These may be passed by special

3545

operators such as <tt class="xref py py-meth docutils literal">ColumnOperators.contains()</tt>.</li>

3546

</ul>

3547

</td>

3548

</tr>

3549

</tbody>

3550

</table>

3551

</dd></dl>

3552

3553

3554

3555

<tt class="descname">reverse_operate</tt><big>(</big>op, other, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.sql.operators.Operators.reverse_operate" title="Permalink to this definition">¶</a></dt>

3556

<dd>Reverse operate on an argument.

3557

Usage is the same as <tt class="xref py py-meth docutils literal">operate()</tt>.

3558

</dd></dl>

3559

3560

</dd></dl>

3561

3562

3563

3564

class <tt class="descclassname">sqlalchemy.sql.expression.</tt><tt class="descname">UnaryExpression</tt><big>(</big>element, operator=None, modifier=None, type_=None, negate=None<big>)</big><a class="headerlink" href="#sqlalchemy.sql.expression.UnaryExpression" title="Permalink to this definition">¶</a></dt>

3565

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

3566

Define a ‘unary’ expression.

3567

A unary expression has a single column expression

3568

and an operator. The operator can be placed on the left

3569

(where it is called the ‘operator’) or right (where it is called the

3570

‘modifier’) of the column expression.

3571

3572

3573

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

3574

<dd>Compare this <a class="reference internal" href="#sqlalchemy.sql.expression.UnaryExpression" title="sqlalchemy.sql.expression.UnaryExpression"><tt class="xref py py-class docutils literal">UnaryExpression</tt></a> against the given

3575

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

3576

</dd></dl>

3577

3578

</dd></dl>

3579

3580

</div>

3581

3582

</div>

3583

3584

</div>

3585

3586

3587

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

3589

<a href="selectable.html" title="next chapter">Selectables, Tables, FROM objects</a>

3591

3592

3593

3594

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2b1.

3595

</div>

3596

</div>

3597

3598

</div>

3599

3600

3601

</body>

3602

</html>

3603

3604