spin-python-sdk/docs/v4/postgres.html at 022f16b5af24fce60c42d8329212f9fed9b1cae0 · vdice/spin-python-sdk · GitHub

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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>spin_sdk.postgres API documentation</title>
<meta name="description" content="Module for interacting with a Postgres database">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>spin_sdk.postgres</code></h1>
</header>
<section id="section-intro">
<p>Module for interacting with a Postgres database</p>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="spin_sdk.postgres.Connection"><code class="flex name class">
<span>class <span class="ident">Connection</span></span>
<span>(</span><span>connection: <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Connection" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Connection">Connection</a>)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Connection:
    def __init__(self, connection: pg.Connection) -&gt; None:
        self.connection = connection

    def __enter__(self) -&gt; Self:
        return self

    def __exit__(self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None) -&gt; bool | None:
        return self.connection.__exit__(exc_type, exc_value, traceback)

    @classmethod
    async def open(cls, connection_string: str) -&gt; Self:
        &#34;&#34;&#34;
        Open a connection with a Postgres database.

        The connection_string is the Postgres URL connection string.

        A `componentize_py_types.Err(Error_ConnectionFailed(str))` when a connection fails.

        A `componentize_py_types.Err(Error_Other(str))` when some other error occurs.
        &#34;&#34;&#34;
        return cls(await pg.Connection.open_async(connection_string))

    async def query(self, statement: str, params: List[ParameterValue]) -&gt; Tuple[List[Column], StreamReader[List[DbValue]], FutureReader[Result[None, Error]]]:
        &#34;&#34;&#34;
        Query the Postgres database.

        Returns a Tuple containing a List of Columns, a List of DbValues encapsulated in an asynchronous iterator (`componentize_py_async_support.streams.StreamReader`),
        and a future (`componentize_py_async_support.futures.FutureReader`) containing the result of the operation.

        Raises: `componentize_py_types.Err(spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error)`
        &#34;&#34;&#34;
        return await self.connection.query_async(statement, params)

    async def execute(self, statement: str, params: List[ParameterValue]) -&gt; int:
        &#34;&#34;&#34;
        Execute command to the database.

        Returns the number of affected rows as an int.

        Raises: `componentize_py_types.Err(spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error)`
        &#34;&#34;&#34;
        return await self.connection.execute_async(statement, params)</code></pre>
</details>
<div class="desc"></div>
<h3>Static methods</h3>
<dl>
<dt id="spin_sdk.postgres.Connection.open"><code class="name flex">
<span>async def <span class="ident">open</span></span>(<span>connection_string: str) ‑> Self</span>
</code></dt>
<dd>
<div class="desc"><p>Open a connection with a Postgres database.</p>
<p>The connection_string is the Postgres URL connection string.</p>
<p>A <code>componentize_py_types.Err(Error_ConnectionFailed(str))</code> when a connection fails.</p>
<p>A <code>componentize_py_types.Err(Error_Other(str))</code> when some other error occurs.</p></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="spin_sdk.postgres.Connection.execute"><code class="name flex">
<span>async def <span class="ident">execute</span></span>(<span>self,<br>statement: str,<br>params: List[<a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Boolean" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Boolean">ParameterValue_Boolean</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int8" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int8">ParameterValue_Int8</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int16" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int16">ParameterValue_Int16</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int32">ParameterValue_Int32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int64">ParameterValue_Int64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Floating32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Floating32">ParameterValue_Floating32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Floating64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Floating64">ParameterValue_Floating64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Str" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Str">ParameterValue_Str</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Binary" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Binary">ParameterValue_Binary</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Date" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Date">ParameterValue_Date</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Time" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Time">ParameterValue_Time</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Datetime" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Datetime">ParameterValue_Datetime</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Timestamp" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Timestamp">ParameterValue_Timestamp</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Uuid" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Uuid">ParameterValue_Uuid</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Jsonb" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Jsonb">ParameterValue_Jsonb</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Decimal" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Decimal">ParameterValue_Decimal</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeInt32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeInt32">ParameterValue_RangeInt32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeInt64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeInt64">ParameterValue_RangeInt64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeDecimal" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeDecimal">ParameterValue_RangeDecimal</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayInt32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayInt32">ParameterValue_ArrayInt32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayInt64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayInt64">ParameterValue_ArrayInt64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayDecimal" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayDecimal">ParameterValue_ArrayDecimal</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayStr" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayStr">ParameterValue_ArrayStr</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Interval" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Interval">ParameterValue_Interval</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_DbNull" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_DbNull">ParameterValue_DbNull</a>]) ‑> int</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def execute(self, statement: str, params: List[ParameterValue]) -&gt; int:
    &#34;&#34;&#34;
    Execute command to the database.

    Returns the number of affected rows as an int.

    Raises: `componentize_py_types.Err(spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error)`
    &#34;&#34;&#34;
    return await self.connection.execute_async(statement, params)</code></pre>
</details>
<div class="desc"><p>Execute command to the database.</p>
<p>Returns the number of affected rows as an int.</p>
<p>Raises: <code>componentize_py_types.Err(<a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error">Error</a>)</code></p></div>
</dd>
<dt id="spin_sdk.postgres.Connection.query"><code class="name flex">
<span>async def <span class="ident">query</span></span>(<span>self,<br>statement: str,<br>params: List[<a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Boolean" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Boolean">ParameterValue_Boolean</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int8" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int8">ParameterValue_Int8</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int16" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int16">ParameterValue_Int16</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int32">ParameterValue_Int32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Int64">ParameterValue_Int64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Floating32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Floating32">ParameterValue_Floating32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Floating64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Floating64">ParameterValue_Floating64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Str" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Str">ParameterValue_Str</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Binary" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Binary">ParameterValue_Binary</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Date" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Date">ParameterValue_Date</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Time" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Time">ParameterValue_Time</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Datetime" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Datetime">ParameterValue_Datetime</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Timestamp" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Timestamp">ParameterValue_Timestamp</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Uuid" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Uuid">ParameterValue_Uuid</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Jsonb" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Jsonb">ParameterValue_Jsonb</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Decimal" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Decimal">ParameterValue_Decimal</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeInt32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeInt32">ParameterValue_RangeInt32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeInt64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeInt64">ParameterValue_RangeInt64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeDecimal" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_RangeDecimal">ParameterValue_RangeDecimal</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayInt32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayInt32">ParameterValue_ArrayInt32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayInt64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayInt64">ParameterValue_ArrayInt64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayDecimal" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayDecimal">ParameterValue_ArrayDecimal</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayStr" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_ArrayStr">ParameterValue_ArrayStr</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Interval" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_Interval">ParameterValue_Interval</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_DbNull" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.ParameterValue_DbNull">ParameterValue_DbNull</a>]) ‑> Tuple[List[<a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Column" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Column">Column</a>], componentize_py_async_support.streams.StreamReader[List[<a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Boolean" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Boolean">DbValue_Boolean</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Int8" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Int8">DbValue_Int8</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Int16" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Int16">DbValue_Int16</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Int32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Int32">DbValue_Int32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Int64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Int64">DbValue_Int64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Floating32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Floating32">DbValue_Floating32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Floating64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Floating64">DbValue_Floating64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Str" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Str">DbValue_Str</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Binary" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Binary">DbValue_Binary</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Date" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Date">DbValue_Date</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Time" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Time">DbValue_Time</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Datetime" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Datetime">DbValue_Datetime</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Timestamp" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Timestamp">DbValue_Timestamp</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Uuid" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Uuid">DbValue_Uuid</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Jsonb" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Jsonb">DbValue_Jsonb</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Decimal" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Decimal">DbValue_Decimal</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_RangeInt32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_RangeInt32">DbValue_RangeInt32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_RangeInt64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_RangeInt64">DbValue_RangeInt64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_RangeDecimal" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_RangeDecimal">DbValue_RangeDecimal</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_ArrayInt32" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_ArrayInt32">DbValue_ArrayInt32</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_ArrayInt64" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_ArrayInt64">DbValue_ArrayInt64</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_ArrayDecimal" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_ArrayDecimal">DbValue_ArrayDecimal</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_ArrayStr" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_ArrayStr">DbValue_ArrayStr</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Interval" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Interval">DbValue_Interval</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_DbNull" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_DbNull">DbValue_DbNull</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Unsupported" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.DbValue_Unsupported">DbValue_Unsupported</a>]], componentize_py_async_support.futures.FutureReader[componentize_py_types.Ok[None] | componentize_py_types.Err[<a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error_ConnectionFailed" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error_ConnectionFailed">Error_ConnectionFailed</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error_BadParameter" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error_BadParameter">Error_BadParameter</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error_QueryFailed" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error_QueryFailed">Error_QueryFailed</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error_ValueConversionFailed" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error_ValueConversionFailed">Error_ValueConversionFailed</a> | <a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error_Other" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error_Other">Error_Other</a>]]]</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def query(self, statement: str, params: List[ParameterValue]) -&gt; Tuple[List[Column], StreamReader[List[DbValue]], FutureReader[Result[None, Error]]]:
    &#34;&#34;&#34;
    Query the Postgres database.

    Returns a Tuple containing a List of Columns, a List of DbValues encapsulated in an asynchronous iterator (`componentize_py_async_support.streams.StreamReader`),
    and a future (`componentize_py_async_support.futures.FutureReader`) containing the result of the operation.

    Raises: `componentize_py_types.Err(spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error)`
    &#34;&#34;&#34;
    return await self.connection.query_async(statement, params)</code></pre>
</details>
<div class="desc"><p>Query the Postgres database.</p>
<p>Returns a Tuple containing a List of Columns, a List of DbValues encapsulated in an asynchronous iterator (<code>componentize_py_async_support.streams.StreamReader</code>),
and a future (<code>componentize_py_async_support.futures.FutureReader</code>) containing the result of the operation.</p>
<p>Raises: <code>componentize_py_types.Err(<a title="spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error" href="wit/imports/spin_postgres_postgres_4_2_0.html#spin_sdk.wit.imports.spin_postgres_postgres_4_2_0.Error">Error</a>)</code></p></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="spin_sdk" href="index.html">spin_sdk</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="spin_sdk.postgres.Connection" href="#spin_sdk.postgres.Connection">Connection</a></code></h4>
<ul class="">
<li><code><a title="spin_sdk.postgres.Connection.execute" href="#spin_sdk.postgres.Connection.execute">execute</a></code></li>
<li><code><a title="spin_sdk.postgres.Connection.open" href="#spin_sdk.postgres.Connection.open">open</a></code></li>
<li><code><a title="spin_sdk.postgres.Connection.query" href="#spin_sdk.postgres.Connection.query">query</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
</footer>
</body>
</html>