1 <?xml version="1.0" encoding="utf-8"?>
\r
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
\r
3 "DTD/xhtml1-transitional.dtd">
\r
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
\r
6 <title>psycopg2.extras.DictCursor</title>
\r
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
\r
8 <script type="text/javascript">
\r
10 function setFrame(url1, url2){
\r
11 parent.frames[1].location.href = url1;
\r
12 parent.frames[2].location.href = url2;
\r
17 <body bgcolor="white" text="black" link="blue" vlink="#204080"
\r
20 <!-- =========== START OF NAVBAR =========== -->
\r
21 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
\r
22 <tr valign="middle">
\r
23 <th class="navbar"> <a class="navbar" href="psycopg2-module.html">Home</a> </th>
\r
24 <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
\r
25 <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
\r
26 <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
\r
27 <th class="navbar" width="100%"></th>
\r
30 <table width="100%" cellpadding="0" cellspacing="0">
\r
33 <span class="breadcrumbs">
\r
34 <a href="psycopg2-module.html">Package psycopg2</a> ::
\r
35 <a href="psycopg2.extras-module.html">Module extras</a> ::
\r
36 Class DictCursor
\r
39 <td><table cellpadding="0" cellspacing="0">
\r
40 <tr><td align="right"><span class="options">[show private | <a href="../public/psycopg2.extras.DictCursor-class.html">hide private</a>]</span></td></tr>
\r
41 <tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a> | <a href="psycopg2.extras.DictCursor-class.html" target="_top">no frames</a>]</span></td></tr>
\r
45 <!-- =========== START OF CLASS DESCRIPTION =========== -->
\r
46 <h2 class="class">Type DictCursor</h2>
\r
48 <pre class="base-tree">
\r
49 <a href="__builtin__.object-class.html"><code>object</code></a> --+
\r
51 <a href="../private/psycopg2._psycopg.cursor-class.html"><code>cursor</code></a> --+
\r
53 <strong class="uidshort">DictCursor</strong>
\r
58 <p>A cursor that keeps a list of column name -> index mappings.</p>
\r
62 <!-- =========== START OF METHOD SUMMARY =========== -->
\r
63 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
64 <tr bgcolor="#70b0f0" class="summary">
\r
65 <th colspan="2">Method Summary</th></tr>
\r
66 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
67 <td><code><a name="callproc"></a><span class="summary-sig"><span class="summary-sig-name">callproc</span>(<span class="summary-sig-arg">self</span>,
\r
68 <span class="summary-sig-arg">procname</span>,
\r
69 <span class="summary-sig-arg">vars</span>)</span></code>
\r
71 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
72 <td><code><a name="execute"></a><span class="summary-sig"><span class="summary-sig-name">execute</span>(<span class="summary-sig-arg">self</span>,
\r
73 <span class="summary-sig-arg">query</span>,
\r
74 <span class="summary-sig-arg">vars</span>,
\r
75 <span class="summary-sig-arg">async</span>)</span></code>
\r
77 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
78 <td><code><a name="fetchall"></a><span class="summary-sig"><span class="summary-sig-name">fetchall</span>(<span class="summary-sig-arg">self</span>)</span></code>
\r
80 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
81 <td><code><a name="fetchmany"></a><span class="summary-sig"><span class="summary-sig-name">fetchmany</span>(<span class="summary-sig-arg">self</span>,
\r
82 <span class="summary-sig-arg">size</span>)</span></code>
\r
84 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
85 <td><code><a name="fetchone"></a><span class="summary-sig"><span class="summary-sig-name">fetchone</span>(<span class="summary-sig-arg">self</span>)</span></code>
\r
87 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
88 <td><code><a name="_build_index"></a><span class="summary-sig"><span class="summary-sig-name">_build_index</span>(<span class="summary-sig-arg">self</span>)</span></code>
\r
90 <tr bgcolor="#e8f0f8" class="group">
\r
91 <th colspan="2"> Inherited from cursor</th></tr>
\r
92 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
93 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
\r
95 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td></tr>
\r
96 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
97 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>
\r
99 Return iter(x)...</td></tr>
\r
100 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
101 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class="summary-sig-arg">T</span>,
\r
102 <span class="summary-sig-arg">S</span>,
\r
103 <span class="summary-sig-vararg">...</span>)</span></code>
\r
105 Return a new object with type S, a subtype of T...</td></tr>
\r
106 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
107 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>
\r
109 Return repr(x)...</td></tr>
\r
110 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
111 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>
\r
113 Return str(x)...</td></tr>
\r
114 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
115 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#close" class="summary-sig-name"><code>close</code></a>()</span></code>
\r
117 Close the cursor.</td></tr>
\r
118 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
119 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#copy_from" class="summary-sig-name"><code>copy_from</code></a>(<span class="summary-sig-arg">file</span>,
\r
120 <span class="summary-sig-arg">table</span>,
\r
121 <span class="summary-sig-arg">sep</span>,
\r
122 <span class="summary-sig-arg">null</span>)</span></code>
\r
124 Copy table from file.</td></tr>
\r
125 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
126 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#copy_to" class="summary-sig-name"><code>copy_to</code></a>(<span class="summary-sig-arg">file</span>,
\r
127 <span class="summary-sig-arg">table</span>,
\r
128 <span class="summary-sig-arg">sep</span>,
\r
129 <span class="summary-sig-arg">null</span>)</span></code>
\r
131 Copy table to file.</td></tr>
\r
132 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
133 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#executemany" class="summary-sig-name"><code>executemany</code></a>(<span class="summary-sig-arg">query</span>,
\r
134 <span class="summary-sig-arg">vars_list</span>,
\r
135 <span class="summary-sig-arg">async</span>)</span></code>
\r
137 Execute many queries with bound vars.</td></tr>
\r
138 <tr><td align="right" valign="top" width="15%" class="rtype">int</td>
\r
139 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#fileno" class="summary-sig-name"><code>fileno</code></a>()</span></code>
\r
141 Return file descriptor associated to database connection.</td></tr>
\r
142 <tr><td align="right" valign="top" width="15%" class="rtype">bool</td>
\r
143 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#isready" class="summary-sig-name"><code>isready</code></a>()</span></code>
\r
145 Return True if data is ready after an async query.</td></tr>
\r
146 <tr><td align="right" valign="top" width="15%" class="rtype">str</td>
\r
147 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#mogrify" class="summary-sig-name"><code>mogrify</code></a>(<span class="summary-sig-arg">query</span>,
\r
148 <span class="summary-sig-arg">vars</span>)</span></code>
\r
150 Return query after vars binding.</td></tr>
\r
151 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
152 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#next" class="summary-sig-name"><code>next</code></a>(<span class="summary-sig-arg">x</span>)</span></code>
\r
154 Return the next value, or raise StopIteration...</td></tr>
\r
155 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
156 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#nextset" class="summary-sig-name"><code>nextset</code></a>()</span></code>
\r
158 Skip to next set of data.</td></tr>
\r
159 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
160 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#scroll" class="summary-sig-name"><code>scroll</code></a>(<span class="summary-sig-arg">value</span>,
\r
161 <span class="summary-sig-arg">mode</span>)</span></code>
\r
163 Scroll to new position according to mode.</td></tr>
\r
164 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
165 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#setinputsizes" class="summary-sig-name"><code>setinputsizes</code></a>(<span class="summary-sig-arg">sizes</span>)</span></code>
\r
167 Set memory areas before execute.</td></tr>
\r
168 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
169 <td><code><span class="summary-sig"><a href="../private/psycopg2._psycopg.cursor-class.html#setoutputsize" class="summary-sig-name"><code>setoutputsize</code></a>(<span class="summary-sig-arg">size</span>,
\r
170 <span class="summary-sig-arg">column</span>)</span></code>
\r
172 Set column buffer size.</td></tr>
\r
173 <tr bgcolor="#e8f0f8" class="group">
\r
174 <th colspan="2"> Inherited from object</th></tr>
\r
175 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
176 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
\r
178 x.__delattr__('name') <==> del x.name</td></tr>
\r
179 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
180 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
\r
182 x.__getattribute__('name') <==> x.name</td></tr>
\r
183 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
184 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class="summary-sig-arg">x</span>)</span></code>
\r
186 Return hash(x)...</td></tr>
\r
187 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
188 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
\r
190 helper for pickle</td></tr>
\r
191 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
192 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
\r
194 helper for pickle</td></tr>
\r
195 <tr><td align="right" valign="top" width="15%" class="rtype"> </td>
\r
196 <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
\r
198 x.__setattr__('name', value) <==> x.name = value</td></tr>
\r
202 <!-- =========== START OF PROPERTY SUMMARY =========== -->
\r
203 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
204 <tr bgcolor="#70b0f0" class="summary">
\r
205 <th colspan="2">Property Summary</th></tr>
\r
206 <tr bgcolor="#e8f0f8" class="group">
\r
207 <th colspan="2"> Inherited from cursor</th></tr>
\r
208 <tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
209 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#arraysize"><code>arraysize</code></a></strong>: Number of records <a href="../private/psycopg2._psycopg.cursor-class.html#fetchmany" class="link"><code>fetchmany()</code></a> must fetch if not explicitely specified.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
210 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#binary_types"><code>binary_types</code></a></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
211 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#connection"><code>connection</code></a></strong>: The connection where the cursor comes from.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
212 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#description"><code>description</code></a></strong>: Cursor description as defined in DBAPI-2.0.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
213 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#lastrowid"><code>lastrowid</code></a></strong>: The <tt class="docutils literal"><span class="pre">oid</span></tt> of the last row inserted by the cursor.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
214 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#name"><code>name</code></a></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
215 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#query"><code>query</code></a></strong>: The last query text sent to the backend.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
216 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#row_factory"><code>row_factory</code></a></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
217 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#rowcount"><code>rowcount</code></a></strong>: Number of rows read from the backend in the last command.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
218 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#rownumber"><code>rownumber</code></a></strong>: The current row position.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
219 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#statusmessage"><code>statusmessage</code></a></strong>: The return message of the last command.</td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
220 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#string_types"><code>string_types</code></a></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
221 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#typecaster"><code>typecaster</code></a></strong></td></tr><tr><td align="right" valign="top" width="15%" class="ptype"> </td>
\r
222 <td><strong><a href="../private/psycopg2._psycopg.cursor-class.html#tzinfo_factory"><code>tzinfo_factory</code></a></strong></td></tr></table><br />
\r
225 <!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
\r
226 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
227 <tr bgcolor="#70b0f0" class="summary">
\r
228 <th colspan="2">Class Variable Summary</th></tr>
\r
229 <tr><td align="right" valign="top" width="15%" class="vtype"><code>int</code></td>
\r
230 <td><strong><a href="../private/psycopg2.extras.DictCursor-class.html#__query_executed"><code>_DictCursor__query_executed</code></a></strong> = <span title="0">0 </span></td></tr>
\r
234 <!-- =========== START OF METHOD DETAILS =========== -->
\r
235 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
236 <tr bgcolor="#70b0f0" class="details">
\r
237 <th colspan="2">Method Details</th></tr>
\r
240 <a name="callproc"></a>
\r
241 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
242 <h3><span class="sig"><span class="sig-name">callproc</span>(<span class="sig-arg">self</span>,
\r
243 <span class="sig-arg">procname</span>,
\r
244 <span class="sig-arg">vars</span>=<span class="sig-default">None</span>)</span>
\r
247 <dl><dt>Overrides:</dt>
\r
248 <dd><a href="../private/psycopg2._psycopg.cursor-class.html#callproc"><code>psycopg2._psycopg.cursor.callproc</code></a></dd>
\r
253 <a name="execute"></a>
\r
254 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
255 <h3><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>,
\r
256 <span class="sig-arg">query</span>,
\r
257 <span class="sig-arg">vars</span>=<span class="sig-default">None</span>,
\r
258 <span class="sig-arg">async</span>=<span class="sig-default">0</span>)</span>
\r
261 <dl><dt>Overrides:</dt>
\r
262 <dd><a href="../private/psycopg2._psycopg.cursor-class.html#execute"><code>psycopg2._psycopg.cursor.execute</code></a></dd>
\r
267 <a name="fetchall"></a>
\r
268 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
269 <h3><span class="sig"><span class="sig-name">fetchall</span>(<span class="sig-arg">self</span>)</span>
\r
272 <dl><dt>Overrides:</dt>
\r
273 <dd><a href="../private/psycopg2._psycopg.cursor-class.html#fetchall"><code>psycopg2._psycopg.cursor.fetchall</code></a></dd>
\r
278 <a name="fetchmany"></a>
\r
279 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
280 <h3><span class="sig"><span class="sig-name">fetchmany</span>(<span class="sig-arg">self</span>,
\r
281 <span class="sig-arg">size</span>=<span class="sig-default">None</span>)</span>
\r
284 <dl><dt>Overrides:</dt>
\r
285 <dd><a href="../private/psycopg2._psycopg.cursor-class.html#fetchmany"><code>psycopg2._psycopg.cursor.fetchmany</code></a></dd>
\r
290 <a name="fetchone"></a>
\r
291 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
292 <h3><span class="sig"><span class="sig-name">fetchone</span>(<span class="sig-arg">self</span>)</span>
\r
295 <dl><dt>Overrides:</dt>
\r
296 <dd><a href="../private/psycopg2._psycopg.cursor-class.html#fetchone"><code>psycopg2._psycopg.cursor.fetchone</code></a></dd>
\r
301 <a name="_build_index"></a>
\r
302 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
\r
303 <h3><span class="sig"><span class="sig-name">_build_index</span>(<span class="sig-arg">self</span>)</span>
\r
311 <!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
\r
312 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
\r
313 <tr bgcolor="#70b0f0" class="details">
\r
314 <th colspan="2">Class Variable Details</th></tr>
\r
316 <table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
\r
317 <a name="_DictCursor__query_executed"></a>
\r
318 <h3>_DictCursor__query_executed</h3>
\r
328 <dt title="0">Value:</dt>
\r
329 <dd title="0"><table><tr><td>
\r
330 <pre class="variable">
\r
331 0 </pre>
\r
332 </td></tr></table></dd>
\r
335 </dl></td></tr></table>
\r
339 <!-- =========== START OF NAVBAR =========== -->
\r
340 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
\r
341 <tr valign="middle">
\r
342 <th class="navbar"> <a class="navbar" href="psycopg2-module.html">Home</a> </th>
\r
343 <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
\r
344 <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
\r
345 <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
\r
346 <th class="navbar" width="100%"></th>
\r
350 <table border="0" cellpadding="0" cellspacing="0" width="100%">
\r
352 <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:32 2006</td>
\r
353 <td align="right" class="footer">
\r
354 <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>
\r