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

use the <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Sequence" title="sqlalchemy.schema.Sequence"><tt class="xref py py-func docutils literal">Sequence()</tt></a> construct:

213

use the <a class="reference internal" href="../core/defaults.html#sqlalchemy.schema.Sequence" title="sqlalchemy.schema.Sequence"><tt class="xref py py-func docutils literal">Sequence()</tt></a> construct:

214

<div class="highlight-python"><div class="highlight"><pre>Table('sometable', metadata,

215

Column('id', Integer, Sequence('some_id_seq'), primary_key=True)

216

)</pre></div>

223

sequence, whether specified explicitly or implicitly via <tt class="docutils literal">SERIAL</tt>, is

224

executed independently beforehand, the returned value to be used in the

225

subsequent insert. Note that when an

226

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

226

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

227

“executemany” semantics, the “last inserted identifier” functionality does not

228

apply; no RETURNING clause is emitted nor is the sequence pre-executed in this

229

case.

263

<h2>Remote / Cross-Schema Table Introspection<a class="headerlink" href="#remote-cross-schema-table-introspection" title="Permalink to this headline">¶</a></h2>

264

Tables can be introspected from any accessible schema, including

265

inter-schema foreign key relationships. However, care must be taken

266

when specifying the “schema” argument for a given <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>, when

266

when specifying the “schema” argument for a given <a class="reference internal" href="../core/metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>, when

267

the given schema is also present in PostgreSQL’s <tt class="docutils literal">search_path</tt> variable

268

for the current connection.

269

If a FOREIGN KEY constraint reports that the remote table’s schema is within

270

the current <tt class="docutils literal">search_path</tt>, the “schema” attribute of the resulting

271

<a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> will be set to <tt class="docutils literal">None</tt>, unless the actual schema of the

271

<a class="reference internal" href="../core/metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> will be set to <tt class="docutils literal">None</tt>, unless the actual schema of the

272

remote table matches that of the referencing table, and the “schema” argument

273

was explicitly stated on the referencing table.

274

The best practice here is to not use the <tt class="docutils literal">schema</tt> argument

275

on <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> for any schemas that are present in <tt class="docutils literal">search_path</tt>.

275

on <a class="reference internal" href="../core/metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a> for any schemas that are present in <tt class="docutils literal">search_path</tt>.

276

<tt class="docutils literal">search_path</tt> defaults to “public”, but care should be taken

277

to inspect the actual value using:

278

<div class="highlight-python"><pre>SHOW search_path;</pre>

279

</div>

280

281

Changed in version 0.7.3: Prior to this version, cross-schema foreign keys when the schemas

280

281

Changed in version 0.7.3: Prior to this version, cross-schema foreign keys when the schemas

282

were also in the <tt class="docutils literal">search_path</tt> could make an incorrect assumption

283

if the schemas were explicitly stated on each <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>.

283

if the schemas were explicitly stated on each <a class="reference internal" href="../core/metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>.

284

</div>

284

285

Background on PG’s <tt class="docutils literal">search_path</tt> is at:

285

286

<a class="reference external" href="http://www.postgresql.org/docs/9.0/static/ddl-schemas.html#DDL-SCHEMAS-PATH">http://www.postgresql.org/docs/9.0/static/ddl-schemas.html#DDL-SCHEMAS-PATH</a>

286

287

</div>

327

328

</div>

328

329

329

330

<h2>Postgresql-Specific Index Options<a class="headerlink" href="#postgresql-specific-index-options" title="Permalink to this headline">¶</a></h2>

330

Several extensions to the <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Index" title="sqlalchemy.schema.Index"><tt class="xref py py-class docutils literal">Index</tt></a> construct are available, specific

331

Several extensions to the <a class="reference internal" href="../core/constraints.html#sqlalchemy.schema.Index" title="sqlalchemy.schema.Index"><tt class="xref py py-class docutils literal">Index</tt></a> construct are available, specific

331

332

to the PostgreSQL dialect.

332

333

333

334

<h3>Partial Indexes<a class="headerlink" href="#partial-indexes" title="Permalink to this headline">¶</a></h3>

334

335

Partial indexes add criterion to the index definition so that the index is

335

applied to a subset of rows. These can be specified on <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Index" title="sqlalchemy.schema.Index"><tt class="xref py py-class docutils literal">Index</tt></a>

336

applied to a subset of rows. These can be specified on <a class="reference internal" href="../core/constraints.html#sqlalchemy.schema.Index" title="sqlalchemy.schema.Index"><tt class="xref py py-class docutils literal">Index</tt></a>

336

337

using the <tt class="docutils literal">postgresql_where</tt> keyword argument:

337

338

<div class="highlight-python"><div class="highlight"><pre>Index('my_index', my_table.c.id, postgresql_where=tbl.c.value > 10)</pre></div>

338

339

</div>

342

343

PostgreSQL allows the specification of an operator class for each column of

343

344

an index (see

344

345

<a class="reference external" href="http://www.postgresql.org/docs/8.3/interactive/indexes-opclass.html">http://www.postgresql.org/docs/8.3/interactive/indexes-opclass.html</a>).

345

The <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Index" title="sqlalchemy.schema.Index"><tt class="xref py py-class docutils literal">Index</tt></a> construct allows these to be specified via the

346

The <a class="reference internal" href="../core/constraints.html#sqlalchemy.schema.Index" title="sqlalchemy.schema.Index"><tt class="xref py py-class docutils literal">Index</tt></a> construct allows these to be specified via the

346

347

<tt class="docutils literal">postgresql_ops</tt> keyword argument:

347

348

<div class="highlight-python"><div class="highlight"><pre>Index('my_index', my_table.c.id, my_table.c.data,

348

349

postgresql_ops={

350

351

'id': 'int4_ops'

351

352

})</pre></div>

352

353

</div>

353

354

New in version 0.7.2: <tt class="docutils literal">postgresql_ops</tt> keyword argument to <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Index" title="sqlalchemy.schema.Index"><tt class="xref py py-class docutils literal">Index</tt></a> construct.

354

355

New in version 0.7.2: <tt class="docutils literal">postgresql_ops</tt> keyword argument to <a class="reference internal" href="../core/constraints.html#sqlalchemy.schema.Index" title="sqlalchemy.schema.Index"><tt class="xref py py-class docutils literal">Index</tt></a> construct.

356

</div>

355

357

Note that the keys in the <tt class="docutils literal">postgresql_ops</tt> dictionary are the “key” name of

356

the <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a>, i.e. the name used to access it from the <tt class="docutils literal">.c</tt>

357

collection of <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>, which can be configured to be different than

358

the <a class="reference internal" href="../core/metadata.html#sqlalchemy.schema.Column" title="sqlalchemy.schema.Column"><tt class="xref py py-class docutils literal">Column</tt></a>, i.e. the name used to access it from the <tt class="docutils literal">.c</tt>

359

collection of <a class="reference internal" href="../core/metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>, which can be configured to be different than

358

360

the actual name of the column as expressed in the database.

359

361

</div>

360

362

362

364

PostgreSQL provides several index types: B-Tree, Hash, GiST, and GIN, as well

363

365

as the ability for users to create their own (see

364

366

<a class="reference external" href="http://www.postgresql.org/docs/8.3/static/indexes-types.html">http://www.postgresql.org/docs/8.3/static/indexes-types.html</a>). These can be

365

specified on <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Index" title="sqlalchemy.schema.Index"><tt class="xref py py-class docutils literal">Index</tt></a> using the <tt class="docutils literal">postgresql_using</tt> keyword argument:

367

specified on <a class="reference internal" href="../core/constraints.html#sqlalchemy.schema.Index" title="sqlalchemy.schema.Index"><tt class="xref py py-class docutils literal">Index</tt></a> using the <tt class="docutils literal">postgresql_using</tt> keyword argument:

366

368

<div class="highlight-python"><div class="highlight"><pre>Index('my_index', my_table.c.data, postgresql_using='gin')</pre></div>

367

369

</div>

368

370

The value passed to the keyword argument will be simply passed through to the

387

389

388

390

389

391

class <tt class="descclassname">sqlalchemy.dialects.postgresql.</tt><tt class="descname">array</tt><big>(</big>clauses, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.dialects.postgresql.array" title="Permalink to this definition">¶</a></dt>

390

<dd>A Postgresql ARRAY literal.

392

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

393

A Postgresql ARRAY literal.

391

394

This is used to produce ARRAY literals in SQL expressions, e.g.:

392

395

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy.dialects.postgresql import array

393

396

from sqlalchemy.dialects import postgresql

408

411

the values present, unless the <tt class="docutils literal">type_</tt> keyword argument is passed:

409

412

<div class="highlight-python"><div class="highlight"><pre>array(['foo', 'bar'], type_=CHAR)</pre></div>

410

413

</div>

411

412

New in version 0.8: Added the <a class="reference internal" href="#sqlalchemy.dialects.postgresql.array" title="sqlalchemy.dialects.postgresql.array"><tt class="xref py py-class docutils literal">array</tt></a> literal type.

414

415

New in version 0.8: Added the <a class="reference internal" href="#sqlalchemy.dialects.postgresql.array" title="sqlalchemy.dialects.postgresql.array"><tt class="xref py py-class docutils literal">array</tt></a> literal type.

416

</div>

413

417

See also:

414

418

<a class="reference internal" href="#sqlalchemy.dialects.postgresql.ARRAY" title="sqlalchemy.dialects.postgresql.ARRAY"><tt class="xref py py-class docutils literal">postgresql.ARRAY</tt></a>

415

419

</dd></dl>

442

446

)</pre></div>

443

447

</div>

444

448

This has the effect of the <a class="reference internal" href="#sqlalchemy.dialects.postgresql.ARRAY" title="sqlalchemy.dialects.postgresql.ARRAY"><tt class="xref py py-class docutils literal">ARRAY</tt></a> type

445

specifying that number of bracketed blocks when a <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>

449

specifying that number of bracketed blocks when a <a class="reference internal" href="../core/metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal">Table</tt></a>

446

450

is used in a CREATE TABLE statement, or when the type is used

447

within a <a class="reference internal" href="../core/expression_api.html#sqlalchemy.sql.expression.cast" title="sqlalchemy.sql.expression.cast"><tt class="xref py py-func docutils literal">expression.cast()</tt></a> construct; it also causes

451

within a <a class="reference internal" href="../core/sqlelement.html#sqlalchemy.sql.expression.cast" title="sqlalchemy.sql.expression.cast"><tt class="xref py py-func docutils literal">expression.cast()</tt></a> construct; it also causes

448

452

the bind parameter and result set processing of the type

449

453

to optimize itself to expect exactly that number of dimensions.

450

454

Note that Postgresql itself still allows N dimensions with such a type.

456

460

SELECT statements:

457

461

<div class="highlight-python"><div class="highlight"><pre>select([mytable.c.data[5], mytable.c.data[2:7]])</pre></div>

458

462

</div>

459

as well as UPDATE statements when the <a class="reference internal" href="../core/expression_api.html#sqlalchemy.sql.expression.Update.values" title="sqlalchemy.sql.expression.Update.values"><tt class="xref py py-meth docutils literal">Update.values()</tt></a> method

463

as well as UPDATE statements when the <a class="reference internal" href="../core/dml.html#sqlalchemy.sql.expression.Update.values" title="sqlalchemy.sql.expression.Update.values"><tt class="xref py py-meth docutils literal">Update.values()</tt></a> method

460

464

is used:

461

465

<div class="highlight-python"><div class="highlight"><pre>mytable.update().values({

462

466

mytable.c.data[5]: 7,

468

472

<div class="highlight-python"><div class="highlight"><pre>mytable.c.data.contains([1, 2])</pre></div>

469

473

</div>

470

474

For a full list of special methods see <a class="reference internal" href="#sqlalchemy.dialects.postgresql.ARRAY.Comparator" title="sqlalchemy.dialects.postgresql.ARRAY.Comparator"><tt class="xref py py-class docutils literal">ARRAY.Comparator</tt></a>.

471

472

New in version 0.8: Added support for index and slice operations

475

476

New in version 0.8: Added support for index and slice operations

473

477

to the <a class="reference internal" href="#sqlalchemy.dialects.postgresql.ARRAY" title="sqlalchemy.dialects.postgresql.ARRAY"><tt class="xref py py-class docutils literal">ARRAY</tt></a> type, including support for UPDATE

474

478

statements, and special array containment operations.

479

</div>

475

480

The <a class="reference internal" href="#sqlalchemy.dialects.postgresql.ARRAY" title="sqlalchemy.dialects.postgresql.ARRAY"><tt class="xref py py-class docutils literal">ARRAY</tt></a> type may not be supported on all DBAPIs.

476

481

It is known to work on psycopg2 and not pg8000.

477

482

See also:

478

483

<a class="reference internal" href="#sqlalchemy.dialects.postgresql.array" title="sqlalchemy.dialects.postgresql.array"><tt class="xref py py-class docutils literal">postgresql.array</tt></a> - produce a literal array value.

479

480

481

<tt class="descname">__init__</tt><big>(</big>item_type, as_tuple=False, dimensions=None<big>)</big><a class="headerlink" href="#sqlalchemy.dialects.postgresql.ARRAY.__init__" title="Permalink to this definition">¶</a></dt>

482

<dd>Construct an ARRAY.

483

E.g.:

484

<div class="highlight-python"><div class="highlight"><pre>Column('myarray', ARRAY(Integer))</pre></div>

485

</div>

486

Arguments are:

487

488

489

490

491

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

492

<li>item_type – The data type of items of this array. Note that

493

dimensionality is irrelevant here, so multi-dimensional arrays like

494

<tt class="docutils literal">INTEGER[][]</tt>, are constructed as <tt class="docutils literal">ARRAY(Integer)</tt>, not as

495

<tt class="docutils literal">ARRAY(ARRAY(Integer))</tt> or such.</li>

496

<li>as_tuple=False – Specify whether return results

497

should be converted to tuples from lists. DBAPIs such

498

as psycopg2 return lists by default. When tuples are

499

returned, the results are hashable.</li>

500

<li>dimensions – if non-None, the ARRAY will assume a fixed

501

number of dimensions. This will cause the DDL emitted for this

502

ARRAY to include the exact number of bracket clauses <tt class="docutils literal">[]</tt>,

503

and will also optimize the performance of the type overall.

504

Note that PG arrays are always implicitly “non-dimensioned”,

505

meaning they can store any number of dimensions no matter how

506

they were declared.</li>

507

</ul>

508

</td>

509

</tr>

510

</tbody>

511

</table>

512

</dd></dl>

513

514

484

515

485

516

486

class <tt class="descname">Comparator</tt><big>(</big>expr<big>)</big><a class="headerlink" href="#sqlalchemy.dialects.postgresql.ARRAY.Comparator" title="Permalink to this definition">¶</a></dt>

545

515

</tr>

546

516

</tbody>

547

517

</table>

548

518

549

519

See also

550

520

<a class="reference internal" href="#sqlalchemy.dialects.postgresql.All" title="sqlalchemy.dialects.postgresql.All"><tt class="xref py py-class docutils literal">postgresql.All</tt></a>

551

521

<a class="reference internal" href="#sqlalchemy.dialects.postgresql.ARRAY.Comparator.any" title="sqlalchemy.dialects.postgresql.ARRAY.Comparator.any"><tt class="xref py py-meth docutils literal">postgresql.ARRAY.Comparator.any()</tt></a>

581

551

</tr>

582

552

</tbody>

583

553

</table>

584

554

585

555

See also

586

556

<a class="reference internal" href="#sqlalchemy.dialects.postgresql.Any" title="sqlalchemy.dialects.postgresql.Any"><tt class="xref py py-class docutils literal">postgresql.Any</tt></a>

587

557

<a class="reference internal" href="#sqlalchemy.dialects.postgresql.ARRAY.Comparator.all" title="sqlalchemy.dialects.postgresql.ARRAY.Comparator.all"><tt class="xref py py-meth docutils literal">postgresql.ARRAY.Comparator.all()</tt></a>

611

581

612

582

</dd></dl>

613

583

584

585

586

<tt class="descclassname">ARRAY.</tt><tt class="descname">__init__</tt><big>(</big>item_type, as_tuple=False, dimensions=None<big>)</big><a class="headerlink" href="#sqlalchemy.dialects.postgresql.ARRAY.__init__" title="Permalink to this definition">¶</a></dt>

587

<dd>Construct an ARRAY.

588

E.g.:

589

590

</div>

591

Arguments are:

592

593

594

595

596

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

597

<li>item_type – The data type of items of this array. Note that

598

dimensionality is irrelevant here, so multi-dimensional arrays like

599

<tt class="docutils literal">INTEGER[][]</tt>, are constructed as <tt class="docutils literal">ARRAY(Integer)</tt>, not as

600

<tt class="docutils literal">ARRAY(ARRAY(Integer))</tt> or such.</li>

601

<li>as_tuple=False – Specify whether return results

602

should be converted to tuples from lists. DBAPIs such

603

as psycopg2 return lists by default. When tuples are

604

returned, the results are hashable.</li>

605

<li>dimensions – if non-None, the ARRAY will assume a fixed

606

number of dimensions. This will cause the DDL emitted for this

607

ARRAY to include the exact number of bracket clauses <tt class="docutils literal">[]</tt>,

608

and will also optimize the performance of the type overall.

609

Note that PG arrays are always implicitly “non-dimensioned”,

610

meaning they can store any number of dimensions no matter how

611

they were declared.</li>

612

</ul>

613

</td>

614

</tr>

615

</tbody>

616

</table>

617

</dd></dl>

618

614

619

</dd></dl>

615

620

616

621

617

622

618

623

class <tt class="descclassname">sqlalchemy.dialects.postgresql.</tt><tt class="descname">Any</tt><big>(</big>left, right, operator=<built-in function eq><big>)</big><a class="headerlink" href="#sqlalchemy.dialects.postgresql.Any" title="Permalink to this definition">¶</a></dt>

619

<dd>Represent the clause <tt class="docutils literal">left operator ANY (right)</tt>. <tt class="docutils literal">right</tt> must be

624

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

625

Represent the clause <tt class="docutils literal">left operator ANY (right)</tt>. <tt class="docutils literal">right</tt> must be

620

626

an array expression.

621

627

622

628

See also

623

629

624

630

628

634

629

635

630

636

class <tt class="descclassname">sqlalchemy.dialects.postgresql.</tt><tt class="descname">All</tt><big>(</big>left, right, operator=<built-in function eq><big>)</big><a class="headerlink" href="#sqlalchemy.dialects.postgresql.All" title="Permalink to this definition">¶</a></dt>

631

<dd>Represent the clause <tt class="docutils literal">left operator ALL (right)</tt>. <tt class="docutils literal">right</tt> must be

637

638

Represent the clause <tt class="docutils literal">left operator ALL (right)</tt>. <tt class="docutils literal">right</tt> must be

632

639

an array expression.

633

640

634

641

See also

635

642

636

643

762

769

the <a class="reference internal" href="#sqlalchemy.dialects.postgresql.ENUM.create" title="sqlalchemy.dialects.postgresql.ENUM.create"><tt class="xref py py-meth docutils literal">create()</tt></a> and

763

770

<a class="reference internal" href="#sqlalchemy.dialects.postgresql.ENUM.drop" title="sqlalchemy.dialects.postgresql.ENUM.drop"><tt class="xref py py-meth docutils literal">drop()</tt></a> methods can

764

771

be used to emit SQL to a target bind.

765

766

New in version 0.7.4.

772

773

New in version 0.7.4.

774

</div>

767

775

</td>

768

776

</tr>

769

777

</tbody>

861

869

For usage with the SQLAlchemy ORM, it may be desirable to combine

862

870

the usage of <a class="reference internal" href="#sqlalchemy.dialects.postgresql.HSTORE" title="sqlalchemy.dialects.postgresql.HSTORE"><tt class="xref py py-class docutils literal">HSTORE</tt></a> with <a class="reference internal" href="../orm/extensions/mutable.html#sqlalchemy.ext.mutable.MutableDict" title="sqlalchemy.ext.mutable.MutableDict"><tt class="xref py py-class docutils literal">MutableDict</tt></a> dictionary

863

871

now part of the <a class="reference internal" href="../orm/extensions/mutable.html#module-sqlalchemy.ext.mutable" title="sqlalchemy.ext.mutable"><tt class="xref py py-mod docutils literal">sqlalchemy.ext.mutable</tt></a>

864

extension. This extension will allow in-place changes to dictionary

865

values to be detected by the unit of work:

872

extension. This extension will allow “in-place” changes to the

873

dictionary, e.g. addition of new keys or replacement/removal of existing

874

keys to/from the current dictionary, to produce events which will be detected

875

by the unit of work:

866

876

<div class="highlight-python"><div class="highlight"><pre>from sqlalchemy.ext.mutable import MutableDict

867

877

868

878

class MyClass(Base):

879

889

880

890

session.commit()</pre></div>

881

891

</div>

882

883

New in version 0.8.

884

892

When the <a class="reference internal" href="../orm/extensions/mutable.html#module-sqlalchemy.ext.mutable" title="sqlalchemy.ext.mutable"><tt class="xref py py-mod docutils literal">sqlalchemy.ext.mutable</tt></a> extension is not used, the ORM

893

will not be alerted to any changes to the contents of an existing dictionary,

894

unless that dictionary value is re-assigned to the HSTORE-attribute itself,

895

thus generating a change event.

896

897

New in version 0.8.

898

</div>

899

885

900

See also

886

901

<a class="reference internal" href="#sqlalchemy.dialects.postgresql.hstore" title="sqlalchemy.dialects.postgresql.hstore"><tt class="xref py py-class docutils literal">hstore</tt></a> - render the Postgresql <tt class="docutils literal">hstore()</tt> function.

887

902

</div>

978

993

979

994

980

995

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

981

<dd>Bases: <a class="reference internal" href="../core/expression_api.html#sqlalchemy.sql.functions.GenericFunction" title="sqlalchemy.sql.functions.GenericFunction"><tt class="xref py py-class docutils literal">sqlalchemy.sql.functions.GenericFunction</tt></a>

996

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

982

997

Construct an hstore value within a SQL expression using the

983

998

Postgresql <tt class="docutils literal">hstore()</tt> function.

984

999

The <a class="reference internal" href="#sqlalchemy.dialects.postgresql.hstore" title="sqlalchemy.dialects.postgresql.hstore"><tt class="xref py py-class docutils literal">hstore</tt></a> function accepts one or two arguments as described

995

1010

)

996

1011

])</pre></div>

997

1012

</div>

998

999

New in version 0.8.

1000

1013

1014

New in version 0.8.

1015

</div>

1016

1001

1017

See also

1002

1018

<a class="reference internal" href="#sqlalchemy.dialects.postgresql.HSTORE" title="sqlalchemy.dialects.postgresql.HSTORE"><tt class="xref py py-class docutils literal">HSTORE</tt></a> - the Postgresql <tt class="docutils literal">HSTORE</tt> datatype.

1003

1019

</div>

1112

1128

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

1113

1129

<dd>Bases: <a class="reference internal" href="#sqlalchemy.dialects.postgresql.ranges.RangeOperators" title="sqlalchemy.dialects.postgresql.ranges.RangeOperators"><tt class="xref py py-class docutils literal">sqlalchemy.dialects.postgresql.ranges.RangeOperators</tt></a>, <a class="reference internal" href="../core/types.html#sqlalchemy.types.TypeEngine" title="sqlalchemy.types.TypeEngine"><tt class="xref py py-class docutils literal">sqlalchemy.types.TypeEngine</tt></a>

1114

1130

Represent the Postgresql INT4RANGE type.

1115

1116

New in version 0.8.2.

1131

1132

New in version 0.8.2.

1133

</div>

1117

1134

</dd></dl>

1118

1135

1119

1136

1121

1138

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

1122

1139

1123

1140

Represent the Postgresql INT8RANGE type.

1124

1125

New in version 0.8.2.

1141

1142

New in version 0.8.2.

1143

</div>

1126

1144

</dd></dl>

1127

1145

1128

1146

1130

1148

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

1131

1149

1132

1150

Represent the Postgresql NUMRANGE type.

1133

1134

New in version 0.8.2.

1151

1152

New in version 0.8.2.

1153

</div>

1135

1154

</dd></dl>

1136

1155

1137

1156

1139

1158

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

1140

1159

1141

1160

Represent the Postgresql DATERANGE type.

1142

1143

New in version 0.8.2.

1161

1162

New in version 0.8.2.

1163

</div>

1144

1164

</dd></dl>

1145

1165

1146

1166

1148

1168

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

1149

1169

1150

1170

Represent the Postgresql TSRANGE type.

1151

1152

New in version 0.8.2.

1171

1172

New in version 0.8.2.

1173

</div>

1153

1174

</dd></dl>

1154

1175

1155

1176

1157

1178

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

1158

1179

1159

1180

Represent the Postgresql TSTZRANGE type.

1160

1161

New in version 0.8.2.

1181

1182

New in version 0.8.2.

1183

</div>

1162

1184

</dd></dl>

1163

1185

1164

1186

The types above get most of their functionality from the following

1173

1195

any range types you create yourself.

1174

1196

No extra support is provided for the Range Functions listed in

1175

1197

Table 9-45 of the postgres documentation. For these, the normal

1176

<a class="reference internal" href="../core/expression_api.html#sqlalchemy.sql.expression.func" title="sqlalchemy.sql.expression.func"><tt class="xref py py-func docutils literal">func()</tt></a> object should be used.

1177

1178

New in version 0.8.2: Support for Postgresql RANGE operations.

1198

<a class="reference internal" href="../core/sqlelement.html#sqlalchemy.sql.expression.func" title="sqlalchemy.sql.expression.func"><tt class="xref py py-func docutils literal">func()</tt></a> object should be used.

1199

1200

New in version 0.8.2: Support for Postgresql RANGE operations.

1201

</div>

1179

1202

1180

1203

1181

1204

class <tt class="descname">comparator_factory</tt><big>(</big>expr<big>)</big><a class="headerlink" href="#sqlalchemy.dialects.postgresql.ranges.RangeOperators.comparator_factory" title="Permalink to this definition">¶</a></dt>

1182

<dd>Define comparison operations for range types.

1205

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

1206

Define comparison operations for range types.

1183

1207

1184

1208

1185

1209

<tt class="descname">__ne__</tt><big>(</big>other<big>)</big><a class="headerlink" href="#sqlalchemy.dialects.postgresql.ranges.RangeOperators.comparator_factory.__ne__" title="Permalink to this definition">¶</a></dt>

1263

1287

1264

1288

1265

1289

class <tt class="descclassname">sqlalchemy.dialects.postgresql.</tt><tt class="descname">ExcludeConstraint</tt><big>(</big>*elements, **kw<big>)</big><a class="headerlink" href="#sqlalchemy.dialects.postgresql.ExcludeConstraint" title="Permalink to this definition">¶</a></dt>

1266

<dd>Bases: <a class="reference internal" href="../core/schema.html#sqlalchemy.schema.ColumnCollectionConstraint" title="sqlalchemy.schema.ColumnCollectionConstraint"><tt class="xref py py-class docutils literal">sqlalchemy.schema.ColumnCollectionConstraint</tt></a>

1290

<dd>Bases: <a class="reference internal" href="../core/constraints.html#sqlalchemy.schema.ColumnCollectionConstraint" title="sqlalchemy.schema.ColumnCollectionConstraint"><tt class="xref py py-class docutils literal">sqlalchemy.schema.ColumnCollectionConstraint</tt></a>

1267

1291

A table-level EXCLUDE constraint.

1268

1292

Defines an EXCLUDE constraint as described in the <a class="reference external" href="http://www.postgresql.org/docs/9.0/static/sql-createtable.html#SQL-CREATETABLE-EXCLUDE">postgres

1269

1293

documentation</a>.

1365

1389

1366

1390

<h3>Per-Statement/Connection Execution Options<a class="headerlink" href="#per-statement-connection-execution-options" title="Permalink to this headline">¶</a></h3>

1367

1391

The following DBAPI-specific options are respected when used with

1368

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

1392

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

1369

1393

<a class="reference internal" href="../orm/query.html#sqlalchemy.orm.query.Query.execution_options" title="sqlalchemy.orm.query.Query.execution_options"><tt class="xref py py-meth docutils literal">Query.execution_options()</tt></a>, in addition to those not specific to DBAPIs:

1370

1394

1371

1395

<li>isolation_level - Set the transaction isolation level for the lifespan of a

1399

1423

<div class="highlight-python"><div class="highlight"><pre>engine = create_engine("postgresql://user:pass@host/dbname", client_encoding='utf8')</pre></div>

1400

1424

</div>

1401

1425

This overrides the encoding specified in the Postgresql client configuration.

1402

1403

New in version 0.7.3: The psycopg2-specific <tt class="docutils literal">client_encoding</tt> parameter to

1426

1427

New in version 0.7.3: The psycopg2-specific <tt class="docutils literal">client_encoding</tt> parameter to

1404

1428

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

1429

</div>

1405

1430

SQLAlchemy can also be instructed to skip the usage of the psycopg2

1406

1431

<tt class="docutils literal">UNICODE</tt> extension and to instead utilize it’s own unicode encode/decode

1407

1432

services, which are normally reserved only for those DBAPIs that don’t

1437

1462

<li><tt class="docutils literal">SERIALIZABLE</tt></li>

1438

1463

<li><tt class="docutils literal">AUTOCOMMIT</tt></li>

1439

1464

</ul>

1440

1441

New in version 0.8.2: support for AUTOCOMMIT isolation level when using

1465

1466

New in version 0.8.2: support for AUTOCOMMIT isolation level when using

1442

1467

psycopg2.

1443

1468

</div>

1469

</div>

1444

1470

1445

1471

<h3>NOTICE logging<a class="headerlink" href="#notice-logging" title="Permalink to this headline">¶</a></h3>

1446

1472

The psycopg2 dialect will log Postgresql NOTICE messages via the

1528

1554

1529

1555

1530

1556

1531

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

1557

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

1532

1558

</div>

1533

1559

</div>

1534

1560

Older »