mirror of
https://github.com/nim-lang/Nim.git
synced 2025-12-28 17:04:41 +00:00
683 lines
82 KiB
HTML
683 lines
82 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<!-- This file is generated by Nim. -->
|
|
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>src/db_connector/db_postgres</title>
|
|
|
|
<!-- Google fonts -->
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
|
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
|
|
|
<!-- Favicon -->
|
|
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
|
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
|
|
|
|
<!-- CSS -->
|
|
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
|
|
|
|
<!-- JS -->
|
|
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
|
|
</head>
|
|
<body>
|
|
<div class="document" id="documentId">
|
|
<div class="container">
|
|
<h1 class="title">src/db_connector/db_postgres</h1>
|
|
<div class="row">
|
|
<div class="three columns">
|
|
<div class="theme-select-wrapper">
|
|
<label for="theme-select">Theme: </label>
|
|
<select id="theme-select" onchange="setTheme(this.value)">
|
|
<option value="auto">🌗 Match OS</option>
|
|
<option value="dark">🌑 Dark</option>
|
|
<option value="light">🌕 Light</option>
|
|
</select>
|
|
</div>
|
|
<div id="global-links">
|
|
<ul class="simple-boot">
|
|
<li><a href="manual.html">Manual</a></li>
|
|
<li><a href="lib.html">Standard library</a></li>
|
|
<li> <a id="indexLink" href="theindex.html">Index</a></li>
|
|
<li><a href="compiler/theindex.html">Compiler docs</a></li>
|
|
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
|
|
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="searchInputDiv">
|
|
Search: <input type="search" id="searchInput"
|
|
oninput="search()" />
|
|
</div>
|
|
|
|
<ul class="simple simple-toc" id="toc-list">
|
|
<li><a class="reference" id="parameter-substitution_toc" href="#parameter-substitution">Parameter substitution</a></li>
|
|
<li><a class="reference" id="unix-socket_toc" href="#unix-socket">Unix Socket</a></li>
|
|
<li><a class="reference" id="examples_toc" href="#examples">Examples</a></li>
|
|
<ul class="simple"><li><a class="reference" id="examples-opening-a-connection-to-a-database_toc" href="#examples-opening-a-connection-to-a-database">Opening a connection to a database</a></li>
|
|
<li><a class="reference" id="examples-creating-a-table_toc" href="#examples-creating-a-table">Creating a table</a></li>
|
|
<li><a class="reference" id="examples-inserting-data_toc" href="#examples-inserting-data">Inserting data</a></li>
|
|
</ul><li>
|
|
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<li><a class="reference" href="#DbConn" title="DbConn = PPGconn">DbConn</a></li>
|
|
<li><a class="reference" href="#InstantRow" title="InstantRow = object">InstantRow</a></li>
|
|
<li><a class="reference" href="#Row" title="Row = seq[string]">Row</a></li>
|
|
<li><a class="reference" href="#SqlPrepared" title="SqlPrepared = distinct string">SqlPrepared</a></li>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">[]
|
|
<li><a class="reference" href="#%5B%5D%2CInstantRow%2Cint" title="`[]`(row: InstantRow; col: int): string">`[]`(row: InstantRow; col: int): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">close
|
|
<li><a class="reference" href="#close%2CDbConn" title="close(db: DbConn)">close(db: DbConn)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">dbError
|
|
<li><a class="reference" href="#dbError%2CDbConn" title="dbError(db: DbConn)">dbError(db: DbConn)</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">dbQuote
|
|
<li><a class="reference" href="#dbQuote%2Cstring" title="dbQuote(s: string): string">dbQuote(s: string): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">exec
|
|
<li><a class="reference" href="#exec%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="exec(db: DbConn; query: SqlQuery; args: varargs[string, `$`])">exec(db: DbConn; query: SqlQuery; args: varargs[string, `$`])</a></li>
|
|
<li><a class="reference" href="#exec%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%5D" title="exec(db: DbConn; stmtName: SqlPrepared; args: varargs[string])">exec(db: DbConn; stmtName: SqlPrepared; args: varargs[string])</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">execAffectedRows
|
|
<li><a class="reference" href="#execAffectedRows%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="execAffectedRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64">execAffectedRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64</a></li>
|
|
<li><a class="reference" href="#execAffectedRows%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D" title="execAffectedRows(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): int64">execAffectedRows(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): int64</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getAllRows
|
|
<li><a class="reference" href="#getAllRows%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="getAllRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): seq[Row]">getAllRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): seq[Row]</a></li>
|
|
<li><a class="reference" href="#getAllRows%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D" title="getAllRows(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): seq[
|
|
Row]">getAllRows(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): seq[
|
|
Row]</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getRow
|
|
<li><a class="reference" href="#getRow%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="getRow(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row">getRow(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row</a></li>
|
|
<li><a class="reference" href="#getRow%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D" title="getRow(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): Row">getRow(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): Row</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">getValue
|
|
<li><a class="reference" href="#getValue%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="getValue(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): string">getValue(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): string</a></li>
|
|
<li><a class="reference" href="#getValue%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D" title="getValue(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): string">getValue(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): string</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">insert
|
|
<li><a class="reference" href="#insert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D" title="insert(db: DbConn; query: SqlQuery; pkName: string; args: varargs[string, `$`]): int64">insert(db: DbConn; query: SqlQuery; pkName: string; args: varargs[string, `$`]): int64</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">insertID
|
|
<li><a class="reference" href="#insertID%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="insertID(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64">insertID(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">len
|
|
<li><a class="reference" href="#len%2CInstantRow" title="len(row: InstantRow): int">len(row: InstantRow): int</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">open
|
|
<li><a class="reference" href="#open%2Cstring%2Cstring%2Cstring%2Cstring" title="open(connection, user, password, database: string): DbConn">open(connection, user, password, database: string): DbConn</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">prepare
|
|
<li><a class="reference" href="#prepare%2CDbConn%2Cstring%2CSqlQuery%2Cint" title="prepare(db: DbConn; stmtName: string; query: SqlQuery; nParams: int): SqlPrepared">prepare(db: DbConn; stmtName: string; query: SqlQuery; nParams: int): SqlPrepared</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">setEncoding
|
|
<li><a class="reference" href="#setEncoding%2CDbConn%2Cstring" title="setEncoding(connection: DbConn; encoding: string): bool">setEncoding(connection: DbConn; encoding: string): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">tryExec
|
|
<li><a class="reference" href="#tryExec%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="tryExec(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): bool">tryExec(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): bool</a></li>
|
|
<li><a class="reference" href="#tryExec%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D" title="tryExec(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): bool">tryExec(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): bool</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">tryInsert
|
|
<li><a class="reference" href="#tryInsert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D" title="tryInsert(db: DbConn; query: SqlQuery; pkName: string;
|
|
args: varargs[string, `$`]): int64">tryInsert(db: DbConn; query: SqlQuery; pkName: string;
|
|
args: varargs[string, `$`]): int64</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">tryInsertID
|
|
<li><a class="reference" href="#tryInsertID%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="tryInsertID(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64">tryInsertID(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">unsafeColumnAt
|
|
<li><a class="reference" href="#unsafeColumnAt%2CInstantRow%2Cint" title="unsafeColumnAt(row: InstantRow; index: int): cstring">unsafeColumnAt(row: InstantRow; index: int): cstring</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<details open>
|
|
<summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
|
|
<ul class="simple simple-toc-section">
|
|
<ul class="simple nested-toc-section">fastRows
|
|
<li><a class="reference" href="#fastRows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="fastRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row">fastRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row</a></li>
|
|
<li><a class="reference" href="#fastRows.i%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D" title="fastRows(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): Row">fastRows(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): Row</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">instantRows
|
|
<li><a class="reference" href="#instantRows.i%2CDbConn%2CDbColumns%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="instantRows(db: DbConn; columns: var DbColumns; query: SqlQuery;
|
|
args: varargs[string, `$`]): InstantRow">instantRows(db: DbConn; columns: var DbColumns; query: SqlQuery;
|
|
args: varargs[string, `$`]): InstantRow</a></li>
|
|
<li><a class="reference" href="#instantRows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="instantRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): InstantRow">instantRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): InstantRow</a></li>
|
|
<li><a class="reference" href="#instantRows.i%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D" title="instantRows(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): InstantRow">instantRows(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): InstantRow</a></li>
|
|
|
|
</ul>
|
|
<ul class="simple nested-toc-section">rows
|
|
<li><a class="reference" href="#rows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="rows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row">rows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row</a></li>
|
|
<li><a class="reference" href="#rows.i%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D" title="rows(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): Row">rows(db: DbConn; stmtName: SqlPrepared; args: varargs[string, `$`]): Row</a></li>
|
|
|
|
</ul>
|
|
|
|
</ul>
|
|
</details>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#19" id="69">Exports</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
<div class="nine columns" id="content">
|
|
|
|
<div id="tocRoot"></div>
|
|
|
|
<p class="module-desc"><div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
|
|
In order to use this module, run <tt class="docutils literal"><span class="pre"><span class="Identifier">nimble</span> <span class="Identifier">install</span> <span class="Identifier">db_connector</span></span></tt>.</div>
|
|
<p>A higher level <span id="postgresql_1">PostgreSQL</span> database wrapper. This interface is implemented for other databases also.</p>
|
|
<p>See also: <a class="reference external" href="db_odbc.html">db_odbc</a>, <a class="reference external" href="db_sqlite.html">db_sqlite</a>, <a class="reference external" href="db_mysql.html">db_mysql</a>.</p>
|
|
|
|
<h1><a class="toc-backref" id="parameter-substitution" href="#parameter-substitution">Parameter substitution</a></h1><p>All <tt class="docutils literal"><span class="pre"><span class="Identifier">db_</span><span class="Operator">*</span></span></tt> modules support the same form of parameter substitution. That is, using the <tt class="docutils literal"><span class="pre"><span class="Operator">?</span></span></tt> (question mark) to signify the place where a value should be placed. For example:</p>
|
|
<p><pre class="listing"><span class="RawData">sql"INSERT INTO myTable (colA, colB, colC) VALUES (?, ?, ?)"</span></pre></p>
|
|
<p><strong>Note</strong>: There are two approaches to parameter substitution support by this module.</p>
|
|
<ol class="simple"><li><tt class="docutils literal"><span class="pre"><span class="Identifier">SqlQuery</span></span></tt> using <tt class="docutils literal"><span class="pre"><span class="Operator">?</span><span class="Punctuation">,</span> <span class="Operator">?</span><span class="Punctuation">,</span> <span class="Operator">?</span><span class="Punctuation">,</span> <span class="Operator">...</span></span></tt> (same as all the <tt class="docutils literal"><span class="pre"><span class="Identifier">db_</span><span class="Operator">*</span></span></tt> modules)</li>
|
|
<li><tt class="docutils literal"><span class="pre"><span class="Identifier">SqlPrepared</span></span></tt> using <tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="Operator">$</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Operator">$</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="Operator">...</span></span></tt></li>
|
|
</ol>
|
|
<p><pre class="listing"><span class="Identifier">prepare</span><span class="Punctuation">(</span><span class="Identifier">db</span><span class="Punctuation">,</span> <span class="StringLit">"myExampleInsert"</span><span class="Punctuation">,</span>
|
|
<span class="LongStringLit">sql"""INSERT INTO myTable
|
|
(colA, colB, colC)
|
|
VALUES ($1, $2, $3)"""</span><span class="Punctuation">,</span>
|
|
<span class="DecNumber">3</span><span class="Punctuation">)</span></pre></p>
|
|
|
|
<h1><a class="toc-backref" id="unix-socket" href="#unix-socket">Unix Socket</a></h1><p>Using Unix sockets instead of TCP connection can <a class="reference external" href="https://momjian.us/main/blogs/pgblog/2012.html#June_6_2012">improve performance up to 30% ~ 175% for some operations</a>.</p>
|
|
<p>To use Unix sockets with <tt class="docutils literal"><span class="pre"><span class="Identifier">db_postgres</span></span></tt>, change the server address to the socket file path:</p>
|
|
<p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">db_connector</span><span class="Operator">/</span><span class="Identifier">db_postgres</span> <span class="Comment">## Change "localhost" or "127.0.0.1" to the socket file path</span>
|
|
<span class="Keyword">let</span> <span class="Identifier">db</span> <span class="Operator">=</span> <span class="Identifier">db_postgres</span><span class="Operator">.</span><span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">"/run/postgresql"</span><span class="Punctuation">,</span> <span class="StringLit">"user"</span><span class="Punctuation">,</span> <span class="StringLit">"password"</span><span class="Punctuation">,</span> <span class="StringLit">"database"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">echo</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getAllRows</span><span class="Punctuation">(</span><span class="RawData">sql"SELECT version();"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
|
|
<p>The socket file path is operating system specific and distribution specific, additional configuration may or may not be needed on your <tt class="docutils literal"><span class="pre"><span class="Identifier">postgresql</span><span class="Operator">.</span><span class="Identifier">conf</span></span></tt>. The Postgres server must be on the same computer and only works for Unix-like operating systems.</p>
|
|
|
|
<h1><a class="toc-backref" id="examples" href="#examples">Examples</a></h1>
|
|
<h2><a class="toc-backref" id="examples-opening-a-connection-to-a-database" href="#examples-opening-a-connection-to-a-database">Opening a connection to a database</a></h2><p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">db_connector</span><span class="Operator">/</span><span class="Identifier">db_postgres</span>
|
|
<span class="Keyword">let</span> <span class="Identifier">db</span> <span class="Operator">=</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">"localhost"</span><span class="Punctuation">,</span> <span class="StringLit">"user"</span><span class="Punctuation">,</span> <span class="StringLit">"password"</span><span class="Punctuation">,</span> <span class="StringLit">"dbname"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
|
|
|
|
<h2><a class="toc-backref" id="examples-creating-a-table" href="#examples-creating-a-table">Creating a table</a></h2><p><pre class="listing"><span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql"DROP TABLE IF EXISTS myTable"</span><span class="Punctuation">)</span>
|
|
<span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="Identifier">sql</span><span class="Punctuation">(</span><span class="LongStringLit">"""CREATE TABLE myTable (
|
|
id integer,
|
|
name varchar(50) not null)"""</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre></p>
|
|
|
|
<h2><a class="toc-backref" id="examples-inserting-data" href="#examples-inserting-data">Inserting data</a></h2><p><pre class="listing"><span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql"INSERT INTO myTable (id, name) VALUES (0, ?)"</span><span class="Punctuation">,</span>
|
|
<span class="StringLit">"Dominik"</span><span class="Punctuation">)</span></pre></p>
|
|
</p>
|
|
<div class="section" id="6">
|
|
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
|
<dl class="item">
|
|
<a class="reference external" href="postgres.html">postgres</a>, <a class="reference external" href="db_common.html">db_common</a>, <a class="reference external" href="dbutils.html">dbutils</a>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="7">
|
|
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
|
<dl class="item">
|
|
<div id="DbConn">
|
|
<dt><pre><a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a> <span class="Other">=</span> <a href="postgres.html#PPGconn"><span class="Identifier">PPGconn</span></a></pre></dt>
|
|
<dd>
|
|
|
|
encapsulates a database connection
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="InstantRow">
|
|
<dt><pre><a href="db_postgres.html#InstantRow"><span class="Identifier">InstantRow</span></a> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
|
|
<dd>
|
|
|
|
a handle that can be
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="Row">
|
|
<dt><pre><a href="db_postgres.html#Row"><span class="Identifier">Row</span></a> <span class="Other">=</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span></pre></dt>
|
|
<dd>
|
|
|
|
a row of a dataset. NULL database values will be converted to nil.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="SqlPrepared">
|
|
<dt><pre><a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <span class="Identifier">string</span></pre></dt>
|
|
<dd>
|
|
|
|
a identifier for the prepared queries
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="12">
|
|
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
|
<dl class="item">
|
|
<div id="[]-procs-all">
|
|
<div id="[],InstantRow,int">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2CInstantRow%2Cint"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">row</span><span class="Other">:</span> <a href="db_postgres.html#InstantRow"><span class="Identifier">InstantRow</span></a><span class="Other">;</span> <span class="Identifier">col</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
returns text for given column of the row
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="close-procs-all">
|
|
<div id="close,DbConn">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#close%2CDbConn"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#DbEffect"><span class="Identifier">DbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
closes the database connection.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="dbError-procs-all">
|
|
<div id="dbError,DbConn">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#dbError%2CDbConn"><span class="Identifier">dbError</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">)</span> {.<span class="Identifier">noreturn</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
raises a DbError exception.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="dbQuote-procs-all">
|
|
<div id="dbQuote,string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#dbQuote%2Cstring"><span class="Identifier">dbQuote</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
DB quotes the string.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="exec-procs-all">
|
|
<div id="exec,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#exec%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">exec</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query and raises EDB if not successful.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="exec,DbConn,SqlPrepared,varargs[string]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#exec%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%5D"><span class="Identifier">exec</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">)</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="execAffectedRows-procs-all">
|
|
<div id="execAffectedRows,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#execAffectedRows%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">execAffectedRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int64</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query (typically "UPDATE") and returns the number of affected rows.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="execAffectedRows,DbConn,SqlPrepared,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#execAffectedRows%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">execAffectedRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span>
|
|
<span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int64</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query (typically "UPDATE") and returns the number of affected rows.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getAllRows-procs-all">
|
|
<div id="getAllRows,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getAllRows%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">getAllRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span>
|
|
<a href="db_postgres.html#Row"><span class="Identifier">Row</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query and returns the whole result dataset.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="getAllRows,DbConn,SqlPrepared,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getAllRows%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">getAllRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span>
|
|
<a href="db_postgres.html#Row"><span class="Identifier">Row</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the prepared query and returns the whole result dataset.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getRow-procs-all">
|
|
<div id="getRow,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getRow%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">getRow</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#Row"><span class="Identifier">Row</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
retrieves a single row. If the query doesn't return any rows, this proc will return a Row with empty strings for each column.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="getRow,DbConn,SqlPrepared,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getRow%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">getRow</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#Row"><span class="Identifier">Row</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="getValue-procs-all">
|
|
<div id="getValue,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getValue%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">getValue</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query and returns the first column of the first row of the result dataset. Returns "" if the dataset contains no rows or the database value is NULL.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="getValue,DbConn,SqlPrepared,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#getValue%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">getValue</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query and returns the first column of the first row of the result dataset. Returns "" if the dataset contains no rows or the database value is NULL.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="insert-procs-all">
|
|
<div id="insert,DbConn,SqlQuery,string,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#insert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">insert</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">pkName</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span>
|
|
<span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int64</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query (typically "INSERT") and returns the generated ID
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="insertID-procs-all">
|
|
<div id="insertID,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#insertID%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">insertID</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int64</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query (typically "INSERT") and returns the generated ID for the row. For Postgre this adds <tt class="docutils literal"><span class="pre"><span class="Identifier">RETURNING</span> <span class="Identifier">id</span></span></tt> to the query, so it only works if your primary key is named <tt class="docutils literal"><span class="pre"><span class="Identifier">id</span></span></tt>.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="len-procs-all">
|
|
<div id="len,InstantRow">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#len%2CInstantRow"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">row</span><span class="Other">:</span> <a href="db_postgres.html#InstantRow"><span class="Identifier">InstantRow</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
returns number of columns in the row
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="open-procs-all">
|
|
<div id="open,string,string,string,string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#open%2Cstring%2Cstring%2Cstring%2Cstring"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">connection</span><span class="Other">,</span> <span class="Identifier">user</span><span class="Other">,</span> <span class="Identifier">password</span><span class="Other">,</span> <span class="Identifier">database</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#DbEffect"><span class="Identifier">DbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
<p>opens a database connection. Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">EDb</span></span></tt> if the connection could not be established.</p>
|
|
<p>Clients can also use Postgres keyword/value connection strings to connect.</p>
|
|
<p>Example:</p>
|
|
<p><pre class="listing"><span class="Identifier">con</span> <span class="Operator">=</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">"host=localhost port=5432 dbname=mydb"</span><span class="Punctuation">)</span></pre></p>
|
|
<p>See <a class="reference external" href="http://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING">http://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING</a> for more information.</p>
|
|
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="prepare-procs-all">
|
|
<div id="prepare,DbConn,string,SqlQuery,int">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#prepare%2CDbConn%2Cstring%2CSqlQuery%2Cint"><span class="Identifier">prepare</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">nParams</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SqlPrepared</span></span></tt> statement. Parameter substitution is done via <tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="DecNumber">1</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="DecNumber">2</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="DecNumber">3</span></span></tt>, etc.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="setEncoding-procs-all">
|
|
<div id="setEncoding,DbConn,string">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#setEncoding%2CDbConn%2Cstring"><span class="Identifier">setEncoding</span></a><span class="Other">(</span><span class="Identifier">connection</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">encoding</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#DbEffect"><span class="Identifier">DbEffect</span></a><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
sets the encoding of a database connection, returns true for success, false for failure.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="tryExec-procs-all">
|
|
<div id="tryExec,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#tryExec%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">tryExec</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
tries to execute the query and returns true if successful, false otherwise.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="tryExec,DbConn,SqlPrepared,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#tryExec%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">tryExec</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
tries to execute the query and returns true if successful, false otherwise.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="tryInsert-procs-all">
|
|
<div id="tryInsert,DbConn,SqlQuery,string,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#tryInsert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">tryInsert</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">pkName</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span>
|
|
<span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int64</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query (typically "INSERT") and returns the generated ID for the row or -1 in case of an error.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="tryInsertID-procs-all">
|
|
<div id="tryInsertID,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#tryInsertID%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">tryInsertID</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int64</span> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query (typically "INSERT") and returns the generated ID for the row or -1 in case of an error. For Postgre this adds <tt class="docutils literal"><span class="pre"><span class="Identifier">RETURNING</span> <span class="Identifier">id</span></span></tt> to the query, so it only works if your primary key is named <tt class="docutils literal"><span class="pre"><span class="Identifier">id</span></span></tt>.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="unsafeColumnAt-procs-all">
|
|
<div id="unsafeColumnAt,InstantRow,int">
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#unsafeColumnAt%2CInstantRow%2Cint"><span class="Identifier">unsafeColumnAt</span></a><span class="Other">(</span><span class="Identifier">row</span><span class="Other">:</span> <a href="db_postgres.html#InstantRow"><span class="Identifier">InstantRow</span></a><span class="Other">;</span> <span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cstring</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
|
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
Return cstring of given column of the row
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="15">
|
|
<h1><a class="toc-backref" href="#15">Iterators</a></h1>
|
|
<dl class="item">
|
|
<div id="fastRows-iterators-all">
|
|
<div id="fastRows.i,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">iterator</span> <a href="#fastRows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">fastRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#Row"><span class="Identifier">Row</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query and iterates over the result dataset. This is very fast, but potentially dangerous: If the for-loop-body executes another query, the results can be undefined. For Postgres it is safe though.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="fastRows.i,DbConn,SqlPrepared,varargs[string,]">
|
|
<dt><pre><span class="Keyword">iterator</span> <a href="#fastRows.i%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">fastRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#Row"><span class="Identifier">Row</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
executes the query and iterates over the result dataset. This is very fast, but potentially dangerous: If the for-loop-body executes another query, the results can be undefined. For Postgres it is safe though.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="instantRows-iterators-all">
|
|
<div id="instantRows.i,DbConn,DbColumns,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">iterator</span> <a href="#instantRows.i%2CDbConn%2CDbColumns%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">instantRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">columns</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="db_common.html#DbColumns"><span class="Identifier">DbColumns</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span>
|
|
<span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#InstantRow"><span class="Identifier">InstantRow</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="instantRows.i,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">iterator</span> <a href="#instantRows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">instantRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#InstantRow"><span class="Identifier">InstantRow</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
same as fastRows but returns a handle that can be used to get column text on demand using <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Punctuation">]</span></span></tt>. Returned handle is valid only within iterator body.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="instantRows.i,DbConn,SqlPrepared,varargs[string,]">
|
|
<dt><pre><span class="Keyword">iterator</span> <a href="#instantRows.i%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">instantRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span>
|
|
<span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#InstantRow"><span class="Identifier">InstantRow</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
same as fastRows but returns a handle that can be used to get column text on demand using <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Punctuation">]</span></span></tt>. Returned handle is valid only within iterator body.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
<div id="rows-iterators-all">
|
|
<div id="rows.i,DbConn,SqlQuery,varargs[string,]">
|
|
<dt><pre><span class="Keyword">iterator</span> <a href="#rows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">rows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">query</span><span class="Other">:</span> <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#Row"><span class="Identifier">Row</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
same as <tt class="docutils literal"><span class="pre"><span class="Identifier">fastRows</span></span></tt>, but slower and safe.
|
|
|
|
</dd>
|
|
</div>
|
|
<div id="rows.i,DbConn,SqlPrepared,varargs[string,]">
|
|
<dt><pre><span class="Keyword">iterator</span> <a href="#rows.i%2CDbConn%2CSqlPrepared%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">rows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_postgres.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_postgres.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="db_postgres.html#Row"><span class="Identifier">Row</span></a> {.
|
|
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
|
<dd>
|
|
|
|
same as <tt class="docutils literal"><span class="pre"><span class="Identifier">fastRows</span></span></tt>, but slower and safe.
|
|
|
|
</dd>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="19">
|
|
<h1><a class="toc-backref" href="#19">Exports</a></h1>
|
|
<dl class="item">
|
|
<a href="db_common.html#DbTypeKind"><span class="Identifier">DbTypeKind</span></a>, <a href="db_common.html#sql.t,string"><span class="Identifier">sql</span></a>, <a href="db_common.html#DbType"><span class="Identifier">DbType</span></a>, <a href="db_common.html#SqlQuery"><span class="Identifier">SqlQuery</span></a>, <a href="db_common.html#DbColumn"><span class="Identifier">DbColumn</span></a>, <a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a>, <a href="db_common.html#DbError"><span class="Identifier">DbError</span></a>, <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a>, <a href="db_common.html#dbError,string"><span class="Identifier">dbError</span></a>, <a href="db_common.html#DbColumns"><span class="Identifier">DbColumns</span></a>, <a href="db_common.html#DbEffect"><span class="Identifier">DbEffect</span></a>
|
|
</dl>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="twelve-columns footer">
|
|
<span class="nim-sprite"></span>
|
|
<br>
|
|
<small style="color: var(--hint);">Made with Nim. Generated: 2025-12-25 20:14:11 UTC</small>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
|
|
|
|
</body>
|
|
</html>
|