spin-python-sdk/docs/v4/sqlite.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
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
<!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.sqlite API documentation</title>
<meta name="description" content="Module for interacting with an SQLite 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.sqlite</code></h1>
</header>
<section id="section-intro">
<p>Module for interacting with an SQLite database</p>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="spin_sdk.sqlite.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_sqlite_sqlite_3_1_0.Connection" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_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: sqlite.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, name: str) -&gt; Self:
        &#34;&#34;&#34;Open a connection to a named database instance.

        If `database` is &#34;default&#34;, the default instance is opened.

        A `componentize_py_types.Err(spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_AccessDenied)` will be raised when the component does not have access to the specified database.

        A `componentize_py_types.Err(spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_NoSuchDatabase)` will be raised when the host does not recognize the database name requested.

        A `componentize_py_types.Err(spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_InvalidConnection)` will be raised when the provided connection string is not valid.

        A `componentize_py_types.Err(spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_Io(str))` will be raised when implementation-specific error occured (e.g. I/O)
        &#34;&#34;&#34;
        return cls(await sqlite.Connection.open_async(name))

    @classmethod
    async def open_default(cls) -&gt; Self:
        &#34;&#34;&#34;Open the default store.

        A `componentize_py_types.Err(spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_AccessDenied)` will be raised when the component does not have access to the default database.

        A `componentize_py_types.Err(spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_Io(str))` will be raised when implementation-specific error occured (e.g. I/O)
        &#34;&#34;&#34;
        return cls(await sqlite.Connection.open_async(&#34;default&#34;))

    async def execute(self, statement: str, params: List[Value]) -&gt; Tuple[List[str], StreamReader[RowResult], FutureReader[Result[None, Error]]]:
        &#34;&#34;&#34;
        Execute a command to the database.

        Returns a Tuple containing a List of columns, a List of RowResults 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_sqlite_sqlite_3_1_0.Error)`
        &#34;&#34;&#34;
        return await self.connection.execute_async(statement, params)

    async def last_insert_rowid(self) -&gt; int:
        &#34;&#34;&#34;
        The SQLite rowid of the most recent successful INSERT on the connection, or 0 if
        there has not yet been an INSERT on the connection.
        &#34;&#34;&#34;
        return await self.connection.last_insert_rowid_async()

    async def changes(self) -&gt; int:
        &#34;&#34;&#34;
        The number of rows modified, inserted or deleted by the most recently completed
        INSERT, UPDATE or DELETE statement on the connection.
        &#34;&#34;&#34;
        return await self.connection.changes_async()</code></pre>
</details>
<div class="desc"></div>
<h3>Static methods</h3>
<dl>
<dt id="spin_sdk.sqlite.Connection.open"><code class="name flex">
<span>async def <span class="ident">open</span></span>(<span>name: str) ‑> Self</span>
</code></dt>
<dd>
<div class="desc"><p>Open a connection to a named database instance.</p>
<p>If <code>database</code> is "default", the default instance is opened.</p>
<p>A <code>componentize_py_types.Err(<a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_AccessDenied" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_AccessDenied">Error_AccessDenied</a>)</code> will be raised when the component does not have access to the specified database.</p>
<p>A <code>componentize_py_types.Err(<a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_NoSuchDatabase" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_NoSuchDatabase">Error_NoSuchDatabase</a>)</code> will be raised when the host does not recognize the database name requested.</p>
<p>A <code>componentize_py_types.Err(<a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_InvalidConnection" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_InvalidConnection">Error_InvalidConnection</a>)</code> will be raised when the provided connection string is not valid.</p>
<p>A <code>componentize_py_types.Err(<a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_Io" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_Io">Error_Io</a>(str))</code> will be raised when implementation-specific error occured (e.g. I/O)</p></div>
</dd>
<dt id="spin_sdk.sqlite.Connection.open_default"><code class="name flex">
<span>async def <span class="ident">open_default</span></span>(<span>) ‑> Self</span>
</code></dt>
<dd>
<div class="desc"><p>Open the default store.</p>
<p>A <code>componentize_py_types.Err(<a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_AccessDenied" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_AccessDenied">Error_AccessDenied</a>)</code> will be raised when the component does not have access to the default database.</p>
<p>A <code>componentize_py_types.Err(<a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_Io" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_Io">Error_Io</a>(str))</code> will be raised when implementation-specific error occured (e.g. I/O)</p></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="spin_sdk.sqlite.Connection.changes"><code class="name flex">
<span>async def <span class="ident">changes</span></span>(<span>self) ‑> int</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def changes(self) -&gt; int:
    &#34;&#34;&#34;
    The number of rows modified, inserted or deleted by the most recently completed
    INSERT, UPDATE or DELETE statement on the connection.
    &#34;&#34;&#34;
    return await self.connection.changes_async()</code></pre>
</details>
<div class="desc"><p>The number of rows modified, inserted or deleted by the most recently completed
INSERT, UPDATE or DELETE statement on the connection.</p></div>
</dd>
<dt id="spin_sdk.sqlite.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_sqlite_sqlite_3_1_0.Value_Integer" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Value_Integer">Value_Integer</a> | <a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Value_Real" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Value_Real">Value_Real</a> | <a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Value_Text" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Value_Text">Value_Text</a> | <a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Value_Blob" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Value_Blob">Value_Blob</a> | <a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Value_Null" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Value_Null">Value_Null</a>]) ‑> Tuple[List[str], componentize_py_async_support.streams.StreamReader[<a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.RowResult" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.RowResult">RowResult</a>], componentize_py_async_support.futures.FutureReader[componentize_py_types.Ok[None] | componentize_py_types.Err[<a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_NoSuchDatabase" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_NoSuchDatabase">Error_NoSuchDatabase</a> | <a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_AccessDenied" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_AccessDenied">Error_AccessDenied</a> | <a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_InvalidConnection" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_InvalidConnection">Error_InvalidConnection</a> | <a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_DatabaseFull" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_DatabaseFull">Error_DatabaseFull</a> | <a title="spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_Io" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error_Io">Error_Io</a>]]]</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[Value]) -&gt; Tuple[List[str], StreamReader[RowResult], FutureReader[Result[None, Error]]]:
    &#34;&#34;&#34;
    Execute a command to the database.

    Returns a Tuple containing a List of columns, a List of RowResults 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_sqlite_sqlite_3_1_0.Error)`
    &#34;&#34;&#34;
    return await self.connection.execute_async(statement, params)</code></pre>
</details>
<div class="desc"><p>Execute a command to the database.</p>
<p>Returns a Tuple containing a List of columns, a List of RowResults 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_sqlite_sqlite_3_1_0.Error" href="wit/imports/spin_sqlite_sqlite_3_1_0.html#spin_sdk.wit.imports.spin_sqlite_sqlite_3_1_0.Error">Error</a>)</code></p></div>
</dd>
<dt id="spin_sdk.sqlite.Connection.last_insert_rowid"><code class="name flex">
<span>async def <span class="ident">last_insert_rowid</span></span>(<span>self) ‑> int</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def last_insert_rowid(self) -&gt; int:
    &#34;&#34;&#34;
    The SQLite rowid of the most recent successful INSERT on the connection, or 0 if
    there has not yet been an INSERT on the connection.
    &#34;&#34;&#34;
    return await self.connection.last_insert_rowid_async()</code></pre>
</details>
<div class="desc"><p>The SQLite rowid of the most recent successful INSERT on the connection, or 0 if
there has not yet been an INSERT on the connection.</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.sqlite.Connection" href="#spin_sdk.sqlite.Connection">Connection</a></code></h4>
<ul class="">
<li><code><a title="spin_sdk.sqlite.Connection.changes" href="#spin_sdk.sqlite.Connection.changes">changes</a></code></li>
<li><code><a title="spin_sdk.sqlite.Connection.execute" href="#spin_sdk.sqlite.Connection.execute">execute</a></code></li>
<li><code><a title="spin_sdk.sqlite.Connection.last_insert_rowid" href="#spin_sdk.sqlite.Connection.last_insert_rowid">last_insert_rowid</a></code></li>
<li><code><a title="spin_sdk.sqlite.Connection.open" href="#spin_sdk.sqlite.Connection.open">open</a></code></li>
<li><code><a title="spin_sdk.sqlite.Connection.open_default" href="#spin_sdk.sqlite.Connection.open_default">open_default</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>