1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Query methods — PyGreSQL 5.0 documentation</title>
<link rel="stylesheet" href="../../_static/cloud.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygresql.css" type="text/css" />
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Noticia+Text|Open+Sans|Droid+Sans+Mono" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '5.0.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/jquery.cookie.js"></script>
<script type="text/javascript" src="../../_static/cloud.js"></script>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="copyright" title="Copyright" href="../../copyright.html" />
<link rel="top" title="PyGreSQL 5.0 documentation" href="../index.html" />
<link rel="up" title="pg — The Classic PyGreSQL Interface" href="index.html" />
<link rel="next" title="LargeObject – Large Objects" href="large_objects.html" />
<link rel="prev" title="The DB wrapper class" href="db_wrapper.html" />
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body role="document">
<div class="pageheader related" role="navigation" aria-label="related navigation">
<ul>
<li><a href="../../index.html">Home</a></li>
<li><a href="../../download/index.html">Download</a></li>
<li><a href="../index.html">Documentation</a></li>
<li><a href="../../community/index.html">Community</a></li>
</ul>
<div class="logo">
<a href="../../index.html">PyGreSQL</a>
</div>
</div>
</div>
<div class="relbar-top">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="large_objects.html" title="LargeObject – Large Objects"
accesskey="N">next</a> </li>
<li class="right" >
<a href="db_wrapper.html" title="The DB wrapper class"
accesskey="P">previous</a> </li>
<li><a href="../index.html">PyGreSQL 5.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U"><code class="docutils literal"><span class="pre">pg</span></code> — The Classic PyGreSQL Interface</a> »</li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="query-methods">
<h1>Query methods<a class="headerlink" href="#query-methods" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="pg.Query">
<em class="property">class </em><code class="descclassname">pg.</code><code class="descname">Query</code><a class="headerlink" href="#pg.Query" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p>The <a class="reference internal" href="#pg.Query" title="pg.Query"><code class="xref py py-class docutils literal"><span class="pre">Query</span></code></a> object returned by <a class="reference internal" href="connection.html#pg.Connection.query" title="pg.Connection.query"><code class="xref py py-meth docutils literal"><span class="pre">Connection.query()</span></code></a> and
<a class="reference internal" href="db_wrapper.html#pg.DB.query" title="pg.DB.query"><code class="xref py py-meth docutils literal"><span class="pre">DB.query()</span></code></a> provides the following methods for accessing
the results of the query:</p>
<div class="section" id="getresult-get-query-values-as-list-of-tuples">
<h2>getresult – get query values as list of tuples<a class="headerlink" href="#getresult-get-query-values-as-list-of-tuples" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="pg.Query.getresult">
<code class="descclassname">Query.</code><code class="descname">getresult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pg.Query.getresult" title="Permalink to this definition">¶</a></dt>
<dd><p>Get query values as list of tuples</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">result values as a list of tuples</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">list</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>TypeError</strong> – too many (any) parameters</li>
<li><strong>MemoryError</strong> – internal memory error</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<p>This method returns the list of the values returned by the query.
More information about this result may be accessed using
<a class="reference internal" href="#pg.Query.listfields" title="pg.Query.listfields"><code class="xref py py-meth docutils literal"><span class="pre">Query.listfields()</span></code></a>, <a class="reference internal" href="#pg.Query.fieldname" title="pg.Query.fieldname"><code class="xref py py-meth docutils literal"><span class="pre">Query.fieldname()</span></code></a>
and <a class="reference internal" href="#pg.Query.fieldnum" title="pg.Query.fieldnum"><code class="xref py py-meth docutils literal"><span class="pre">Query.fieldnum()</span></code></a> methods.</p>
<p>Note that since PyGreSQL 5.0 this will return the values of array type
columns as Python lists.</p>
</div>
<div class="section" id="dictresult-get-query-values-as-list-of-dictionaries">
<h2>dictresult – get query values as list of dictionaries<a class="headerlink" href="#dictresult-get-query-values-as-list-of-dictionaries" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="pg.Query.dictresult">
<code class="descclassname">Query.</code><code class="descname">dictresult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pg.Query.dictresult" title="Permalink to this definition">¶</a></dt>
<dd><p>Get query values as list of dictionaries</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">result values as a list of dictionaries</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">list</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>TypeError</strong> – too many (any) parameters</li>
<li><strong>MemoryError</strong> – internal memory error</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<p>This method returns the list of the values returned by the query
with each tuple returned as a dictionary with the field names
used as the dictionary index.</p>
<p>Note that since PyGreSQL 5.0 this will return the values of array type
columns as Python lists.</p>
</div>
<div class="section" id="namedresult-get-query-values-as-list-of-named-tuples">
<h2>namedresult – get query values as list of named tuples<a class="headerlink" href="#namedresult-get-query-values-as-list-of-named-tuples" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="pg.Query.namedresult">
<code class="descclassname">Query.</code><code class="descname">namedresult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pg.Query.namedresult" title="Permalink to this definition">¶</a></dt>
<dd><p>Get query values as list of named tuples</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">result values as a list of named tuples</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">list</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>TypeError</strong> – too many (any) parameters</li>
<li><strong>TypeError</strong> – named tuples not supported</li>
<li><strong>MemoryError</strong> – internal memory error</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<p>This method returns the list of the values returned by the query
with each row returned as a named tuple with proper field names.</p>
<p>Note that since PyGreSQL 5.0 this will return the values of array type
columns as Python lists.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 4.1.</span></p>
</div>
</div>
<div class="section" id="listfields-list-fields-names-of-previous-query-result">
<h2>listfields – list fields names of previous query result<a class="headerlink" href="#listfields-list-fields-names-of-previous-query-result" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="pg.Query.listfields">
<code class="descclassname">Query.</code><code class="descname">listfields</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pg.Query.listfields" title="Permalink to this definition">¶</a></dt>
<dd><p>List fields names of previous query result</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">field names</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>TypeError</strong> – too many parameters</td>
</tr>
</tbody>
</table>
</dd></dl>
<p>This method returns the list of names of the fields defined for the
query result. The fields are in the same order as the result values.</p>
</div>
<div class="section" id="fieldname-fieldnum-field-name-number-conversion">
<h2>fieldname, fieldnum – field name/number conversion<a class="headerlink" href="#fieldname-fieldnum-field-name-number-conversion" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="pg.Query.fieldname">
<code class="descclassname">Query.</code><code class="descname">fieldname</code><span class="sig-paren">(</span><em>num</em><span class="sig-paren">)</span><a class="headerlink" href="#pg.Query.fieldname" title="Permalink to this definition">¶</a></dt>
<dd><p>Get field name from its number</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>num</strong> (<em>int</em>) – field number</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">field name</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">str</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>TypeError</strong> – invalid connection, bad parameter type, or too many parameters</li>
<li><strong>ValueError</strong> – invalid field number</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<p>This method allows to find a field name from its rank number. It can be
useful for displaying a result. The fields are in the same order as the
result values.</p>
<dl class="method">
<dt id="pg.Query.fieldnum">
<code class="descclassname">Query.</code><code class="descname">fieldnum</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pg.Query.fieldnum" title="Permalink to this definition">¶</a></dt>
<dd><p>Get field number from its name</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>name</strong> (<em>str</em>) – field name</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">field number</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">int</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>TypeError</strong> – invalid connection, bad parameter type, or too many parameters</li>
<li><strong>ValueError</strong> – unknown field name</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<p>This method returns a field number from its name. It can be used to
build a function that converts result list strings to their correct
type, using a hardcoded table definition. The number returned is the
field rank in the result values list.</p>
</div>
<div class="section" id="ntuples-return-number-of-tuples-in-query-object">
<h2>ntuples – return number of tuples in query object<a class="headerlink" href="#ntuples-return-number-of-tuples-in-query-object" title="Permalink to this headline">¶</a></h2>
<dl class="method">
<dt id="pg.Query.ntuples">
<code class="descclassname">Query.</code><code class="descname">ntuples</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pg.Query.ntuples" title="Permalink to this definition">¶</a></dt>
<dd><p>Return number of tuples in query object</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">number of tuples in <a class="reference internal" href="#pg.Query" title="pg.Query"><code class="xref py py-class docutils literal"><span class="pre">Query</span></code></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><strong>TypeError</strong> – Too many arguments.</td>
</tr>
</tbody>
</table>
</dd></dl>
<p>This method returns the number of tuples found in a query.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html" title="contents/index">
<img class="logo" src="../../_static/pygresql.png" alt="Logo"/>
</a></p><div class="sphinxlocaltoc">
<h3><a href="../../index.html">Page contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Query methods</a><ul>
<li><a class="reference internal" href="#getresult-get-query-values-as-list-of-tuples">getresult – get query values as list of tuples</a></li>
<li><a class="reference internal" href="#dictresult-get-query-values-as-list-of-dictionaries">dictresult – get query values as list of dictionaries</a></li>
<li><a class="reference internal" href="#namedresult-get-query-values-as-list-of-named-tuples">namedresult – get query values as list of named tuples</a></li>
<li><a class="reference internal" href="#listfields-list-fields-names-of-previous-query-result">listfields – list fields names of previous query result</a></li>
<li><a class="reference internal" href="#fieldname-fieldnum-field-name-number-conversion">fieldname, fieldnum – field name/number conversion</a></li>
<li><a class="reference internal" href="#ntuples-return-number-of-tuples-in-query-object">ntuples – return number of tuples in query object</a></li>
</ul>
</li>
</ul>
</div>
<div class="sphinxprev">
<h4>Previous page</h4>
<p class="topless"><a href="db_wrapper.html"
title="Previous page">← The DB wrapper class</a></p>
</div>
<div class="sphinxnext">
<h4>Next page</h4>
<p class="topless"><a href="large_objects.html"
title="Next page">→ LargeObject – Large Objects</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/contents/pg/query.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="relbar-bottom">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="large_objects.html" title="LargeObject – Large Objects"
>next</a> </li>
<li class="right" >
<a href="db_wrapper.html" title="The DB wrapper class"
>previous</a> </li>
<li><a href="../index.html">PyGreSQL 5.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" ><code class="docutils literal"><span class="pre">pg</span></code> — The Classic PyGreSQL Interface</a> »</li>
</ul>
</div>
</div>
<div class="footer" role="contentinfo">
© <a href="../../copyright.html">Copyright</a> 2016, The PyGreSQL team.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.1.
</div>
<!-- cloud_sptheme 1.4 -->
</body>
</html>
|
