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

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

162

<dd>Available events for <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>.

163

<dd>Bases: <tt class="xref py py-class docutils literal">sqlalchemy.event.Events</tt>

164

Available events for <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>.

163

165

The methods here define the name of an event as well

164

166

as the names of members that are passed to listener

165

167

functions.

288

290

</tr>

289

291

</tbody>

290

292

</table>

291

292

New in version 0.8.

293

293

294

New in version 0.8.

295

</div>

296

294

297

See also

295

298

<a class="reference internal" href="#sqlalchemy.events.ConnectionEvents.rollback" title="sqlalchemy.events.ConnectionEvents.rollback"><tt class="xref py py-meth docutils literal">ConnectionEvents.rollback()</tt></a>

296

299

<a class="reference internal" href="#sqlalchemy.events.ConnectionEvents.commit" title="sqlalchemy.events.ConnectionEvents.commit"><tt class="xref py py-meth docutils literal">ConnectionEvents.commit()</tt></a>

305

308

306

309

307

310

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

308

<dd>Available events for <a class="reference internal" href="connections.html#sqlalchemy.engine.Connectable" title="sqlalchemy.engine.Connectable"><tt class="xref py py-class docutils literal">Connectable</tt></a>, which includes

311

<dd>Bases: <tt class="xref py py-class docutils literal">sqlalchemy.event.Events</tt>

312

Available events for <a class="reference internal" href="connections.html#sqlalchemy.engine.Connectable" title="sqlalchemy.engine.Connectable"><tt class="xref py py-class docutils literal">Connectable</tt></a>, which includes

309

313

<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> and <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>.

310

314

The methods here define the name of an event as well as the names of

311

315

members that are passed to listener functions.

372

376

</tr>

373

377

</tbody>

374

378

</table>

375

376

Changed in version 0.8: <a class="reference internal" href="#sqlalchemy.events.ConnectionEvents" title="sqlalchemy.events.ConnectionEvents"><tt class="xref py py-class docutils literal">ConnectionEvents</tt></a> can now be associated

379

380

Changed in version 0.8: <a class="reference internal" href="#sqlalchemy.events.ConnectionEvents" title="sqlalchemy.events.ConnectionEvents"><tt class="xref py py-class docutils literal">ConnectionEvents</tt></a> can now be associated

377

381

with any <a class="reference internal" href="connections.html#sqlalchemy.engine.Connectable" title="sqlalchemy.engine.Connectable"><tt class="xref py py-class docutils literal">Connectable</tt></a> including <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>,

378

382

in addition to the existing support for <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>.

383

</div>

379

384

380

385

381

386

<tt class="descname">after_cursor_execute</tt><big>(</big>conn, cursor, statement, parameters, context, executemany<big>)</big><a class="headerlink" href="#sqlalchemy.events.ConnectionEvents.after_cursor_execute" title="Permalink to this definition">¶</a></dt>

620

625

</tr>

621

626

</tbody>

622

627

</table>

623

624

New in version 0.7.7.

628

629

New in version 0.7.7.

630

</div>

625

631

</dd></dl>

626

632

627

633

679

685

</tr>

680

686

</tbody>

681

687

</table>

682

688

683

689

See also

684

690

<a class="reference internal" href="#sqlalchemy.events.PoolEvents.reset" title="sqlalchemy.events.PoolEvents.reset"><tt class="xref py py-meth docutils literal">PoolEvents.reset()</tt></a>

685

691

</div>

750

756

751

757

752

758

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

753

<dd>Define event listeners for schema objects,

754

that is, <a class="reference internal" href="schema.html#sqlalchemy.schema.SchemaItem" title="sqlalchemy.schema.SchemaItem"><tt class="xref py py-class docutils literal">SchemaItem</tt></a> and <tt class="xref py py-class docutils literal">SchemaEvent</tt>

755

subclasses, including <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>, <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>,

756

<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>.

757

<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> and <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> support events

759

<dd>Bases: <tt class="xref py py-class docutils literal">sqlalchemy.event.Events</tt>

760

Define event listeners for schema objects,

761

that is, <a class="reference internal" href="metadata.html#sqlalchemy.schema.SchemaItem" title="sqlalchemy.schema.SchemaItem"><tt class="xref py py-class docutils literal">SchemaItem</tt></a> and <tt class="xref py py-class docutils literal">SchemaEvent</tt>

762

subclasses, including <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>, <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>,

763

<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>.

764

<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> and <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> support events

758

765

specifically regarding when CREATE and DROP

759

766

DDL is emitted to the database.

760

767

Attachment events are also provided to customize

761

768

behavior whenever a child schema element is associated

762

with a parent, such as, when a <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> is associated

763

with its <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>, when a <a class="reference internal" href="schema.html#sqlalchemy.schema.ForeignKeyConstraint" title="sqlalchemy.schema.ForeignKeyConstraint"><tt class="xref py py-class docutils literal">ForeignKeyConstraint</tt></a>

764

is associated with a <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>, etc.

769

with a parent, such as, when 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> is associated

770

with its <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>, when a <a class="reference internal" href="constraints.html#sqlalchemy.schema.ForeignKeyConstraint" title="sqlalchemy.schema.ForeignKeyConstraint"><tt class="xref py py-class docutils literal">ForeignKeyConstraint</tt></a>

771

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

765

772

Example using the <tt class="docutils literal">after_create</tt> event:

766

773

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

767

774

from sqlalchemy import Table, Column, Metadata, Integer

776

783

event.listen(some_table, "after_create", after_create)</pre></div>

777

784

</div>

778

785

DDL events integrate closely with the

779

<a class="reference internal" href="schema.html#sqlalchemy.schema.DDL" title="sqlalchemy.schema.DDL"><tt class="xref py py-class docutils literal">DDL</tt></a> class and the <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> hierarchy

786

<a class="reference internal" href="ddl.html#sqlalchemy.schema.DDL" title="sqlalchemy.schema.DDL"><tt class="xref py py-class docutils literal">DDL</tt></a> class and the <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> hierarchy

780

787

of DDL clause constructs, which are themselves appropriate

781

788

as listener callables:

782

789

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

792

799

See also:

793

800

794

801

<div><a class="reference internal" href="event.html">Events</a>

795

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

796

797

<a class="reference internal" href="schema.html#schema-ddl-sequences">Controlling DDL Sequences</a>

802

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

803

804

<a class="reference internal" href="ddl.html#schema-ddl-sequences">Controlling DDL Sequences</a>

798

805

</div></blockquote>

799

806

800

807

805

812

806

813

807

814

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

808

<li>target – the <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> or <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>

815

<li>target – the <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> or <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>

809

816

object which is the target of the event.</li>

810

817

<li>connection – the <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> where the

811

818

CREATE statement or statements have been emitted.</li>

831

838

832

839

833

840

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

834

841

835

842

object which is the target of the event.</li>

836

843

837

844

DROP statement or statements have been emitted.</li>

851

858

852

859

853

860

<tt class="descname">after_parent_attach</tt><big>(</big>target, parent<big>)</big><a class="headerlink" href="#sqlalchemy.events.DDLEvents.after_parent_attach" title="Permalink to this definition">¶</a></dt>

854

<dd>Called after a <a class="reference internal" href="schema.html#sqlalchemy.schema.SchemaItem" title="sqlalchemy.schema.SchemaItem"><tt class="xref py py-class docutils literal">SchemaItem</tt></a> is associated with

855

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

861

<dd>Called after a <a class="reference internal" href="metadata.html#sqlalchemy.schema.SchemaItem" title="sqlalchemy.schema.SchemaItem"><tt class="xref py py-class docutils literal">SchemaItem</tt></a> is associated with

862

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

856

863

857

864

858

865

873

880

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">propagate=False – When True, the listener function will

874

881

be established for any copies made of the target object,

875

882

i.e. those copies that are generated when

876

<a class="reference internal" href="schema.html#sqlalchemy.schema.Table.tometadata" title="sqlalchemy.schema.Table.tometadata"><tt class="xref py py-meth docutils literal">Table.tometadata()</tt></a> is used.</td>

883

<a class="reference internal" href="metadata.html#sqlalchemy.schema.Table.tometadata" title="sqlalchemy.schema.Table.tometadata"><tt class="xref py py-meth docutils literal">Table.tometadata()</tt></a> is used.</td>

877

884

</tr>

878

885

</tbody>

879

886

</table>

888

895

889

896

890

897

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

891

898

892

899

object which is the target of the event.</li>

893

900

894

901

CREATE statement or statements will be emitted.</li>

914

921

915

922

916

923

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

917

924

918

925

object which is the target of the event.</li>

919

926

920

927

DROP statement or statements will be emitted.</li>

934

941

935

942

936

943

<tt class="descname">before_parent_attach</tt><big>(</big>target, parent<big>)</big><a class="headerlink" href="#sqlalchemy.events.DDLEvents.before_parent_attach" title="Permalink to this definition">¶</a></dt>

937

<dd>Called before a <a class="reference internal" href="schema.html#sqlalchemy.schema.SchemaItem" title="sqlalchemy.schema.SchemaItem"><tt class="xref py py-class docutils literal">SchemaItem</tt></a> is associated with

938

944

<dd>Called before a <a class="reference internal" href="metadata.html#sqlalchemy.schema.SchemaItem" title="sqlalchemy.schema.SchemaItem"><tt class="xref py py-class docutils literal">SchemaItem</tt></a> is associated with

945

939

946

940

947

941

948

956

963

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">propagate=False – When True, the listener function will

957

964

be established for any copies made of the target object,

958

965

i.e. those copies that are generated when

959

966

960

967

</tr>

961

968

</tbody>

962

969

</table>

966

973

967

974

<tt class="descname">column_reflect</tt><big>(</big>inspector, table, column_info<big>)</big><a class="headerlink" href="#sqlalchemy.events.DDLEvents.column_reflect" title="Permalink to this definition">¶</a></dt>

968

975

<dd>Called for each unit of ‘column info’ retrieved when

969

a <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> is being reflected.

976

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

970

977

The dictionary of column information as returned by the

971

978

dialect is passed, and can be modified. The dictionary

972

979

is that returned in each element of the list returned

973

by <a class="reference internal" href="schema.html#sqlalchemy.engine.reflection.Inspector.get_columns" title="sqlalchemy.engine.reflection.Inspector.get_columns"><tt class="xref py py-meth docutils literal">reflection.Inspector.get_columns()</tt></a>.

980

by <a class="reference internal" href="reflection.html#sqlalchemy.engine.reflection.Inspector.get_columns" title="sqlalchemy.engine.reflection.Inspector.get_columns"><tt class="xref py py-meth docutils literal">reflection.Inspector.get_columns()</tt></a>.

974

981

The event is called before any action is taken against

975

982

this dictionary, and the contents can be modified.

976

The <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> specific arguments <tt class="docutils literal">info</tt>, <tt class="docutils literal">key</tt>,

983

The <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> specific arguments <tt class="docutils literal">info</tt>, <tt class="docutils literal">key</tt>,

977

984

and <tt class="docutils literal">quote</tt> can also be added to the dictionary and

978

will be passed to the constructor of <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>.

985

will be passed to the constructor of <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>.

979

986

Note that this event is only meaningful if either

980

associated with 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> class across the

987

associated with 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> class across the

981

988

board, e.g.:

982

989

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy.schema import Table

983

990

from sqlalchemy import event

991

998

'column_reflect',

992

999

listen_for_reflect)</pre></div>

993

1000

</div>

994

...or with a specific <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> instance using

1001

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

995

1002

the <tt class="docutils literal">listeners</tt> argument:

996

1003

<div class="highlight-python"><div class="highlight"><pre>def listen_for_reflect(inspector, table, column_info):

997

1004

"receive a column_reflect event"

1005

1012

])</pre></div>

1006

1013

</div>

1007

1014

This because the reflection process initiated by <tt class="docutils literal">autoload=True</tt>

1008

completes within the scope of the constructor for <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>.

1015

completes within the scope of the constructor for <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>.

1009

1016

</dd></dl>

1010

1017

1011

1018

</dd></dl>

1015

1022

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

1016

1023

<dd>Base class for elements that are the targets of <a class="reference internal" href="#sqlalchemy.events.DDLEvents" title="sqlalchemy.events.DDLEvents"><tt class="xref py py-class docutils literal">DDLEvents</tt></a>

1017

1024

events.

1018

This includes <a class="reference internal" href="schema.html#sqlalchemy.schema.SchemaItem" title="sqlalchemy.schema.SchemaItem"><tt class="xref py py-class docutils literal">SchemaItem</tt></a> as well as <a class="reference internal" href="types.html#sqlalchemy.types.SchemaType" title="sqlalchemy.types.SchemaType"><tt class="xref py py-class docutils literal">SchemaType</tt></a>.

1025

This includes <a class="reference internal" href="metadata.html#sqlalchemy.schema.SchemaItem" title="sqlalchemy.schema.SchemaItem"><tt class="xref py py-class docutils literal">SchemaItem</tt></a> as well as <a class="reference internal" href="types.html#sqlalchemy.types.SchemaType" title="sqlalchemy.types.SchemaType"><tt class="xref py py-class docutils literal">SchemaType</tt></a>.

1019

1026

</dd></dl>

1020

1027

1021

1028

</div>

1033

1040

1034

1041

1035

1042

1036

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

1043

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

1037

1044

</div>

1038

1045

</div>

1039

1046

Older »