~ubuntu-branches/debian/jessie/sqlalchemy/jessie

ongoing <a class="reference internal" href="#sqlalchemy.engine.Transaction" title="sqlalchemy.engine.Transaction"><tt class="xref py py-class docutils literal">Transaction</tt></a>.

352

Full control of the “autocommit” behavior is available using the generative

353

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

354

<a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a>, <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a>, using the “autocommit” flag which will

354

<a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a>, <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>, using the “autocommit” flag which will

355

turn on or off the autocommit for the selected scope. For example, a

356

<a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a> construct representing a stored procedure that commits might use

356

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a> construct representing a stored procedure that commits might use

357

it so that a SELECT statement will issue a COMMIT:

358

<div class="highlight-python"><div class="highlight"><pre>engine.execute(text("SELECT my_mutating_procedure()").execution_options(autocommit=True))</pre></div>

359

</div>

370

print "username:", row['username']</pre></div>

371

</div>

372

In addition to “connectionless” execution, it is also possible

373

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

374

any <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a> construct, which is a marker for SQL expression objects

373

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

374

any <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> construct, which is a marker for SQL expression objects

375

that support execution. The SQL expression object itself references an

376

<a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> or <a class="reference internal" href="#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a> known as the bind, which it uses

377

in order to provide so-called “implicit” execution services.

401

# ....

402

result.close()</pre></div>

403

</div>

404

Implicit execution is also connectionless, and makes usage of the <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.Executable.execute" title="sqlalchemy.sql.expression.Executable.execute"><tt class="xref py py-meth docutils literal">execute()</tt></a> method

404

Implicit execution is also connectionless, and makes usage of the <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Executable.execute" title="sqlalchemy.sql.expression.Executable.execute"><tt class="xref py py-meth docutils literal">execute()</tt></a> method

405

on the expression itself. This method is provided as part of the

406

<a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a> class, which refers to a SQL statement that is sufficient

406

<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> class, which refers to a SQL statement that is sufficient

407

for being invoked against the database. The method makes usage of

408

the assumption that either an

409

<a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> or

410

411

object. By “bound” we mean that the special attribute <a class="reference internal" href="schema.html#sqlalchemy.schema.MetaData.bind" title="sqlalchemy.schema.MetaData.bind"><tt class="xref py py-attr docutils literal">MetaData.bind</tt></a>

411

object. By “bound” we mean that the special attribute <a class="reference internal" href="metadata.html#sqlalchemy.schema.MetaData.bind" title="sqlalchemy.schema.MetaData.bind"><tt class="xref py py-attr docutils literal">MetaData.bind</tt></a>

412

has been used to associate a series of

413

<a class="reference internal" href="schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> objects and all SQL constructs derived from them with a specific

413

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> objects and all SQL constructs derived from them with a specific

414

engine:

415

<div class="highlight-python"><pre>engine = create_engine('sqlite:///file.db')

416

meta.bind = engine

419

# ....

420

result.close()</pre>

421

</div>

422

Above, we associate an <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> with a <a class="reference internal" href="schema.html#sqlalchemy.schema.MetaData" title="sqlalchemy.schema.MetaData"><tt class="xref py py-class docutils literal">MetaData</tt></a> object using

423

the special attribute <a class="reference internal" href="schema.html#sqlalchemy.schema.MetaData.bind" title="sqlalchemy.schema.MetaData.bind"><tt class="xref py py-attr docutils literal">MetaData.bind</tt></a>. The <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.select" title="sqlalchemy.sql.expression.select"><tt class="xref py py-func docutils literal">select()</tt></a> construct produced

424

from the <a class="reference internal" href="schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> object has a method <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.Executable.execute" title="sqlalchemy.sql.expression.Executable.execute"><tt class="xref py py-meth docutils literal">execute()</tt></a>, which will

425

search for an <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> that’s “bound” to the <a class="reference internal" href="schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>.

422

Above, we associate an <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> with a <a class="reference internal" href="metadata.html#sqlalchemy.schema.MetaData" title="sqlalchemy.schema.MetaData"><tt class="xref py py-class docutils literal">MetaData</tt></a> object using

423

the special attribute <a class="reference internal" href="metadata.html#sqlalchemy.schema.MetaData.bind" title="sqlalchemy.schema.MetaData.bind"><tt class="xref py py-attr docutils literal">MetaData.bind</tt></a>. The <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 produced

424

from the <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> object has a method <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Executable.execute" title="sqlalchemy.sql.expression.Executable.execute"><tt class="xref py py-meth docutils literal">execute()</tt></a>, which will

425

search for an <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> that’s “bound” to the <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>.

426

Overall, the usage of “bound metadata” has three general effects:

427

428

<li>SQL statement objects gain an <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.Executable.execute" title="sqlalchemy.sql.expression.Executable.execute"><tt class="xref py py-meth docutils literal">Executable.execute()</tt></a> method which automatically

428

<li>SQL statement objects gain an <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Executable.execute" title="sqlalchemy.sql.expression.Executable.execute"><tt class="xref py py-meth docutils literal">Executable.execute()</tt></a> method which automatically

429

locates a “bind” with which to execute themselves.</li>

430

<li>The ORM <a class="reference internal" href="../orm/session.html#sqlalchemy.orm.session.Session" title="sqlalchemy.orm.session.Session"><tt class="xref py py-class docutils literal">Session</tt></a> object supports using “bound metadata” in order

431

to establish which <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> should be used to invoke SQL statements

432

on behalf of a particular mapped class, though the <a class="reference internal" href="../orm/session.html#sqlalchemy.orm.session.Session" title="sqlalchemy.orm.session.Session"><tt class="xref py py-class docutils literal">Session</tt></a>

433

also features its own explicit system of establishing complex <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a>/

434

mapped class configurations.</li>

435

<li>The <a class="reference internal" href="schema.html#sqlalchemy.schema.MetaData.create_all" title="sqlalchemy.schema.MetaData.create_all"><tt class="xref py py-meth docutils literal">MetaData.create_all()</tt></a>, <a class="reference internal" href="schema.html#sqlalchemy.schema.MetaData.drop_all" title="sqlalchemy.schema.MetaData.drop_all"><tt class="xref py py-meth docutils literal">MetaData.drop_all()</tt></a>, <a class="reference internal" href="schema.html#sqlalchemy.schema.Table.create" title="sqlalchemy.schema.Table.create"><tt class="xref py py-meth docutils literal">Table.create()</tt></a>,

436

<a class="reference internal" href="schema.html#sqlalchemy.schema.Table.drop" title="sqlalchemy.schema.Table.drop"><tt class="xref py py-meth docutils literal">Table.drop()</tt></a>, and “autoload” features all make usage of the bound

435

<li>The <a class="reference internal" href="metadata.html#sqlalchemy.schema.MetaData.create_all" title="sqlalchemy.schema.MetaData.create_all"><tt class="xref py py-meth docutils literal">MetaData.create_all()</tt></a>, <a class="reference internal" href="metadata.html#sqlalchemy.schema.MetaData.drop_all" title="sqlalchemy.schema.MetaData.drop_all"><tt class="xref py py-meth docutils literal">MetaData.drop_all()</tt></a>, <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table.create" title="sqlalchemy.schema.Table.create"><tt class="xref py py-meth docutils literal">Table.create()</tt></a>,

436

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Table.drop" title="sqlalchemy.schema.Table.drop"><tt class="xref py py-meth docutils literal">Table.drop()</tt></a>, and “autoload” features all make usage of the bound

437

438

</ul>

439

443

are never necessary.

444

In applications where multiple <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> objects are present, each one logically associated

445

with a certain set of tables (i.e. vertical sharding), the “bound metadata” technique can be used

446

so that individual <a class="reference internal" href="schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> can refer to the appropriate <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> automatically;

446

so that individual <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> can refer to the appropriate <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a> automatically;

447

in particular this is supported within the ORM via the <a class="reference internal" href="../orm/session.html#sqlalchemy.orm.session.Session" title="sqlalchemy.orm.session.Session"><tt class="xref py py-class docutils literal">Session</tt></a> object

448

as a means to associate <a class="reference internal" href="schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> objects with an appropriate <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a>,

448

as a means to associate <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> objects with an appropriate <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a>,

449

as an alternative to using the bind arguments accepted directly by the <a class="reference internal" href="../orm/session.html#sqlalchemy.orm.session.Session" title="sqlalchemy.orm.session.Session"><tt class="xref py py-class docutils literal">Session</tt></a>.

450

However, the “implicit execution” technique is not at all appropriate for use with the

451

ORM, as it bypasses the transactional context maintained by the <a class="reference internal" href="../orm/session.html#sqlalchemy.orm.session.Session" title="sqlalchemy.orm.session.Session"><tt class="xref py py-class docutils literal">Session</tt></a>.

458

Modern SQLAlchemy usage, especially the ORM, places a heavy stress on working within the context

459

of a transaction at all times; the “implicit execution” concept makes the job of

460

associating statement execution with a particular transaction much more difficult.

461

The <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.Executable.execute" title="sqlalchemy.sql.expression.Executable.execute"><tt class="xref py py-meth docutils literal">Executable.execute()</tt></a> method on a particular SQL statement

461

The <a class="reference internal" href="selectable.html#sqlalchemy.sql.expression.Executable.execute" title="sqlalchemy.sql.expression.Executable.execute"><tt class="xref py py-meth docutils literal">Executable.execute()</tt></a> method on a particular SQL statement

462

usually implies that the execution is not part of any particular transaction, which is

463

usually not the desired effect.

464

</div>

580

</div>

581

The above will respond to <tt class="docutils literal">create_engine("mysql+foodialect://")</tt> and load the

582

<tt class="docutils literal">MyMySQLDialect</tt> class from the <tt class="docutils literal">myapp.dialect</tt> module.

583

584

New in version 0.8.

583

584

New in version 0.8.

585

</div>

585

586

</div>

586

587

</div>

587

588

589

590

590

591

591

592

class <tt class="descclassname">sqlalchemy.engine.</tt><tt class="descname">Connection</tt><big>(</big>engine, connection=None, close_with_result=False, _branch=False, _execution_options=None, _dispatch=None, _has_events=False<big>)</big><a class="headerlink" href="#sqlalchemy.engine.Connection" title="Permalink to this definition">¶</a></dt>

592

<dd>Bases: <tt class="xref py py-class docutils literal">sqlalchemy.engine.interfaces.Connectable</tt>

593

594

Provides high-level functionality for a wrapped DB-API connection.

594

595

Provides execution support for string-based SQL statements as well as

595

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

596

<a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a>, <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> and <a class="reference internal" href="defaults.html#sqlalchemy.schema.DefaultGenerator" title="sqlalchemy.schema.DefaultGenerator"><tt class="xref py py-class docutils literal">DefaultGenerator</tt></a>

596

597

objects. Provides a <a class="reference internal" href="#sqlalchemy.engine.Connection.begin" title="sqlalchemy.engine.Connection.begin"><tt class="xref py py-meth docutils literal">begin()</tt></a> method to return <a class="reference internal" href="#sqlalchemy.engine.Transaction" title="sqlalchemy.engine.Transaction"><tt class="xref py py-class docutils literal">Transaction</tt></a>

597

598

objects.

598

599

The Connection object is not thread-safe. While a Connection can be

764

765

one of:

765

766

<ul>

766

767

<li>a plain string</li>

767

<li>any <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.ClauseElement" title="sqlalchemy.sql.expression.ClauseElement"><tt class="xref py py-class docutils literal">ClauseElement</tt></a> construct that is also

768

a subclass of <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.Executable" title="sqlalchemy.sql.expression.Executable"><tt class="xref py py-class docutils literal">Executable</tt></a>, such as a

769

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

770

<li>a <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.FunctionElement" title="sqlalchemy.sql.expression.FunctionElement"><tt class="xref py py-class docutils literal">FunctionElement</tt></a>, such as that generated

768

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

769

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

770

<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</li>

771

<li>a <tt class="xref py py-class docutils literal">FunctionElement</tt>, such as that generated

771

772

by <tt class="xref py py-attr docutils literal">func</tt>, will be automatically wrapped in

772

773

a SELECT statement, which is then executed.</li>

773

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

774

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

774

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

775

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

775

776

<li>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</li>

776

777

</ul>

777

778

</li>

809

810

“numeric”. See <a class="reference external" href="http://www.python.org/dev/peps/pep-0249/">pep-249</a>

810

811

for details on paramstyle.

811

812

To execute a textual SQL statement which uses bound parameters in a

812

DBAPI-agnostic way, use the <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a> construct.

813

DBAPI-agnostic way, use the <a class="reference internal" href="sqlelement.html#sqlalchemy.sql.expression.text" title="sqlalchemy.sql.expression.text"><tt class="xref py py-func docutils literal">text()</tt></a> construct.

813

814

</li>

814

815

</ul>

815

816

</td>

838

839

is suitable for usage by end-user schemes to communicate with

839

840

event listeners, for example.

840

841

The keywords that are currently recognized by SQLAlchemy itself

841

include all those listed under <a class="reference internal" href="expression_api.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>,

842

include all those listed under <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>,

842

843

as well as others that are specific to <a class="reference internal" href="#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a>.

843

844

844

845

900

901

that is neutral regarding whether it’s executed by the DBAPI

901

902

or piped into a script that’s later invoked by

902

903

command line tools.

903

904

New in version 0.7.6.

904

905

New in version 0.7.6.

906

</div>

905

907

</li>

906

908

<li>stream_results – Available on: Connection, statement.

907

909

Indicate to the dialect that results should be

1019

1021

1020

1022

1021

1023

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

1022

<dd>Bases: <tt class="xref py py-class docutils literal">object</tt>

1023

Interface for an object which supports execution of SQL constructs.

1024

<dd>Interface for an object which supports execution of SQL constructs.

1024

1025

The two implementations of <a class="reference internal" href="#sqlalchemy.engine.Connectable" title="sqlalchemy.engine.Connectable"><tt class="xref py py-class docutils literal">Connectable</tt></a> are

1025

1026

<a class="reference internal" href="#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a> and <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a>.

1026

1027

Connectable must also implement the ‘dialect’ member which references a

1050

1051

1051

1052

<tt class="descname">create</tt><big>(</big>entity, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.engine.Connectable.create" title="Permalink to this definition">¶</a></dt>

1052

1053

<dd>Emit CREATE statements for the given schema entity.

1053

1054

Deprecated since version 0.7: Use the create() method on the given schema object directly, i.e. <a class="reference internal" href="schema.html#sqlalchemy.schema.Table.create" title="sqlalchemy.schema.Table.create"><tt class="xref py py-meth docutils literal">Table.create()</tt></a>, <a class="reference internal" href="schema.html#sqlalchemy.schema.Index.create" title="sqlalchemy.schema.Index.create"><tt class="xref py py-meth docutils literal">Index.create()</tt></a>, <a class="reference internal" href="schema.html#sqlalchemy.schema.MetaData.create_all" title="sqlalchemy.schema.MetaData.create_all"><tt class="xref py py-meth docutils literal">MetaData.create_all()</tt></a>

1054

1055

Deprecated since version 0.7: Use the create() method on the given schema object directly, i.e. <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table.create" title="sqlalchemy.schema.Table.create"><tt class="xref py py-meth docutils literal">Table.create()</tt></a>, <a class="reference internal" href="constraints.html#sqlalchemy.schema.Index.create" title="sqlalchemy.schema.Index.create"><tt class="xref py py-meth docutils literal">Index.create()</tt></a>, <a class="reference internal" href="metadata.html#sqlalchemy.schema.MetaData.create_all" title="sqlalchemy.schema.MetaData.create_all"><tt class="xref py py-meth docutils literal">MetaData.create_all()</tt></a>

1056

</div>

1055

1057

</dd></dl>

1056

1058

1057

1059

1058

1060

1059

1061

<tt class="descname">drop</tt><big>(</big>entity, **kwargs<big>)</big><a class="headerlink" href="#sqlalchemy.engine.Connectable.drop" title="Permalink to this definition">¶</a></dt>

1060

1062

<dd>Emit DROP statements for the given schema entity.

1061

1062

Deprecated since version 0.7: Use the drop() method on the given schema object directly, i.e. <a class="reference internal" href="schema.html#sqlalchemy.schema.Table.drop" title="sqlalchemy.schema.Table.drop"><tt class="xref py py-meth docutils literal">Table.drop()</tt></a>, <a class="reference internal" href="schema.html#sqlalchemy.schema.Index.drop" title="sqlalchemy.schema.Index.drop"><tt class="xref py py-meth docutils literal">Index.drop()</tt></a>, <a class="reference internal" href="schema.html#sqlalchemy.schema.MetaData.drop_all" title="sqlalchemy.schema.MetaData.drop_all"><tt class="xref py py-meth docutils literal">MetaData.drop_all()</tt></a>

1063

1064

Deprecated since version 0.7: Use the drop() method on the given schema object directly, i.e. <a class="reference internal" href="metadata.html#sqlalchemy.schema.Table.drop" title="sqlalchemy.schema.Table.drop"><tt class="xref py py-meth docutils literal">Table.drop()</tt></a>, <a class="reference internal" href="constraints.html#sqlalchemy.schema.Index.drop" title="sqlalchemy.schema.Index.drop"><tt class="xref py py-meth docutils literal">Index.drop()</tt></a>, <a class="reference internal" href="metadata.html#sqlalchemy.schema.MetaData.drop_all" title="sqlalchemy.schema.MetaData.drop_all"><tt class="xref py py-meth docutils literal">MetaData.drop_all()</tt></a>

1065

</div>

1063

1066

</dd></dl>

1064

1067

1065

1068

1080

1083

1081

1084

1082

1085

class <tt class="descclassname">sqlalchemy.engine.</tt><tt class="descname">Engine</tt><big>(</big>pool, dialect, url, logging_name=None, echo=None, proxy=None, execution_options=None<big>)</big><a class="headerlink" href="#sqlalchemy.engine.Engine" title="Permalink to this definition">¶</a></dt>

1083

<dd>Bases: <tt class="xref py py-class docutils literal">sqlalchemy.engine.interfaces.Connectable</tt>, <tt class="xref py py-class docutils literal">sqlalchemy.log.Identified</tt>

1086

<dd>Bases: <a class="reference internal" href="#sqlalchemy.engine.Connectable" title="sqlalchemy.engine.Connectable"><tt class="xref py py-class docutils literal">sqlalchemy.engine.Connectable</tt></a>, <tt class="xref py py-class docutils literal">sqlalchemy.log.Identified</tt>

1084

1087

Connects a <a class="reference internal" href="pooling.html#sqlalchemy.pool.Pool" title="sqlalchemy.pool.Pool"><tt class="xref py py-class docutils literal">Pool</tt></a> and

1085

1088

<a class="reference internal" href="internals.html#sqlalchemy.engine.interfaces.Dialect" title="sqlalchemy.engine.interfaces.Dialect"><tt class="xref py py-class docutils literal">Dialect</tt></a> together to provide a

1086

1089

source of database connectivity and behavior.

1109

1112

<a class="reference internal" href="#sqlalchemy.engine.ResultProxy" title="sqlalchemy.engine.ResultProxy"><tt class="xref py py-class docutils literal">ResultProxy</tt></a> returned by the first call to

1110

1113

<a class="reference internal" href="#sqlalchemy.engine.Connection.execute" title="sqlalchemy.engine.Connection.execute"><tt class="xref py py-meth docutils literal">Connection.execute()</tt></a> will close the <a class="reference internal" href="#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a> when

1111

1114

that <a class="reference internal" href="#sqlalchemy.engine.ResultProxy" title="sqlalchemy.engine.ResultProxy"><tt class="xref py py-class docutils literal">ResultProxy</tt></a> has exhausted all result rows.

1112

1113

New in version 0.7.6.

1115

1116

New in version 0.7.6.

1117

</div>

1114

1118

See also:

1115

1119

<a class="reference internal" href="#sqlalchemy.engine.Engine.connect" title="sqlalchemy.engine.Engine.connect"><tt class="xref py py-meth docutils literal">Engine.connect()</tt></a> - procure a <a class="reference internal" href="#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a> from

1116

1120

an <a class="reference internal" href="#sqlalchemy.engine.Engine" title="sqlalchemy.engine.Engine"><tt class="xref py py-class docutils literal">Engine</tt></a>.

1253

1257

cursor.execute("use %s" % shards[shard_id])

1254

1258

conn.info["current_shard"] = shard_id</pre></div>

1255

1259

</div>

1256

1257

New in version 0.8.

1258

1260

1261

New in version 0.8.

1262

</div>

1263

1259

1264

See also

1260

1265

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

1261

1266

on a <a class="reference internal" href="#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a> object.

1365

1370

all connections. The initial contents of this dictionary

1366

1371

can be sent via the <tt class="docutils literal">execution_options</tt> parameter

1367

1372

to <a class="reference internal" href="engines.html#sqlalchemy.create_engine" title="sqlalchemy.create_engine"><tt class="xref py py-func docutils literal">create_engine()</tt></a>.

1368

1373

1369

1374

See also

1370

1375

1371

1376

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

1456

1461

The return value is a list of scalar values

1457

1462

corresponding to the list of primary key columns

1458

1463

in the target table.

1459

This only applies to single row <a class="reference internal" href="expression_api.html#sqlalchemy.sql.expression.insert" title="sqlalchemy.sql.expression.insert"><tt class="xref py py-func docutils literal">insert()</tt></a>

1464

This only applies to single row <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>

1460

1465

constructs which did not explicitly specify

1461

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

1466

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

1462

1467

Note that primary key columns which specify a

1463

1468

server_default clause,

1464

1469

or otherwise do not qualify as “autoincrement”

1465

columns (see the notes at <a class="reference internal" href="schema.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a>), and were

1470

columns (see the notes at <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>), and were

1466

1471

generated using the database-side default, will

1467

1472

appear in this list as <tt class="docutils literal">None</tt> unless the backend

1468

1473

supports “returning” and the insert statement executed

1477

1482

<tt class="descname">is_insert</tt><a class="headerlink" href="#sqlalchemy.engine.ResultProxy.is_insert" title="Permalink to this definition">¶</a></dt>

1478

1483

<dd>True if this <a class="reference internal" href="#sqlalchemy.engine.ResultProxy" title="sqlalchemy.engine.ResultProxy"><tt class="xref py py-class docutils literal">ResultProxy</tt></a> is the result

1479

1484

of a executing an expression language compiled

1480

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

1485

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

1481

1486

When True, this implies that the

1482

1487

<a class="reference internal" href="#sqlalchemy.engine.ResultProxy.inserted_primary_key" title="sqlalchemy.engine.ResultProxy.inserted_primary_key"><tt class="xref py py-attr docutils literal">inserted_primary_key</tt></a> attribute is accessible,

1483

1488

assuming the statement did not include

1629

1634

1630

1635

1631

1636

class <tt class="descclassname">sqlalchemy.engine.</tt><tt class="descname">RowProxy</tt><big>(</big>parent, row, processors, keymap<big>)</big><a class="headerlink" href="#sqlalchemy.engine.RowProxy" title="Permalink to this definition">¶</a></dt>

1632

<dd>Proxy values from a single cursor row.

1637

<dd>Bases: <tt class="xref py py-class docutils literal">sqlalchemy.engine.result.BaseRowProxy</tt>

1638

Proxy values from a single cursor row.

1633

1639

Mostly follows “ordered dictionary” behavior, mapping result

1634

1640

values to the string-based column name, the integer position of

1635

1641

the result in the row, as well as Column instances which can be

1658

1664

1659

1665

1660

1666

class <tt class="descclassname">sqlalchemy.engine.</tt><tt class="descname">Transaction</tt><big>(</big>connection, parent<big>)</big><a class="headerlink" href="#sqlalchemy.engine.Transaction" title="Permalink to this definition">¶</a></dt>

1661

<dd>Bases: <tt class="xref py py-class docutils literal">object</tt>

1662

Represent a database transaction in progress.

1667

<dd>Represent a database transaction in progress.

1663

1668

The <a class="reference internal" href="#sqlalchemy.engine.Transaction" title="sqlalchemy.engine.Transaction"><tt class="xref py py-class docutils literal">Transaction</tt></a> object is procured by

1664

1669

calling the <a class="reference internal" href="#sqlalchemy.engine.Connection.begin" title="sqlalchemy.engine.Connection.begin"><tt class="xref py py-meth docutils literal">begin()</tt></a> method of

1665

1670

<a class="reference internal" href="#sqlalchemy.engine.Connection" title="sqlalchemy.engine.Connection"><tt class="xref py py-class docutils literal">Connection</tt></a>:

1739

1744

1740

1745

1741

1746

1742

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.

1747

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2b1.

1743

1748

</div>

1744

1749

</div>

1745

1750

Older »