db_odbc.html 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>src/db_connector/db_odbc</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <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=="/>
  14. <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=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">src/db_connector/db_odbc</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li><a class="reference" id="parameter-substitution_toc" href="#parameter-substitution">Parameter substitution</a></li>
  50. <li><a class="reference" id="examples_toc" href="#examples">Examples</a></li>
  51. <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>
  52. <li><a class="reference" id="examples-creating-a-table_toc" href="#examples-creating-a-table">Creating a table</a></li>
  53. <li><a class="reference" id="examples-inserting-data_toc" href="#examples-inserting-data">Inserting data</a></li>
  54. <li><a class="reference" id="examples-large-example_toc" href="#examples-large-example">Large example</a></li>
  55. </ul><li>
  56. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  57. </li>
  58. <li>
  59. <details open>
  60. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  61. <ul class="simple simple-toc-section">
  62. <li><a class="reference" href="#DbConn" title="DbConn = OdbcConnTyp">DbConn</a></li>
  63. <li><a class="reference" href="#InstantRow" title="InstantRow = tuple[row: seq[string], len: int]">InstantRow</a></li>
  64. <li><a class="reference" href="#Row" title="Row = seq[string]">Row</a></li>
  65. </ul>
  66. </details>
  67. </li>
  68. <li>
  69. <details open>
  70. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  71. <ul class="simple simple-toc-section">
  72. <ul class="simple nested-toc-section">[]
  73. <li><a class="reference" href="#%5B%5D%2CInstantRow%2Cint" title="`[]`(row: InstantRow; col: int): string">`[]`(row: InstantRow; col: int): string</a></li>
  74. </ul>
  75. <ul class="simple nested-toc-section">close
  76. <li><a class="reference" href="#close%2CDbConn" title="close(db: var DbConn)">close(db: var DbConn)</a></li>
  77. </ul>
  78. <ul class="simple nested-toc-section">dbError
  79. <li><a class="reference" href="#dbError%2CDbConn" title="dbError(db: var DbConn)">dbError(db: var DbConn)</a></li>
  80. </ul>
  81. <ul class="simple nested-toc-section">dbQuote
  82. <li><a class="reference" href="#dbQuote%2Cstring" title="dbQuote(s: string): string">dbQuote(s: string): string</a></li>
  83. </ul>
  84. <ul class="simple nested-toc-section">exec
  85. <li><a class="reference" href="#exec%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="exec(db: var DbConn; query: SqlQuery; args: varargs[string, `$`])">exec(db: var DbConn; query: SqlQuery; args: varargs[string, `$`])</a></li>
  86. </ul>
  87. <ul class="simple nested-toc-section">execAffectedRows
  88. <li><a class="reference" href="#execAffectedRows%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="execAffectedRows(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): int64">execAffectedRows(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): int64</a></li>
  89. </ul>
  90. <ul class="simple nested-toc-section">getAllRows
  91. <li><a class="reference" href="#getAllRows%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="getAllRows(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): seq[Row]">getAllRows(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): seq[Row]</a></li>
  92. </ul>
  93. <ul class="simple nested-toc-section">getRow
  94. <li><a class="reference" href="#getRow%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="getRow(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): Row">getRow(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): Row</a></li>
  95. </ul>
  96. <ul class="simple nested-toc-section">getValue
  97. <li><a class="reference" href="#getValue%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="getValue(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): string">getValue(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): string</a></li>
  98. </ul>
  99. <ul class="simple nested-toc-section">insert
  100. <li><a class="reference" href="#insert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D" title="insert(db: var DbConn; query: SqlQuery; pkName: string;
  101. args: varargs[string, `$`]): int64">insert(db: var DbConn; query: SqlQuery; pkName: string;
  102. args: varargs[string, `$`]): int64</a></li>
  103. </ul>
  104. <ul class="simple nested-toc-section">insertId
  105. <li><a class="reference" href="#insertId%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="insertId(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): int64">insertId(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): int64</a></li>
  106. </ul>
  107. <ul class="simple nested-toc-section">len
  108. <li><a class="reference" href="#len%2CInstantRow" title="len(row: InstantRow): int">len(row: InstantRow): int</a></li>
  109. </ul>
  110. <ul class="simple nested-toc-section">open
  111. <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>
  112. </ul>
  113. <ul class="simple nested-toc-section">setEncoding
  114. <li><a class="reference" href="#setEncoding%2CDbConn%2Cstring" title="setEncoding(connection: DbConn; encoding: string): bool">setEncoding(connection: DbConn; encoding: string): bool</a></li>
  115. </ul>
  116. <ul class="simple nested-toc-section">tryExec
  117. <li><a class="reference" href="#tryExec%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="tryExec(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): bool">tryExec(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): bool</a></li>
  118. </ul>
  119. <ul class="simple nested-toc-section">tryInsert
  120. <li><a class="reference" href="#tryInsert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D" title="tryInsert(db: var DbConn; query: SqlQuery; pkName: string;
  121. args: varargs[string, `$`]): int64">tryInsert(db: var DbConn; query: SqlQuery; pkName: string;
  122. args: varargs[string, `$`]): int64</a></li>
  123. </ul>
  124. <ul class="simple nested-toc-section">tryInsertId
  125. <li><a class="reference" href="#tryInsertId%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="tryInsertId(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): int64">tryInsertId(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): int64</a></li>
  126. </ul>
  127. <ul class="simple nested-toc-section">unsafeColumnAt
  128. <li><a class="reference" href="#unsafeColumnAt%2CInstantRow%2Cint" title="unsafeColumnAt(row: InstantRow; index: int): cstring">unsafeColumnAt(row: InstantRow; index: int): cstring</a></li>
  129. </ul>
  130. </ul>
  131. </details>
  132. </li>
  133. <li>
  134. <details open>
  135. <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
  136. <ul class="simple simple-toc-section">
  137. <ul class="simple nested-toc-section">fastRows
  138. <li><a class="reference" href="#fastRows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="fastRows(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): Row">fastRows(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): Row</a></li>
  139. </ul>
  140. <ul class="simple nested-toc-section">instantRows
  141. <li><a class="reference" href="#instantRows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="instantRows(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): InstantRow">instantRows(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): InstantRow</a></li>
  142. </ul>
  143. <ul class="simple nested-toc-section">rows
  144. <li><a class="reference" href="#rows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="rows(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): Row">rows(db: var DbConn; query: SqlQuery; args: varargs[string, `$`]): Row</a></li>
  145. </ul>
  146. </ul>
  147. </details>
  148. </li>
  149. </ul>
  150. </div>
  151. <div class="nine columns" id="content">
  152. <div id="tocRoot"></div>
  153. <p class="module-desc"><div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
  154. 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>
  155. <p>A higher level <tt class="docutils literal"><span class="pre"><span class="Identifier">ODBC</span></span></tt> database wrapper.</p>
  156. <p>This is the same interface that is implemented for other databases.</p>
  157. <p>This has NOT yet been (extensively) tested against ODBC drivers for Teradata, Oracle, Sybase, MSSqlvSvr, et. al. databases.</p>
  158. <p>Currently all queries are ANSI calls, not Unicode.</p>
  159. <p>See also: <a class="reference external" href="db_postgres.html">db_postgres</a>, <a class="reference external" href="db_sqlite.html">db_sqlite</a>, <a class="reference external" href="db_mysql.html">db_mysql</a>.</p>
  160. <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>
  161. <p><pre class="listing"><span class="RawData">sql&quot;INSERT INTO myTable (colA, colB, colC) VALUES (?, ?, ?)&quot;</span></pre></p>
  162. <h1><a class="toc-backref" id="examples" href="#examples">Examples</a></h1>
  163. <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_odbc</span>
  164. <span class="Keyword">var</span> <span class="Identifier">db</span> <span class="Operator">=</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">&quot;localhost&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;user&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;password&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;dbname&quot;</span><span class="Punctuation">)</span>
  165. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
  166. <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&quot;DROP TABLE IF EXISTS myTable&quot;</span><span class="Punctuation">)</span>
  167. <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">&quot;&quot;&quot;CREATE TABLE myTable (
  168. id integer,
  169. name varchar(50) not null)&quot;&quot;&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre></p>
  170. <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&quot;INSERT INTO myTable (id, name) VALUES (0, ?)&quot;</span><span class="Punctuation">,</span>
  171. <span class="StringLit">&quot;Andreas&quot;</span><span class="Punctuation">)</span></pre></p>
  172. <h2><a class="toc-backref" id="examples-large-example" href="#examples-large-example">Large example</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_odbc</span>
  173. <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">math</span>
  174. <span class="Keyword">var</span> <span class="Identifier">theDb</span> <span class="Operator">=</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">&quot;localhost&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;nim&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;nim&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;test&quot;</span><span class="Punctuation">)</span>
  175. <span class="Identifier">theDb</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql&quot;Drop table if exists myTestTbl&quot;</span><span class="Punctuation">)</span>
  176. <span class="Identifier">theDb</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="StringLit">&quot;create table myTestTbl (&quot;</span> <span class="Operator">&amp;</span>
  177. <span class="StringLit">&quot; Id INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY, &quot;</span> <span class="Operator">&amp;</span>
  178. <span class="StringLit">&quot; Name VARCHAR(50) NOT NULL, &quot;</span> <span class="Operator">&amp;</span>
  179. <span class="StringLit">&quot; i INT(11), &quot;</span> <span class="Operator">&amp;</span>
  180. <span class="StringLit">&quot; f DECIMAL(18,10))&quot;</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
  181. <span class="Identifier">theDb</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql&quot;START TRANSACTION&quot;</span><span class="Punctuation">)</span>
  182. <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">1000</span><span class="Punctuation">:</span>
  183. <span class="Identifier">theDb</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql&quot;INSERT INTO myTestTbl (name,i,f) VALUES (?,?,?)&quot;</span><span class="Punctuation">,</span>
  184. <span class="StringLit">&quot;Item#&quot;</span> <span class="Operator">&amp;</span> <span class="Operator">$</span><span class="Identifier">i</span><span class="Punctuation">,</span> <span class="Identifier">i</span><span class="Punctuation">,</span> <span class="Identifier">sqrt</span><span class="Punctuation">(</span><span class="Identifier">i</span><span class="Operator">.</span><span class="Identifier">float</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
  185. <span class="Identifier">theDb</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql&quot;COMMIT&quot;</span><span class="Punctuation">)</span>
  186. <span class="Keyword">for</span> <span class="Identifier">x</span> <span class="Keyword">in</span> <span class="Identifier">theDb</span><span class="Operator">.</span><span class="Identifier">fastRows</span><span class="Punctuation">(</span><span class="RawData">sql&quot;select * from myTestTbl&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
  187. <span class="Identifier">echo</span> <span class="Identifier">x</span>
  188. <span class="Keyword">let</span> <span class="Identifier">id</span> <span class="Operator">=</span> <span class="Identifier">theDb</span><span class="Operator">.</span><span class="Identifier">tryInsertId</span><span class="Punctuation">(</span><span class="RawData">sql&quot;INSERT INTO myTestTbl (name,i,f) VALUES (?,?,?)&quot;</span><span class="Punctuation">,</span>
  189. <span class="StringLit">&quot;Item#1001&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">1001</span><span class="Punctuation">,</span> <span class="Identifier">sqrt</span><span class="Punctuation">(</span><span class="FloatNumber">1001.0</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
  190. <span class="Identifier">echo</span> <span class="StringLit">&quot;Inserted item: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">theDb</span><span class="Operator">.</span><span class="Identifier">getValue</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT name FROM myTestTbl WHERE id=?&quot;</span><span class="Punctuation">,</span> <span class="Identifier">id</span><span class="Punctuation">)</span>
  191. <span class="Identifier">theDb</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
  192. </p>
  193. <div class="section" id="6">
  194. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  195. <dl class="item">
  196. <a class="reference external" href="odbcsql.html">odbcsql</a>, <a class="reference external" href="db_common.html">db_common</a>, <a class="reference external" href="dbutils.html">dbutils</a>
  197. </dl>
  198. </div>
  199. <div class="section" id="7">
  200. <h1><a class="toc-backref" href="#7">Types</a></h1>
  201. <dl class="item">
  202. <div id="DbConn">
  203. <dt><pre><a href="db_odbc.html#DbConn"><span class="Identifier">DbConn</span></a> <span class="Other">=</span> <span class="Identifier">OdbcConnTyp</span></pre></dt>
  204. <dd>
  205. encapsulates a database connection
  206. </dd>
  207. </div>
  208. <div id="InstantRow">
  209. <dt><pre><a href="db_odbc.html#InstantRow"><span class="Identifier">InstantRow</span></a> <span class="Other">=</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">row</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">len</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">]</span></pre></dt>
  210. <dd>
  211. a handle that can be used to get a row's column text on demand
  212. </dd>
  213. </div>
  214. <div id="Row">
  215. <dt><pre><a href="db_odbc.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>
  216. <dd>
  217. a row of a dataset. NULL database values will be converted to nil.
  218. </dd>
  219. </div>
  220. </dl>
  221. </div>
  222. <div class="section" id="12">
  223. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  224. <dl class="item">
  225. <div id="[]-procs-all">
  226. <div id="[],InstantRow,int">
  227. <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_odbc.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>
  228. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  229. <dd>
  230. Returns text for given column of the row
  231. </dd>
  232. </div>
  233. </div>
  234. <div id="close-procs-all">
  235. <div id="close,DbConn">
  236. <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> <span class="Keyword">var</span> <a href="db_odbc.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#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>
  237. <dd>
  238. Closes the database connection.
  239. </dd>
  240. </div>
  241. </div>
  242. <div id="dbError-procs-all">
  243. <div id="dbError,DbConn">
  244. <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> <span class="Keyword">var</span> <a href="db_odbc.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#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>
  245. <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#DbError"><span class="Identifier">DbError</span></a><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>
  246. <dd>
  247. Raises an <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Identifier">DbError</span><span class="Punctuation">]</span></span></tt> exception with ODBC error information
  248. </dd>
  249. </div>
  250. </div>
  251. <div id="dbQuote-procs-all">
  252. <div id="dbQuote,string">
  253. <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 class="Identifier">noSideEffect</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>
  254. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  255. <dd>
  256. DB quotes the string.
  257. </dd>
  258. </div>
  259. </div>
  260. <div id="exec-procs-all">
  261. <div id="exec,DbConn,SqlQuery,varargs[string,]">
  262. <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> <span class="Keyword">var</span> <a href="db_odbc.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> {.
  263. <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><a href="db_common.html#DbError"><span class="Identifier">DbError</span></a><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>
  264. <dd>
  265. Executes the query and raises EDB if not successful.
  266. </dd>
  267. </div>
  268. </div>
  269. <div id="execAffectedRows-procs-all">
  270. <div id="execAffectedRows,DbConn,SqlQuery,varargs[string,]">
  271. <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> <span class="Keyword">var</span> <a href="db_odbc.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>
  272. <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> {.
  273. <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><a href="db_common.html#DbError"><span class="Identifier">DbError</span></a><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>
  274. <dd>
  275. Runs the query (typically &quot;UPDATE&quot;) and returns the number of affected rows
  276. </dd>
  277. </div>
  278. </div>
  279. <div id="getAllRows-procs-all">
  280. <div id="getAllRows,DbConn,SqlQuery,varargs[string,]">
  281. <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> <span class="Keyword">var</span> <a href="db_odbc.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>
  282. <a href="db_odbc.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> <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><a href="db_common.html#DbError"><span class="Identifier">DbError</span></a><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>
  283. <dd>
  284. Executes the query and returns the whole result dataset.
  285. </dd>
  286. </div>
  287. </div>
  288. <div id="getRow-procs-all">
  289. <div id="getRow,DbConn,SqlQuery,varargs[string,]">
  290. <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> <span class="Keyword">var</span> <a href="db_odbc.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_odbc.html#Row"><span class="Identifier">Row</span></a> {.
  291. <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><a href="db_common.html#DbError"><span class="Identifier">DbError</span></a><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>
  292. <dd>
  293. Retrieves a single row. If the query doesn't return any rows, this proc will return a Row with empty strings for each column.
  294. </dd>
  295. </div>
  296. </div>
  297. <div id="getValue-procs-all">
  298. <div id="getValue,DbConn,SqlQuery,varargs[string,]">
  299. <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> <span class="Keyword">var</span> <a href="db_odbc.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> {.
  300. <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>
  301. <dd>
  302. Executes the query and returns the first column of the first row of the result dataset. Returns &quot;&quot; if the dataset contains no rows or the database value is NULL.
  303. </dd>
  304. </div>
  305. </div>
  306. <div id="insert-procs-all">
  307. <div id="insert,DbConn,SqlQuery,string,varargs[string,]">
  308. <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> <span class="Keyword">var</span> <a href="db_odbc.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>
  309. <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> {.
  310. <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>
  311. <dd>
  312. same as insertId
  313. </dd>
  314. </div>
  315. </div>
  316. <div id="insertId-procs-all">
  317. <div id="insertId,DbConn,SqlQuery,varargs[string,]">
  318. <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> <span class="Keyword">var</span> <a href="db_odbc.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> {.
  319. <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><a href="db_common.html#DbError"><span class="Identifier">DbError</span></a><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>
  320. <dd>
  321. Executes the query (typically &quot;INSERT&quot;) and returns the generated ID for the row.
  322. </dd>
  323. </div>
  324. </div>
  325. <div id="len-procs-all">
  326. <div id="len,InstantRow">
  327. <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_odbc.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>
  328. <dd>
  329. Returns number of columns in the row
  330. </dd>
  331. </div>
  332. </div>
  333. <div id="open-procs-all">
  334. <div id="open,string,string,string,string">
  335. <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_odbc.html#DbConn"><span class="Identifier">DbConn</span></a> {.
  336. <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><a href="db_common.html#DbError"><span class="Identifier">DbError</span></a><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>
  337. <dd>
  338. <p>Opens a database connection.</p>
  339. <p>Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">EDb</span></span></tt> if the connection could not be established.</p>
  340. <p>Currently the database parameter is ignored, but included to match <tt class="docutils literal"><span class="pre"><span class="Identifier">open</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt> in the other db_xxxxx library modules.</p>
  341. </dd>
  342. </div>
  343. </div>
  344. <div id="setEncoding-procs-all">
  345. <div id="setEncoding,DbConn,string">
  346. <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_odbc.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> {.
  347. <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><a href="db_common.html#DbError"><span class="Identifier">DbError</span></a><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>
  348. <dd>
  349. <p>Currently not implemented for ODBC.</p>
  350. <p>Sets the encoding of a database connection, returns true for success, false for failure. result = set_character_set(connection, encoding) == 0</p>
  351. </dd>
  352. </div>
  353. </div>
  354. <div id="tryExec-procs-all">
  355. <div id="tryExec,DbConn,SqlQuery,varargs[string,]">
  356. <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> <span class="Keyword">var</span> <a href="db_odbc.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> {.
  357. <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>
  358. <dd>
  359. Tries to execute the query and returns true if successful, false otherwise.
  360. </dd>
  361. </div>
  362. </div>
  363. <div id="tryInsert-procs-all">
  364. <div id="tryInsert,DbConn,SqlQuery,string,varargs[string,]">
  365. <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> <span class="Keyword">var</span> <a href="db_odbc.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>
  366. <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> {.
  367. <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>
  368. <dd>
  369. same as tryInsertID
  370. </dd>
  371. </div>
  372. </div>
  373. <div id="tryInsertId-procs-all">
  374. <div id="tryInsertId,DbConn,SqlQuery,varargs[string,]">
  375. <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> <span class="Keyword">var</span> <a href="db_odbc.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> {.
  376. <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>
  377. <dd>
  378. Executes the query (typically &quot;INSERT&quot;) and returns the generated ID for the row or -1 in case of an error.
  379. </dd>
  380. </div>
  381. </div>
  382. <div id="unsafeColumnAt-procs-all">
  383. <div id="unsafeColumnAt,InstantRow,int">
  384. <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_odbc.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>
  385. <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>
  386. <dd>
  387. Return cstring of given column of the row
  388. </dd>
  389. </div>
  390. </div>
  391. </dl>
  392. </div>
  393. <div class="section" id="15">
  394. <h1><a class="toc-backref" href="#15">Iterators</a></h1>
  395. <dl class="item">
  396. <div id="fastRows-iterators-all">
  397. <div id="fastRows.i,DbConn,SqlQuery,varargs[string,]">
  398. <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> <span class="Keyword">var</span> <a href="db_odbc.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_odbc.html#Row"><span class="Identifier">Row</span></a> {.
  399. <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><a href="db_common.html#DbError"><span class="Identifier">DbError</span></a><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>
  400. <dd>
  401. <p>Executes the query and iterates over the result dataset.</p>
  402. <p>This is very fast, but potentially dangerous. Use this iterator only if you require <strong>ALL</strong> the rows.</p>
  403. <p>Breaking the fastRows() iterator during a loop may cause a driver error for subsequent queries</p>
  404. <p>Rows are retrieved from the server at each iteration.</p>
  405. </dd>
  406. </div>
  407. </div>
  408. <div id="instantRows-iterators-all">
  409. <div id="instantRows.i,DbConn,SqlQuery,varargs[string,]">
  410. <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> <span class="Keyword">var</span> <a href="db_odbc.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_odbc.html#InstantRow"><span class="Identifier">InstantRow</span></a> {.
  411. <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>
  412. <dd>
  413. 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 the iterator body.
  414. </dd>
  415. </div>
  416. </div>
  417. <div id="rows-iterators-all">
  418. <div id="rows.i,DbConn,SqlQuery,varargs[string,]">
  419. <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> <span class="Keyword">var</span> <a href="db_odbc.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_odbc.html#Row"><span class="Identifier">Row</span></a> {.
  420. <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><a href="db_common.html#DbError"><span class="Identifier">DbError</span></a><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>
  421. <dd>
  422. <p>Same as <tt class="docutils literal"><span class="pre"><span class="Identifier">fastRows</span></span></tt>, but slower and safe.</p>
  423. <p>This retrieves ALL rows into memory before iterating through the rows. Large dataset queries will impact on memory usage.</p>
  424. </dd>
  425. </div>
  426. </div>
  427. </dl>
  428. </div>
  429. </div>
  430. </div>
  431. <div class="twelve-columns footer">
  432. <span class="nim-sprite"></span>
  433. <br>
  434. <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:56 UTC</small>
  435. </div>
  436. </div>
  437. </div>
  438. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  439. </body>
  440. </html>