Home Explore Help
Sign In
levovix
/
Nim
mirror of https://github.com/nim-lang/Nim
Watch 1
Star 0
Fork 1
Files Issues 0 Wiki
Branch: gh-pages
Branches Tags
Nim
/
db_sqlite.html

db_sqlite.html 129 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>src/db_connector/db_sqlite</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <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=="/>
    16. 

  16. <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=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">src/db_connector/db_sqlite</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li><a class="reference" id="basic-usage_toc" href="#basic-usage">Basic usage</a></li>
    55. 

  55. <ul class="simple"><li><a class="reference" id="basic-usage-parameter-substitution_toc" href="#basic-usage-parameter-substitution">Parameter substitution</a></li>
    56. 

  56. <li><a class="reference" id="basic-usage-opening-a-connection-to-a-database_toc" href="#basic-usage-opening-a-connection-to-a-database">Opening a connection to a database</a></li>
    57. 

  57. <li><a class="reference" id="basic-usage-creating-a-table_toc" href="#basic-usage-creating-a-table">Creating a table</a></li>
    58. 

  58. <li><a class="reference" id="basic-usage-inserting-data_toc" href="#basic-usage-inserting-data">Inserting data</a></li>
    59. 

  59. <li><a class="reference" id="basic-usage-larger-example_toc" href="#basic-usage-larger-example">Larger example</a></li>
    60. 

  60. <li><a class="reference" id="basic-usage-storing-binary-data-example_toc" href="#basic-usage-storing-binary-data-example">Storing binary data example</a></li>
    61. 

  61. </ul><li><a class="reference" id="note_toc" href="#note">Note</a></li>
    62. 

  62. <li><a class="reference" id="see-also_toc" href="#see-also">See also</a></li>
    63. 

  63. <li>
    64. 

  64.   <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
    65. 

  65. </li>
    66. 

  66. <li>
    67. 

  67.   <details open>
    68. 

  68.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    69. 

  69.     <ul class="simple simple-toc-section">
    70. 

  70.       <li><a class="reference" href="#DbConn" title="DbConn = PSqlite3">DbConn</a></li>
    71. 

  71. <li><a class="reference" href="#InstantRow" title="InstantRow = PStmt">InstantRow</a></li>
    72. 

  72. <li><a class="reference" href="#Row" title="Row = seq[string]">Row</a></li>
    73. 

  73. <li><a class="reference" href="#SqlPrepared" title="SqlPrepared = distinct PStmt">SqlPrepared</a></li>
    74. 

  74. 

  75.     </ul>
    76. 

  76.   </details>
    77. 

  77. </li>
    78. 

  78. <li>
    79. 

  79.   <details open>
    80. 

  80.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    81. 

  81.     <ul class="simple simple-toc-section">
    82. 

  82.       <ul class="simple nested-toc-section">[]
    83. 

  83.   <li><a class="reference" href="#%5B%5D%2CInstantRow%2Cint32" title="`[]`(row: InstantRow; col: int32): string">`[]`(row: InstantRow; col: int32): string</a></li>
    84. 

  84. 

  85. </ul>
    86. 

  86. <ul class="simple nested-toc-section">bindNull
    87. 

  87.   <li><a class="reference" href="#bindNull%2CSqlPrepared%2Cint" title="bindNull(ps: SqlPrepared; paramIdx: int)">bindNull(ps: SqlPrepared; paramIdx: int)</a></li>
    88. 

  88. 

  89. </ul>
    90. 

  90. <ul class="simple nested-toc-section">bindParam
    91. 

  91.   <li><a class="reference" href="#bindParam%2CSqlPrepared%2Cint%2Cfloat64" title="bindParam(ps: SqlPrepared; paramIdx: int; val: float64)">bindParam(ps: SqlPrepared; paramIdx: int; val: float64)</a></li>
    92. 

  92. <li><a class="reference" href="#bindParam%2CSqlPrepared%2Cint%2Cint" title="bindParam(ps: SqlPrepared; paramIdx: int; val: int)">bindParam(ps: SqlPrepared; paramIdx: int; val: int)</a></li>
    93. 

  93. <li><a class="reference" href="#bindParam%2CSqlPrepared%2Cint%2Cint32" title="bindParam(ps: SqlPrepared; paramIdx: int; val: int32)">bindParam(ps: SqlPrepared; paramIdx: int; val: int32)</a></li>
    94. 

  94. <li><a class="reference" href="#bindParam%2CSqlPrepared%2Cint%2Cint64" title="bindParam(ps: SqlPrepared; paramIdx: int; val: int64)">bindParam(ps: SqlPrepared; paramIdx: int; val: int64)</a></li>
    95. 

  95. <li><a class="reference" href="#bindParam%2CSqlPrepared%2Cint%2CopenArray%5Bbyte%5D" title="bindParam(ps: SqlPrepared; paramIdx: int; val: openArray[byte]; copy = true)">bindParam(ps: SqlPrepared; paramIdx: int; val: openArray[byte]; copy = true)</a></li>
    96. 

  96. <li><a class="reference" href="#bindParam%2CSqlPrepared%2Cint%2Cstring" title="bindParam(ps: SqlPrepared; paramIdx: int; val: string; copy = true)">bindParam(ps: SqlPrepared; paramIdx: int; val: string; copy = true)</a></li>
    97. 

  97. 

  98. </ul>
    99. 

  99. <ul class="simple nested-toc-section">close
    100. 

  100.   <li><a class="reference" href="#close%2CDbConn" title="close(db: DbConn)">close(db: DbConn)</a></li>
    101. 

  101. 

  102. </ul>
    103. 

  103. <ul class="simple nested-toc-section">dbError
    104. 

  104.   <li><a class="reference" href="#dbError%2CDbConn" title="dbError(db: DbConn)">dbError(db: DbConn)</a></li>
    105. 

  105. 

  106. </ul>
    107. 

  107. <ul class="simple nested-toc-section">dbQuote
    108. 

  108.   <li><a class="reference" href="#dbQuote%2Cstring" title="dbQuote(s: string): string">dbQuote(s: string): string</a></li>
    109. 

  109. 

  110. </ul>
    111. 

  111. <ul class="simple nested-toc-section">exec
    112. 

  112.   <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>
    113. 

  113. 

  114. </ul>
    115. 

  115. <ul class="simple nested-toc-section">execAffectedRows
    116. 

  116.   <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>
    117. 

  117. <li><a class="reference" href="#execAffectedRows%2CDbConn%2CSqlPrepared" title="execAffectedRows(db: DbConn; stmtName: SqlPrepared): int64">execAffectedRows(db: DbConn; stmtName: SqlPrepared): int64</a></li>
    118. 

  118. 

  119. </ul>
    120. 

  120. <ul class="simple nested-toc-section">finalize
    121. 

  121.   <li><a class="reference" href="#finalize%2CSqlPrepared" title="finalize(sqlPrepared: SqlPrepared)">finalize(sqlPrepared: SqlPrepared)</a></li>
    122. 

  122. 

  123. </ul>
    124. 

  124. <ul class="simple nested-toc-section">getAllRows
    125. 

  125.   <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>
    126. 

  126. <li><a class="reference" href="#getAllRows%2CDbConn%2CSqlPrepared" title="getAllRows(db: DbConn; stmtName: SqlPrepared): seq[Row]">getAllRows(db: DbConn; stmtName: SqlPrepared): seq[Row]</a></li>
    127. 

  127. 

  128. </ul>
    129. 

  129. <ul class="simple nested-toc-section">getRow
    130. 

  130.   <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>
    131. 

  131. 

  132. </ul>
    133. 

  133. <ul class="simple nested-toc-section">getValue
    134. 

  134.   <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>
    135. 

  135. <li><a class="reference" href="#getValue%2CDbConn%2CSqlPrepared" title="getValue(db: DbConn; stmtName: SqlPrepared): string">getValue(db: DbConn; stmtName: SqlPrepared): string</a></li>
    136. 

  136. 

  137. </ul>
    138. 

  138. <ul class="simple nested-toc-section">insert
    139. 

  139.   <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>
    140. 

  140. 

  141. </ul>
    142. 

  142. <ul class="simple nested-toc-section">insertID
    143. 

  143.   <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>
    144. 

  144. 

  145. </ul>
    146. 

  146. <ul class="simple nested-toc-section">len
    147. 

  147.   <li><a class="reference" href="#len%2CInstantRow" title="len(row: InstantRow): int32">len(row: InstantRow): int32</a></li>
    148. 

  148. 

  149. </ul>
    150. 

  150. <ul class="simple nested-toc-section">open
    151. 

  151.   <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>
    152. 

  152. 

  153. </ul>
    154. 

  154. <ul class="simple nested-toc-section">prepare
    155. 

  155.   <li><a class="reference" href="#prepare%2CDbConn%2Cstring" title="prepare(db: DbConn; q: string): SqlPrepared">prepare(db: DbConn; q: string): SqlPrepared</a></li>
    156. 

  156. 

  157. </ul>
    158. 

  158. <ul class="simple nested-toc-section">setEncoding
    159. 

  159.   <li><a class="reference" href="#setEncoding%2CDbConn%2Cstring" title="setEncoding(connection: DbConn; encoding: string): bool">setEncoding(connection: DbConn; encoding: string): bool</a></li>
    160. 

  160. 

  161. </ul>
    162. 

  162. <ul class="simple nested-toc-section">tryExec
    163. 

  163.   <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>
    164. 

  164. <li><a class="reference" href="#tryExec%2CDbConn%2CSqlPrepared" title="tryExec(db: DbConn; stmtName: SqlPrepared): bool">tryExec(db: DbConn; stmtName: SqlPrepared): bool</a></li>
    165. 

  165. 

  166. </ul>
    167. 

  167. <ul class="simple nested-toc-section">tryInsert
    168. 

  168.   <li><a class="reference" href="#tryInsert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D" title="tryInsert(db: DbConn; query: SqlQuery; pkName: string;
    169. 

  169.           args: varargs[string, `$`]): int64">tryInsert(db: DbConn; query: SqlQuery; pkName: string;
    170. 

  170.           args: varargs[string, `$`]): int64</a></li>
    171. 

  171. 

  172. </ul>
    173. 

  173. <ul class="simple nested-toc-section">tryInsertID
    174. 

  174.   <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>
    175. 

  175. 

  176. </ul>
    177. 

  177. <ul class="simple nested-toc-section">unsafeColumnAt
    178. 

  178.   <li><a class="reference" href="#unsafeColumnAt%2CInstantRow%2Cint32" title="unsafeColumnAt(row: InstantRow; index: int32): cstring">unsafeColumnAt(row: InstantRow; index: int32): cstring</a></li>
    179. 

  179. 

  180. </ul>
    181. 

  181. 

  182.     </ul>
    183. 

  183.   </details>
    184. 

  184. </li>
    185. 

  185. <li>
    186. 

  186.   <details open>
    187. 

  187.     <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
    188. 

  188.     <ul class="simple simple-toc-section">
    189. 

  189.       <ul class="simple nested-toc-section">fastRows
    190. 

  190.   <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>
    191. 

  191. <li><a class="reference" href="#fastRows.i%2CDbConn%2CSqlPrepared" title="fastRows(db: DbConn; stmtName: SqlPrepared): Row">fastRows(db: DbConn; stmtName: SqlPrepared): Row</a></li>
    192. 

  192. 

  193. </ul>
    194. 

  194. <ul class="simple nested-toc-section">instantRows
    195. 

  195.   <li><a class="reference" href="#instantRows.i%2CDbConn%2CDbColumns%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="instantRows(db: DbConn; columns: var DbColumns; query: SqlQuery;
    196. 

  196.             args: varargs[string, `$`]): InstantRow">instantRows(db: DbConn; columns: var DbColumns; query: SqlQuery;
    197. 

  197.             args: varargs[string, `$`]): InstantRow</a></li>
    198. 

  198. <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>
    199. 

  199. <li><a class="reference" href="#instantRows.i%2CDbConn%2CSqlPrepared" title="instantRows(db: DbConn; stmtName: SqlPrepared): InstantRow">instantRows(db: DbConn; stmtName: SqlPrepared): InstantRow</a></li>
    200. 

  200. 

  201. </ul>
    202. 

  202. <ul class="simple nested-toc-section">rows
    203. 

  203.   <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>
    204. 

  204. <li><a class="reference" href="#rows.i%2CDbConn%2CSqlPrepared" title="rows(db: DbConn; stmtName: SqlPrepared): Row">rows(db: DbConn; stmtName: SqlPrepared): Row</a></li>
    205. 

  205. 

  206. </ul>
    207. 

  207. 

  208.     </ul>
    209. 

  209.   </details>
    210. 

  210. </li>
    211. 

  211. <li>
    212. 

  212.   <details open>
    213. 

  213.     <summary><a class="reference reference-toplevel" href="#17" id="67">Macros</a></summary>
    214. 

  214.     <ul class="simple simple-toc-section">
    215. 

  215.       <ul class="simple nested-toc-section">bindParams
    216. 

  216.   <li><a class="reference" href="#bindParams.m%2CSqlPrepared%2Cvarargs%5Buntyped%5D" title="bindParams(ps: SqlPrepared; params: varargs[untyped]): untyped">bindParams(ps: SqlPrepared; params: varargs[untyped]): untyped</a></li>
    217. 

  217. 

  218. </ul>
    219. 

  219. 

  220.     </ul>
    221. 

  221.   </details>
    222. 

  222. </li>
    223. 

  223. <li>
    224. 

  224.   <details open>
    225. 

  225.     <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
    226. 

  226.     <ul class="simple simple-toc-section">
    227. 

  227.       <ul class="simple nested-toc-section">dbBindParamError
    228. 

  228.   <li><a class="reference" href="#dbBindParamError.t%2Cint%2Cvarargs%5Buntyped%5D" title="dbBindParamError(paramIdx: int; val: varargs[untyped])">dbBindParamError(paramIdx: int; val: varargs[untyped])</a></li>
    229. 

  229. 

  230. </ul>
    231. 

  231. <ul class="simple nested-toc-section">exec
    232. 

  232.   <li><a class="reference" href="#exec.t%2CDbConn%2CSqlPrepared%2Cvarargs%5Btyped%5D" title="exec(db: DbConn; stmtName: SqlPrepared; args: varargs[typed]): untyped">exec(db: DbConn; stmtName: SqlPrepared; args: varargs[typed]): untyped</a></li>
    233. 

  233. 

  234. </ul>
    235. 

  235. 

  236.     </ul>
    237. 

  237.   </details>
    238. 

  238. </li>
    239. 

  239. 

  240. </ul>
    241. 

  241. 

  242.   </div>
    243. 

  243.   <div class="nine columns" id="content">
    244. 

  244.     
    245. 

  245.     <div id="tocRoot"></div>
    246. 

  246.     
    247. 

  247.     <p class="module-desc"><div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    248. 

  248. 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>
    249. 

  249. <p>A higher level <span id="sqlite_1">SQLite</span> database wrapper. This interface is implemented for other databases too.</p>
    250. 

  250. 

  251. <h1><a class="toc-backref" id="basic-usage" href="#basic-usage">Basic usage</a></h1><p>The basic flow of using this module is:</p>
    252. 

  252. <ol class="simple"><li>Open database connection</li>
    253. 

  253. <li>Execute SQL query</li>
    254. 

  254. <li>Close database connection</li>
    255. 

  255. </ol>
    256. 

  256. 

  257. <h2><a class="toc-backref" id="basic-usage-parameter-substitution" href="#basic-usage-parameter-substitution">Parameter substitution</a></h2><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>
    258. 

  258. <p><pre class="listing"><span class="RawData">sql&quot;INSERT INTO my_table (colA, colB, colC) VALUES (?, ?, ?)&quot;</span></pre></p>
    259. 

  259. 

  260. <h2><a class="toc-backref" id="basic-usage-opening-a-connection-to-a-database" href="#basic-usage-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_sqlite</span>
    261. 

  261. 

  262. <span class="Comment"># user, password, database name can be empty.</span>
    263. 

  263. <span class="Comment"># These params are not used on db_sqlite module.</span>
    264. 

  264. <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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    265. 

  265. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    266. 

  266. 

  267. <h2><a class="toc-backref" id="basic-usage-creating-a-table" href="#basic-usage-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 my_table&quot;</span><span class="Punctuation">)</span>
    268. 

  268. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="LongStringLit">sql&quot;&quot;&quot;CREATE TABLE my_table (
    269. 

  269.                  id   INTEGER,
    270. 

  270.                  name VARCHAR(50) NOT NULL
    271. 

  271.               )&quot;&quot;&quot;</span><span class="Punctuation">)</span></pre></p>
    272. 

  272. 

  273. <h2><a class="toc-backref" id="basic-usage-inserting-data" href="#basic-usage-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 my_table (id, name) VALUES (0, ?)&quot;</span><span class="Punctuation">,</span>
    274. 

  274.         <span class="StringLit">&quot;Jack&quot;</span><span class="Punctuation">)</span></pre></p>
    275. 

  275. 

  276. <h2><a class="toc-backref" id="basic-usage-larger-example" href="#basic-usage-larger-example">Larger 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_sqlite</span>
    277. 

  277. <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">math</span>
    278. 

  278. 

  279. <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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    280. 

  280. 

  281. <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 my_table&quot;</span><span class="Punctuation">)</span>
    282. 

  282. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="LongStringLit">sql&quot;&quot;&quot;CREATE TABLE my_table (
    283. 

  283.                  id    INTEGER PRIMARY KEY,
    284. 

  284.                  name  VARCHAR(50) NOT NULL,
    285. 

  285.                  i     INT(11),
    286. 

  286.                  f     DECIMAL(18, 10)
    287. 

  287.               )&quot;&quot;&quot;</span><span class="Punctuation">)</span>
    288. 

  288. 

  289. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql&quot;BEGIN&quot;</span><span class="Punctuation">)</span>
    290. 

  290. <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>
    291. 

  291.   <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 my_table (name, i, f) VALUES (?, ?, ?)&quot;</span><span class="Punctuation">,</span>
    292. 

  292.           <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>
    293. 

  293. <span class="Identifier">db</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>
    294. 

  294. 

  295. <span class="Keyword">for</span> <span class="Identifier">x</span> <span class="Keyword">in</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">fastRows</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT * FROM my_table&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    296. 

  296.   <span class="Identifier">echo</span> <span class="Identifier">x</span>
    297. 

  297. 

  298. <span class="Keyword">let</span> <span class="Identifier">id</span> <span class="Operator">=</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">tryInsertId</span><span class="Punctuation">(</span><span class="LongStringLit">sql&quot;&quot;&quot;INSERT INTO my_table (name, i, f)
    299. 

  299.                               VALUES (?, ?, ?)&quot;&quot;&quot;</span><span class="Punctuation">,</span>
    300. 

  300.                         <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>
    301. 

  301. <span class="Identifier">echo</span> <span class="StringLit">&quot;Inserted item: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getValue</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT name FROM my_table WHERE id=?&quot;</span><span class="Punctuation">,</span> <span class="Identifier">id</span><span class="Punctuation">)</span>
    302. 

  302. 

  303. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    304. 

  304. 

  305. <h2><a class="toc-backref" id="basic-usage-storing-binary-data-example" href="#basic-usage-storing-binary-data-example">Storing binary data example</a></h2><p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">random</span>
    306. 

  306. 

  307. <span class="Comment">## Generate random float datas</span>
    308. 

  308. <span class="Keyword">var</span> <span class="Identifier">orig</span> <span class="Operator">=</span> <span class="Identifier">newSeq</span><span class="Punctuation">[</span><span class="Identifier">float64</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">150</span><span class="Punctuation">)</span>
    309. 

  309. <span class="Identifier">randomize</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    310. 

  310. <span class="Keyword">for</span> <span class="Identifier">x</span> <span class="Keyword">in</span> <span class="Identifier">orig</span><span class="Operator">.</span><span class="Identifier">mitems</span><span class="Punctuation">:</span>
    311. 

  311.   <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">rand</span><span class="Punctuation">(</span><span class="FloatNumber">1.0</span><span class="Punctuation">)</span><span class="Operator">/</span><span class="FloatNumber">10.0</span>
    312. 

  312. 

  313. <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">&quot;mysqlite.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    314. 

  314. <span class="Keyword">block</span><span class="Punctuation">:</span> <span class="Comment">## Create database</span>
    315. 

  315.   <span class="Comment">## Binary datas needs to be of type BLOB in SQLite</span>
    316. 

  316.   <span class="Keyword">let</span> <span class="Identifier">createTableStr</span> <span class="Operator">=</span> <span class="LongStringLit">sql&quot;&quot;&quot;CREATE TABLE test(
    317. 

  317.     id INTEGER NOT NULL PRIMARY KEY,
    318. 

  318.     data BLOB
    319. 

  319.   )
    320. 

  320.   &quot;&quot;&quot;</span>
    321. 

  321.   <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="Identifier">createTableStr</span><span class="Punctuation">)</span>
    322. 

  322. 

  323. <span class="Keyword">block</span><span class="Punctuation">:</span> <span class="Comment">## Insert data</span>
    324. 

  324.   <span class="Keyword">var</span> <span class="Identifier">id</span> <span class="Operator">=</span> <span class="DecNumber">1</span>
    325. 

  325.   <span class="Comment">## Data needs to be converted to seq[byte] to be interpreted as binary by bindParams</span>
    326. 

  326.   <span class="Keyword">var</span> <span class="Identifier">dbuf</span> <span class="Operator">=</span> <span class="Identifier">newSeq</span><span class="Punctuation">[</span><span class="Identifier">byte</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">orig</span><span class="Operator">.</span><span class="Identifier">len</span><span class="Operator">*</span><span class="Identifier">sizeof</span><span class="Punctuation">(</span><span class="Identifier">float64</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    327. 

  327.   <span class="Identifier">copyMem</span><span class="Punctuation">(</span><span class="Identifier">unsafeAddr</span><span class="Punctuation">(</span><span class="Identifier">dbuf</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">unsafeAddr</span><span class="Punctuation">(</span><span class="Identifier">orig</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">dbuf</span><span class="Operator">.</span><span class="Identifier">len</span><span class="Punctuation">)</span>
    328. 

  328.   
    329. 

  329.   <span class="Comment">## Use prepared statement to insert binary data into database</span>
    330. 

  330.   <span class="Keyword">var</span> <span class="Identifier">insertStmt</span> <span class="Operator">=</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">prepare</span><span class="Punctuation">(</span><span class="StringLit">&quot;INSERT INTO test (id, data) VALUES (?, ?)&quot;</span><span class="Punctuation">)</span>
    331. 

  331.   <span class="Identifier">insertStmt</span><span class="Operator">.</span><span class="Identifier">bindParams</span><span class="Punctuation">(</span><span class="Identifier">id</span><span class="Punctuation">,</span> <span class="Identifier">dbuf</span><span class="Punctuation">)</span>
    332. 

  332.   <span class="Keyword">let</span> <span class="Identifier">bres</span> <span class="Operator">=</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">tryExec</span><span class="Punctuation">(</span><span class="Identifier">insertStmt</span><span class="Punctuation">)</span>
    333. 

  333.   <span class="Comment">## Check insert</span>
    334. 

  334.   <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">bres</span><span class="Punctuation">)</span>
    335. 

  335.   <span class="Comment"># Destroy statement</span>
    336. 

  336.   <span class="Identifier">finalize</span><span class="Punctuation">(</span><span class="Identifier">insertStmt</span><span class="Punctuation">)</span>
    337. 

  337. 

  338. <span class="Keyword">block</span><span class="Punctuation">:</span> <span class="Comment">## Use getValue to select data</span>
    339. 

  339.   <span class="Keyword">var</span> <span class="Identifier">dataTest</span> <span class="Operator">=</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getValue</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT data FROM test WHERE id = ?&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span>
    340. 

  340.   <span class="Comment">## Calculate sequence size from buffer size</span>
    341. 

  341.   <span class="Keyword">let</span> <span class="Identifier">seqSize</span> <span class="Operator">=</span> <span class="Identifier">int</span><span class="Punctuation">(</span><span class="Identifier">dataTest</span><span class="Operator">.</span><span class="Identifier">len</span><span class="Operator">*</span><span class="Identifier">sizeof</span><span class="Punctuation">(</span><span class="Identifier">byte</span><span class="Punctuation">)</span><span class="Operator">/</span><span class="Identifier">sizeof</span><span class="Punctuation">(</span><span class="Identifier">float64</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    342. 

  342.   <span class="Comment">## Copy binary string data in dataTest into a seq</span>
    343. 

  343.   <span class="Keyword">var</span> <span class="Identifier">res</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">float64</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Identifier">newSeq</span><span class="Punctuation">[</span><span class="Identifier">float64</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">seqSize</span><span class="Punctuation">)</span>
    344. 

  344.   <span class="Identifier">copyMem</span><span class="Punctuation">(</span><span class="Identifier">unsafeAddr</span><span class="Punctuation">(</span><span class="Identifier">res</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Keyword">addr</span><span class="Punctuation">(</span><span class="Identifier">dataTest</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">dataTest</span><span class="Operator">.</span><span class="Identifier">len</span><span class="Punctuation">)</span>
    345. 

  345.   
    346. 

  346.   <span class="Comment">## Check datas obtained is identical</span>
    347. 

  347.   <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="Identifier">orig</span>
    348. 

  348. 

  349. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    350. 

  350. 

  351. <h1><a class="toc-backref" id="note" href="#note">Note</a></h1><p>This module does not implement any ORM features such as mapping the types from the schema. Instead, a <tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span></span></tt> is returned for each row.</p>
    352. 

  352. <p>The reasoning is as follows:</p>
    353. 

  353. <ol class="simple"><li>it's close to what many DBs offer natively (<tt class="docutils literal"><span class="pre"><span class="Keyword">char</span><span class="Operator">**</span></span></tt>)</li>
    354. 

  354. <li>it hides the number of types that the DB supports (int? int64? decimal up to 10 places? geo coords?)</li>
    355. 

  355. <li>it's convenient when all you do is to forward the data to somewhere else (echo, log, put the data into a new query)</li>
    356. 

  356. </ol>
    357. 

  357. 

  358. <h1><a class="toc-backref" id="see-also" href="#see-also">See also</a></h1><ul class="simple"><li><a class="reference external" href="db_odbc.html">db_odbc module</a> for ODBC database wrapper</li>
    359. 

  359. <li><a class="reference external" href="db_mysql.html">db_mysql module</a> for MySQL database wrapper</li>
    360. 

  360. <li><a class="reference external" href="db_postgres.html">db_postgres module</a> for PostgreSQL database wrapper</li>
    361. 

  361. </ul>
    362. 

  362. </p>
    363. 

  363.     <div class="section" id="6">
    364. 

  364.   <h1><a class="toc-backref" href="#6">Imports</a></h1>
    365. 

  365.   <dl class="item">
    366. 

  366.     <a class="reference external" href="sqlite3.html">sqlite3</a>, <a class="reference external" href="db_common.html">db_common</a>, <a class="reference external" href="dbutils.html">dbutils</a>
    367. 

  367.   </dl>
    368. 

  368. </div>
    369. 

  369. <div class="section" id="7">
    370. 

  370.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    371. 

  371.   <dl class="item">
    372. 

  372.     <div id="DbConn">
    373. 

  373.   <dt><pre><a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a> <span class="Other">=</span> <a href="sqlite3.html#PSqlite3"><span class="Identifier">PSqlite3</span></a></pre></dt>
    374. 

  374.   <dd>
    375. 

  375.     
    376. 

  376.     Encapsulates a database connection.
    377. 

  377.     
    378. 

  378.   </dd>
    379. 

  379. </div>
    380. 

  380. <div id="InstantRow">
    381. 

  381.   <dt><pre><a href="db_sqlite.html#InstantRow"><span class="Identifier">InstantRow</span></a> <span class="Other">=</span> <a href="sqlite3.html#PStmt"><span class="Identifier">PStmt</span></a></pre></dt>
    382. 

  382.   <dd>
    383. 

  383.     
    384. 

  384.     A handle that can be used to get a row's column text on demand.
    385. 

  385.     
    386. 

  386.   </dd>
    387. 

  387. </div>
    388. 

  388. <div id="Row">
    389. 

  389.   <dt><pre><a href="db_sqlite.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>
    390. 

  390.   <dd>
    391. 

  391.     
    392. 

  392.     A row of a dataset. <tt class="docutils literal"><span class="pre"><span class="Identifier">NULL</span></span></tt> database values will be converted to an empty string.
    393. 

  393.     
    394. 

  394.   </dd>
    395. 

  395. </div>
    396. 

  396. <div id="SqlPrepared">
    397. 

  397.   <dt><pre><a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="sqlite3.html#PStmt"><span class="Identifier">PStmt</span></a></pre></dt>
    398. 

  398.   <dd>
    399. 

  399.     
    400. 

  400.     a identifier for the prepared queries
    401. 

  401.     
    402. 

  402.   </dd>
    403. 

  403. </div>
    404. 

  404. 

  405.   </dl>
    406. 

  406. </div>
    407. 

  407. <div class="section" id="12">
    408. 

  408.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    409. 

  409.   <dl class="item">
    410. 

  410.     <div id="[]-procs-all">
    411. 

  411.   <div id="[],InstantRow,int32">
    412. 

  412.   <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2CInstantRow%2Cint32"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">row</span><span class="Other">:</span> <a href="db_sqlite.html#InstantRow"><span class="Identifier">InstantRow</span></a><span class="Other">;</span> <span class="Identifier">col</span><span class="Other">:</span> <span class="Identifier">int32</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>
    413. 

  413.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    414. 

  414.   <dd>
    415. 

  415.     
    416. 

  416.     <p>Returns text for given column of the row.</p>
    417. 

  417. <p>See also:</p>
    418. 

  418. <ul class="simple"><li><a class="reference external" href="#instantRows.i,DbConn,SqlQuery,varargs[string,]">instantRows iterator</a> example code</li>
    419. 

  419. </ul>
    420. 

  420. 

  421.     
    422. 

  422.   </dd>
    423. 

  423. </div>
    424. 

  424. 

  425. </div>
    426. 

  426. <div id="bindNull-procs-all">
    427. 

  427.   <div id="bindNull,SqlPrepared,int">
    428. 

  428.   <dt><pre><span class="Keyword">proc</span> <a href="#bindNull%2CSqlPrepared%2Cint"><span class="Identifier">bindNull</span></a><span class="Other">(</span><span class="Identifier">ps</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">paramIdx</span><span class="Other">:</span> <span class="Identifier">int</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>
    429. 

  429.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    430. 

  430.   <dd>
    431. 

  431.     
    432. 

  432.     
    433. 

  433.     
    434. 

  434.   </dd>
    435. 

  435. </div>
    436. 

  436. 

  437. </div>
    438. 

  438. <div id="bindParam-procs-all">
    439. 

  439.   <div id="bindParam,SqlPrepared,int,float64">
    440. 

  440.   <dt><pre><span class="Keyword">proc</span> <a href="#bindParam%2CSqlPrepared%2Cint%2Cfloat64"><span class="Identifier">bindParam</span></a><span class="Other">(</span><span class="Identifier">ps</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">paramIdx</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">float64</span><span class="Other">)</span> {.
    441. 

  441.     <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>
    442. 

  442.   <dd>
    443. 

  443.     
    444. 

  444.     
    445. 

  445.     
    446. 

  446.   </dd>
    447. 

  447. </div>
    448. 

  448. <div id="bindParam,SqlPrepared,int,int">
    449. 

  449.   <dt><pre><span class="Keyword">proc</span> <a href="#bindParam%2CSqlPrepared%2Cint%2Cint"><span class="Identifier">bindParam</span></a><span class="Other">(</span><span class="Identifier">ps</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">paramIdx</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">int</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>
    450. 

  450.     <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>
    451. 

  451.   <dd>
    452. 

  452.     
    453. 

  453.     
    454. 

  454.     
    455. 

  455.   </dd>
    456. 

  456. </div>
    457. 

  457. <div id="bindParam,SqlPrepared,int,int32">
    458. 

  458.   <dt><pre><span class="Keyword">proc</span> <a href="#bindParam%2CSqlPrepared%2Cint%2Cint32"><span class="Identifier">bindParam</span></a><span class="Other">(</span><span class="Identifier">ps</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">paramIdx</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">int32</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>
    459. 

  459.     <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>
    460. 

  460.   <dd>
    461. 

  461.     
    462. 

  462.     
    463. 

  463.     
    464. 

  464.   </dd>
    465. 

  465. </div>
    466. 

  466. <div id="bindParam,SqlPrepared,int,int64">
    467. 

  467.   <dt><pre><span class="Keyword">proc</span> <a href="#bindParam%2CSqlPrepared%2Cint%2Cint64"><span class="Identifier">bindParam</span></a><span class="Other">(</span><span class="Identifier">ps</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">paramIdx</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">int64</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>
    468. 

  468.     <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>
    469. 

  469.   <dd>
    470. 

  470.     
    471. 

  471.     
    472. 

  472.     
    473. 

  473.   </dd>
    474. 

  474. </div>
    475. 

  475. <div id="bindParam,SqlPrepared,int,openArray[byte]">
    476. 

  476.   <dt><pre><span class="Keyword">proc</span> <a href="#bindParam%2CSqlPrepared%2Cint%2CopenArray%5Bbyte%5D"><span class="Identifier">bindParam</span></a><span class="Other">(</span><span class="Identifier">ps</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">paramIdx</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">copy</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span> {.
    477. 

  477.     <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>
    478. 

  478.   <dd>
    479. 

  479.     
    480. 

  480.     
    481. 

  481.     
    482. 

  482.   </dd>
    483. 

  483. </div>
    484. 

  484. <div id="bindParam,SqlPrepared,int,string">
    485. 

  485.   <dt><pre><span class="Keyword">proc</span> <a href="#bindParam%2CSqlPrepared%2Cint%2Cstring"><span class="Identifier">bindParam</span></a><span class="Other">(</span><span class="Identifier">ps</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">paramIdx</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">copy</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span> {.
    486. 

  486.     <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>
    487. 

  487.   <dd>
    488. 

  488.     
    489. 

  489.     
    490. 

  490.     
    491. 

  491.   </dd>
    492. 

  492. </div>
    493. 

  493. 

  494. </div>
    495. 

  495. <div id="close-procs-all">
    496. 

  496.   <div id="close,DbConn">
    497. 

  497.   <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_sqlite.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="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>
    498. 

  498.   <dd>
    499. 

  499.     
    500. 

  500.     <p>Closes the database connection.</p>
    501. 

  501. <p><strong>Examples:</strong></p>
    502. 

  502. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    503. 

  503. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    504. 

  504. 

  505.     
    506. 

  506.   </dd>
    507. 

  507. </div>
    508. 

  508. 

  509. </div>
    510. 

  510. <div id="dbError-procs-all">
    511. 

  511.   <div id="dbError,DbConn">
    512. 

  512.   <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_sqlite.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>
    513. 

  513.   <dd>
    514. 

  514.     
    515. 

  515.     <p>Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">DbError</span></span></tt> exception.</p>
    516. 

  516. <p><strong>Examples:</strong></p>
    517. 

  517. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    518. 

  518. <span class="Keyword">if</span> <span class="Keyword">not</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">tryExec</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT * FROM not_exist_table&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    519. 

  519.   <span class="Identifier">dbError</span><span class="Punctuation">(</span><span class="Identifier">db</span><span class="Punctuation">)</span>
    520. 

  520. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    521. 

  521. 

  522.     
    523. 

  523.   </dd>
    524. 

  524. </div>
    525. 

  525. 

  526. </div>
    527. 

  527. <div id="dbQuote-procs-all">
    528. 

  528.   <div id="dbQuote,string">
    529. 

  529.   <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>
    530. 

  530.   <dd>
    531. 

  531.     
    532. 

  532.     Escapes the <tt class="docutils literal"><span class="pre"><span class="CharLit">'</span></span></tt> (single quote) char to <tt class="docutils literal"><span class="pre"><span class="CharLit">''</span></span></tt>. Because single quote is used for defining <tt class="docutils literal"><span class="pre"><span class="Identifier">VARCHAR</span></span></tt> in SQL.
    533. 

  533. <p><strong class="examples_text">Example:</strong></p>
    534. 

  534. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">dbQuote</span><span class="Punctuation">(</span><span class="StringLit">&quot;'&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;''''&quot;</span>
    535. 

  535. <span class="Identifier">doAssert</span> <span class="Identifier">dbQuote</span><span class="Punctuation">(</span><span class="StringLit">&quot;A Foobar's pen.&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;'A Foobar''s pen.'&quot;</span></pre>
    536. 

  536.     
    537. 

  537.   </dd>
    538. 

  538. </div>
    539. 

  539. 

  540. </div>
    541. 

  541. <div id="exec-procs-all">
    542. 

  542.   <div id="exec,DbConn,SqlQuery,varargs[string,]">
    543. 

  543.   <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_sqlite.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> {.
    544. 

  544.     <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>
    545. 

  545.   <dd>
    546. 

  546.     
    547. 

  547.     <p>Executes the query and raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">DbError</span></span></tt> exception if not successful.</p>
    548. 

  548. <p><strong>Examples:</strong></p>
    549. 

  549. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    550. 

  550. <span class="Keyword">try</span><span class="Punctuation">:</span>
    551. 

  551.   <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 my_table (id, name) VALUES (?, ?)&quot;</span><span class="Punctuation">,</span>
    552. 

  552.           <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="StringLit">&quot;item#1&quot;</span><span class="Punctuation">)</span>
    553. 

  553. <span class="Keyword">except</span><span class="Punctuation">:</span>
    554. 

  554.   <span class="Identifier">stderr</span><span class="Operator">.</span><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="Identifier">getCurrentExceptionMsg</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
    555. 

  555. <span class="Keyword">finally</span><span class="Punctuation">:</span>
    556. 

  556.   <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    557. 

  557. 

  558.     
    559. 

  559.   </dd>
    560. 

  560. </div>
    561. 

  561. 

  562. </div>
    563. 

  563. <div id="execAffectedRows-procs-all">
    564. 

  564.   <div id="execAffectedRows,DbConn,SqlQuery,varargs[string,]">
    565. 

  565.   <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_sqlite.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> {.
    566. 

  566.     <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>
    567. 

  567.   <dd>
    568. 

  568.     
    569. 

  569.     <p>Executes the query (typically &quot;UPDATE&quot;) and returns the number of affected rows.</p>
    570. 

  570. <p><strong>Examples:</strong></p>
    571. 

  571. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    572. 

  572. 

  573. <span class="Comment"># Records of my_table:</span>
    574. 

  574. <span class="Comment"># | id | name     |</span>
    575. 

  575. <span class="Comment"># |----|----------|</span>
    576. 

  576. <span class="Comment"># |  1 | item#1   |</span>
    577. 

  577. <span class="Comment"># |  2 | item#2   |</span>
    578. 

  578. 

  579. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">execAffectedRows</span><span class="Punctuation">(</span><span class="RawData">sql&quot;UPDATE my_table SET name = 'TEST'&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
    580. 

  580. 

  581. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    582. 

  582. 

  583.     
    584. 

  584.   </dd>
    585. 

  585. </div>
    586. 

  586. <div id="execAffectedRows,DbConn,SqlPrepared">
    587. 

  587.   <dt><pre><span class="Keyword">proc</span> <a href="#execAffectedRows%2CDbConn%2CSqlPrepared"><span class="Identifier">execAffectedRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int64</span> {.
    588. 

  588.     <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>
    589. 

  589.   <dd>
    590. 

  590.     
    591. 

  591.     
    592. 

  592.     
    593. 

  593.   </dd>
    594. 

  594. </div>
    595. 

  595. 

  596. </div>
    597. 

  597. <div id="finalize-procs-all">
    598. 

  598.   <div id="finalize,SqlPrepared">
    599. 

  599.   <dt><pre><span class="Keyword">proc</span> <a href="#finalize%2CSqlPrepared"><span class="Identifier">finalize</span></a><span class="Other">(</span><span class="Identifier">sqlPrepared</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">)</span> {.<span class="Identifier">discardable</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>
    600. 

  600.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    601. 

  601.   <dd>
    602. 

  602.     
    603. 

  603.     
    604. 

  604.     
    605. 

  605.   </dd>
    606. 

  606. </div>
    607. 

  607. 

  608. </div>
    609. 

  609. <div id="getAllRows-procs-all">
    610. 

  610.   <div id="getAllRows,DbConn,SqlQuery,varargs[string,]">
    611. 

  611.   <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_sqlite.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>
    612. 

  612.     <a href="db_sqlite.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>
    613. 

  613.   <dd>
    614. 

  614.     
    615. 

  615.     <p>Executes the query and returns the whole result dataset.</p>
    616. 

  616. <p><strong>Examples:</strong></p>
    617. 

  617. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    618. 

  618. 

  619. <span class="Comment"># Records of my_table:</span>
    620. 

  620. <span class="Comment"># | id | name     |</span>
    621. 

  621. <span class="Comment"># |----|----------|</span>
    622. 

  622. <span class="Comment"># |  1 | item#1   |</span>
    623. 

  623. <span class="Comment"># |  2 | item#2   |</span>
    624. 

  624. 

  625. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getAllRows</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT id, name FROM my_table&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Identifier">Row</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;1&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;item#1&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">Row</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;2&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;item#2&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">]</span>
    626. 

  626. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    627. 

  627. 

  628.     
    629. 

  629.   </dd>
    630. 

  630. </div>
    631. 

  631. <div id="getAllRows,DbConn,SqlPrepared">
    632. 

  632.   <dt><pre><span class="Keyword">proc</span> <a href="#getAllRows%2CDbConn%2CSqlPrepared"><span class="Identifier">getAllRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="db_sqlite.html#Row"><span class="Identifier">Row</span></a><span class="Other">]</span> {.
    633. 

  633.     <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>
    634. 

  634.   <dd>
    635. 

  635.     
    636. 

  636.     
    637. 

  637.     
    638. 

  638.   </dd>
    639. 

  639. </div>
    640. 

  640. 

  641. </div>
    642. 

  642. <div id="getRow-procs-all">
    643. 

  643.   <div id="getRow,DbConn,SqlQuery,varargs[string,]">
    644. 

  644.   <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_sqlite.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_sqlite.html#Row"><span class="Identifier">Row</span></a> {.
    645. 

  645.     <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>
    646. 

  646.   <dd>
    647. 

  647.     
    648. 

  648.     <p>Retrieves a single row. If the query doesn't return any rows, this proc will return a <tt class="docutils literal"><span class="pre"><span class="Identifier">Row</span></span></tt> with empty strings for each column.</p>
    649. 

  649. <p><strong>Examples:</strong></p>
    650. 

  650. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    651. 

  651. 

  652. <span class="Comment"># Records of my_table:</span>
    653. 

  653. <span class="Comment"># | id | name     |</span>
    654. 

  654. <span class="Comment"># |----|----------|</span>
    655. 

  655. <span class="Comment"># |  1 | item#1   |</span>
    656. 

  656. <span class="Comment"># |  2 | item#2   |</span>
    657. 

  657. 

  658. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getRow</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT id, name FROM my_table&quot;</span>
    659. 

  659.                    <span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">Row</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;1&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;item#1&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    660. 

  660. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getRow</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT id, name FROM my_table WHERE id = ?&quot;</span><span class="Punctuation">,</span>
    661. 

  661.                    <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">Row</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;2&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;item#2&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    662. 

  662. 

  663. <span class="Comment"># Returns empty.</span>
    664. 

  664. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getRow</span><span class="Punctuation">(</span><span class="RawData">sql&quot;INSERT INTO my_table (id, name) VALUES (?, ?)&quot;</span><span class="Punctuation">,</span>
    665. 

  665.                    <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="StringLit">&quot;item#3&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">]</span>
    666. 

  666. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getRow</span><span class="Punctuation">(</span><span class="RawData">sql&quot;DELETE FROM my_table WHERE id = ?&quot;</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">]</span>
    667. 

  667. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getRow</span><span class="Punctuation">(</span><span class="RawData">sql&quot;UPDATE my_table SET name = 'ITEM#1' WHERE id = ?&quot;</span><span class="Punctuation">,</span>
    668. 

  668.                    <span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">]</span>
    669. 

  669. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    670. 

  670. 

  671.     
    672. 

  672.   </dd>
    673. 

  673. </div>
    674. 

  674. 

  675. </div>
    676. 

  676. <div id="getValue-procs-all">
    677. 

  677.   <div id="getValue,DbConn,SqlQuery,varargs[string,]">
    678. 

  678.   <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_sqlite.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> {.
    679. 

  679.     <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>
    680. 

  680.   <dd>
    681. 

  681.     
    682. 

  682.     <p>Executes the query and returns the first column of the first row of the result dataset. Returns <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;&quot;</span></span></tt> if the dataset contains no rows or the database value is <tt class="docutils literal"><span class="pre"><span class="Identifier">NULL</span></span></tt>.</p>
    683. 

  683. <p><strong>Examples:</strong></p>
    684. 

  684. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    685. 

  685. 

  686. <span class="Comment"># Records of my_table:</span>
    687. 

  687. <span class="Comment"># | id | name     |</span>
    688. 

  688. <span class="Comment"># |----|----------|</span>
    689. 

  689. <span class="Comment"># |  1 | item#1   |</span>
    690. 

  690. <span class="Comment"># |  2 | item#2   |</span>
    691. 

  691. 

  692. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getValue</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT name FROM my_table WHERE id = ?&quot;</span><span class="Punctuation">,</span>
    693. 

  693.                      <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;item#2&quot;</span>
    694. 

  694. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getValue</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT id, name FROM my_table&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;1&quot;</span>
    695. 

  695. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">getValue</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT name, id FROM my_table&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;item#1&quot;</span>
    696. 

  696. 

  697. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    698. 

  698. 

  699.     
    700. 

  700.   </dd>
    701. 

  701. </div>
    702. 

  702. <div id="getValue,DbConn,SqlPrepared">
    703. 

  703.   <dt><pre><span class="Keyword">proc</span> <a href="#getValue%2CDbConn%2CSqlPrepared"><span class="Identifier">getValue</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.
    704. 

  704.     <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>
    705. 

  705.   <dd>
    706. 

  706.     
    707. 

  707.     
    708. 

  708.     
    709. 

  709.   </dd>
    710. 

  710. </div>
    711. 

  711. 

  712. </div>
    713. 

  713. <div id="insert-procs-all">
    714. 

  714.   <div id="insert,DbConn,SqlQuery,string,varargs[string,]">
    715. 

  715.   <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_sqlite.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>
    716. 

  716.             <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>
    717. 

  717.     <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>
    718. 

  718.   <dd>
    719. 

  719.     
    720. 

  720.     same as insertId
    721. 

  721.     
    722. 

  722.   </dd>
    723. 

  723. </div>
    724. 

  724. 

  725. </div>
    726. 

  726. <div id="insertID-procs-all">
    727. 

  727.   <div id="insertID,DbConn,SqlQuery,varargs[string,]">
    728. 

  728.   <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_sqlite.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> {.
    729. 

  729.     <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="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    730. 

  730.   <dd>
    731. 

  731.     
    732. 

  732.     <p>Executes the query (typically &quot;INSERT&quot;) and returns the generated ID for the row.</p>
    733. 

  733. <p>Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">DbError</span></span></tt> exception when failed to insert 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>.</p>
    734. 

  734. <p><strong>Examples:</strong></p>
    735. 

  735. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    736. 

  736. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql&quot;CREATE TABLE my_table (id INTEGER, name VARCHAR(50) NOT NULL)&quot;</span><span class="Punctuation">)</span>
    737. 

  737. 

  738. <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">2</span><span class="Punctuation">:</span>
    739. 

  739.   <span class="Keyword">let</span> <span class="Identifier">id</span> <span class="Operator">=</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">insertID</span><span class="Punctuation">(</span><span class="RawData">sql&quot;INSERT INTO my_table (id, name) VALUES (?, ?)&quot;</span><span class="Punctuation">,</span> <span class="Identifier">i</span><span class="Punctuation">,</span> <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>
    740. 

  740.   <span class="Identifier">echo</span> <span class="StringLit">&quot;LoopIndex = &quot;</span><span class="Punctuation">,</span> <span class="Identifier">i</span><span class="Punctuation">,</span> <span class="StringLit">&quot;, InsertID = &quot;</span><span class="Punctuation">,</span> <span class="Identifier">id</span>
    741. 

  741. 

  742. <span class="Comment"># Output:</span>
    743. 

  743. <span class="Comment"># LoopIndex = 0, InsertID = 1</span>
    744. 

  744. <span class="Comment"># LoopIndex = 1, InsertID = 2</span>
    745. 

  745. <span class="Comment"># LoopIndex = 2, InsertID = 3</span>
    746. 

  746. 

  747. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    748. 

  748. 

  749.     
    750. 

  750.   </dd>
    751. 

  751. </div>
    752. 

  752. 

  753. </div>
    754. 

  754. <div id="len-procs-all">
    755. 

  755.   <div id="len,InstantRow">
    756. 

  756.   <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_sqlite.html#InstantRow"><span class="Identifier">InstantRow</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int32</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>
    757. 

  757.   <dd>
    758. 

  758.     
    759. 

  759.     <p>Returns number of columns in a row.</p>
    760. 

  760. <p>See also:</p>
    761. 

  761. <ul class="simple"><li><a class="reference external" href="#instantRows.i,DbConn,SqlQuery,varargs[string,]">instantRows iterator</a> example code</li>
    762. 

  762. </ul>
    763. 

  763. 

  764.     
    765. 

  765.   </dd>
    766. 

  766. </div>
    767. 

  767. 

  768. </div>
    769. 

  769. <div id="open-procs-all">
    770. 

  770.   <div id="open,string,string,string,string">
    771. 

  771.   <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_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a> {.
    772. 

  772.     <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>
    773. 

  773.   <dd>
    774. 

  774.     
    775. 

  775.     <p>Opens a database connection. Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">DbError</span></span></tt> exception if the connection could not be established.</p>
    776. 

  776. <p><strong>Note:</strong> Only the <tt class="docutils literal"><span class="pre"><span class="Identifier">connection</span></span></tt> parameter is used for <tt class="docutils literal"><span class="pre"><span class="Identifier">sqlite</span></span></tt>.</p>
    777. 

  777. <p><strong>Examples:</strong></p>
    778. 

  778. <p><pre class="listing"><span class="Keyword">try</span><span class="Punctuation">:</span>
    779. 

  779.   <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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    780. 

  780.   <span class="Comment">## do something...</span>
    781. 

  781.   <span class="Comment">## db.getAllRows(sql&quot;SELECT * FROM my_table&quot;)</span>
    782. 

  782.   <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    783. 

  783. <span class="Keyword">except</span><span class="Punctuation">:</span>
    784. 

  784.   <span class="Identifier">stderr</span><span class="Operator">.</span><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="Identifier">getCurrentExceptionMsg</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre></p>
    785. 

  785. 

  786.     
    787. 

  787.   </dd>
    788. 

  788. </div>
    789. 

  789. 

  790. </div>
    791. 

  791. <div id="prepare-procs-all">
    792. 

  792.   <div id="prepare,DbConn,string">
    793. 

  793.   <dt><pre><span class="Keyword">proc</span> <a href="#prepare%2CDbConn%2Cstring"><span class="Identifier">prepare</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">q</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="db_sqlite.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>
    794. 

  794.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    795. 

  795.   <dd>
    796. 

  796.     
    797. 

  797.     Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SqlPrepared</span></span></tt> statement.
    798. 

  798.     
    799. 

  799.   </dd>
    800. 

  800. </div>
    801. 

  801. 

  802. </div>
    803. 

  803. <div id="setEncoding-procs-all">
    804. 

  804.   <div id="setEncoding,DbConn,string">
    805. 

  805.   <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_sqlite.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>
    806. 

  806.     <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>
    807. 

  807.   <dd>
    808. 

  808.     
    809. 

  809.     <p>Sets the encoding of a database connection, returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> for success, <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> for failure.</p>
    810. 

  810. <p><strong>Note:</strong> The encoding cannot be changed once it's been set. According to SQLite3 documentation, any attempt to change the encoding after the database is created will be silently ignored.</p>
    811. 

  811. 

  812.     
    813. 

  813.   </dd>
    814. 

  814. </div>
    815. 

  815. 

  816. </div>
    817. 

  817. <div id="tryExec-procs-all">
    818. 

  818.   <div id="tryExec,DbConn,SqlQuery,varargs[string,]">
    819. 

  819.   <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_sqlite.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> {.
    820. 

  820.     <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>
    821. 

  821.   <dd>
    822. 

  822.     
    823. 

  823.     <p>Tries to execute the query and returns <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> if successful, <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> otherwise.</p>
    824. 

  824. <p><strong>Examples:</strong></p>
    825. 

  825. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    826. 

  826. <span class="Keyword">if</span> <span class="Keyword">not</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">tryExec</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT * FROM my_table&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    827. 

  827.   <span class="Identifier">dbError</span><span class="Punctuation">(</span><span class="Identifier">db</span><span class="Punctuation">)</span>
    828. 

  828. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    829. 

  829. 

  830.     
    831. 

  831.   </dd>
    832. 

  832. </div>
    833. 

  833. <div id="tryExec,DbConn,SqlPrepared">
    834. 

  834.   <dt><pre><span class="Keyword">proc</span> <a href="#tryExec%2CDbConn%2CSqlPrepared"><span class="Identifier">tryExec</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.
    835. 

  835.     <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>
    836. 

  836.   <dd>
    837. 

  837.     
    838. 

  838.     
    839. 

  839.     
    840. 

  840.   </dd>
    841. 

  841. </div>
    842. 

  842. 

  843. </div>
    844. 

  844. <div id="tryInsert-procs-all">
    845. 

  845.   <div id="tryInsert,DbConn,SqlQuery,string,varargs[string,]">
    846. 

  846.   <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_sqlite.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>
    847. 

  847.                <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>
    848. 

  848.     <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>
    849. 

  849.   <dd>
    850. 

  850.     
    851. 

  851.     same as tryInsertID
    852. 

  852.     
    853. 

  853.   </dd>
    854. 

  854. </div>
    855. 

  855. 

  856. </div>
    857. 

  857. <div id="tryInsertID-procs-all">
    858. 

  858.   <div id="tryInsertID,DbConn,SqlQuery,varargs[string,]">
    859. 

  859.   <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_sqlite.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> {.
    860. 

  860.     <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><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>
    861. 

  861.   <dd>
    862. 

  862.     
    863. 

  863.     <p>Executes the query (typically &quot;INSERT&quot;) and returns the generated ID for the row or -1 in case of an error.</p>
    864. 

  864. <p><strong>Examples:</strong></p>
    865. 

  865. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    866. 

  866. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql&quot;CREATE TABLE my_table (id INTEGER, name VARCHAR(50) NOT NULL)&quot;</span><span class="Punctuation">)</span>
    867. 

  867. 

  868. <span class="Identifier">doAssert</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">tryInsertID</span><span class="Punctuation">(</span><span class="RawData">sql&quot;INSERT INTO not_exist_table (id, name) VALUES (?, ?)&quot;</span><span class="Punctuation">,</span>
    869. 

  869.                         <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="StringLit">&quot;item#1&quot;</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span>
    870. 

  870. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    871. 

  871. 

  872.     
    873. 

  873.   </dd>
    874. 

  874. </div>
    875. 

  875. 

  876. </div>
    877. 

  877. <div id="unsafeColumnAt-procs-all">
    878. 

  878.   <div id="unsafeColumnAt,InstantRow,int32">
    879. 

  879.   <dt><pre><span class="Keyword">proc</span> <a href="#unsafeColumnAt%2CInstantRow%2Cint32"><span class="Identifier">unsafeColumnAt</span></a><span class="Other">(</span><span class="Identifier">row</span><span class="Other">:</span> <a href="db_sqlite.html#InstantRow"><span class="Identifier">InstantRow</span></a><span class="Other">;</span> <span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">int32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cstring</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
    880. 

  880.     <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>
    881. 

  881.   <dd>
    882. 

  882.     
    883. 

  883.     <p>Returns cstring for given column of the row.</p>
    884. 

  884. <p>See also:</p>
    885. 

  885. <ul class="simple"><li><a class="reference external" href="#instantRows.i,DbConn,SqlQuery,varargs[string,]">instantRows iterator</a> example code</li>
    886. 

  886. </ul>
    887. 

  887. 

  888.     
    889. 

  889.   </dd>
    890. 

  890. </div>
    891. 

  891. 

  892. </div>
    893. 

  893. 

  894.   </dl>
    895. 

  895. </div>
    896. 

  896. <div class="section" id="15">
    897. 

  897.   <h1><a class="toc-backref" href="#15">Iterators</a></h1>
    898. 

  898.   <dl class="item">
    899. 

  899.     <div id="fastRows-iterators-all">
    900. 

  900.   <div id="fastRows.i,DbConn,SqlQuery,varargs[string,]">
    901. 

  901.   <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_sqlite.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_sqlite.html#Row"><span class="Identifier">Row</span></a> {.
    902. 

  902.     <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="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>
    903. 

  903.   <dd>
    904. 

  904.     
    905. 

  905.     <p>Executes the query and iterates over the result dataset.</p>
    906. 

  906. <p>This is very fast, but potentially dangerous. Use this iterator only if you require <strong>ALL</strong> the rows.</p>
    907. 

  907. <p><strong>Note:</strong> Breaking the <tt class="docutils literal"><span class="pre"><span class="Identifier">fastRows</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt> iterator during a loop will cause the next database query to raise a <tt class="docutils literal"><span class="pre"><span class="Identifier">DbError</span></span></tt> exception <tt class="docutils literal"><span class="pre"><span class="Identifier">unable</span> <span class="Identifier">to</span> <span class="Identifier">close</span> <span class="Identifier">due</span> <span class="Identifier">to</span> <span class="Operator">...</span></span></tt>.</p>
    908. 

  908. <p><strong>Examples:</strong></p>
    909. 

  909. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    910. 

  910. 

  911. <span class="Comment"># Records of my_table:</span>
    912. 

  912. <span class="Comment"># | id | name     |</span>
    913. 

  913. <span class="Comment"># |----|----------|</span>
    914. 

  914. <span class="Comment"># |  1 | item#1   |</span>
    915. 

  915. <span class="Comment"># |  2 | item#2   |</span>
    916. 

  916. 

  917. <span class="Keyword">for</span> <span class="Identifier">row</span> <span class="Keyword">in</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">fastRows</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT id, name FROM my_table&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    918. 

  918.   <span class="Identifier">echo</span> <span class="Identifier">row</span>
    919. 

  919. 

  920. <span class="Comment"># Output:</span>
    921. 

  921. <span class="Comment"># @[&quot;1&quot;, &quot;item#1&quot;]</span>
    922. 

  922. <span class="Comment"># @[&quot;2&quot;, &quot;item#2&quot;]</span>
    923. 

  923. 

  924. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    925. 

  925. 

  926.     
    927. 

  927.   </dd>
    928. 

  928. </div>
    929. 

  929. <div id="fastRows.i,DbConn,SqlPrepared">
    930. 

  930.   <dt><pre><span class="Keyword">iterator</span> <a href="#fastRows.i%2CDbConn%2CSqlPrepared"><span class="Identifier">fastRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">)</span><span class="Other">:</span> <a href="db_sqlite.html#Row"><span class="Identifier">Row</span></a> {.
    931. 

  931.     <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>
    932. 

  932.   <dd>
    933. 

  933.     
    934. 

  934.     
    935. 

  935.     
    936. 

  936.   </dd>
    937. 

  937. </div>
    938. 

  938. 

  939. </div>
    940. 

  940. <div id="instantRows-iterators-all">
    941. 

  941.   <div id="instantRows.i,DbConn,DbColumns,SqlQuery,varargs[string,]">
    942. 

  942.   <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_sqlite.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>
    943. 

  943.                      <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_sqlite.html#InstantRow"><span class="Identifier">InstantRow</span></a> {.
    944. 

  944.     <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="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>
    945. 

  945.   <dd>
    946. 

  946.     
    947. 

  947.     <p>Similar to <a class="reference external" href="#instantRows.i,DbConn,SqlQuery,varargs[string,]">instantRows iterator</a>, but sets information about columns to <tt class="docutils literal"><span class="pre"><span class="Identifier">columns</span></span></tt>.</p>
    948. 

  948. <p><strong>Examples:</strong></p>
    949. 

  949. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    950. 

  950. 

  951. <span class="Comment"># Records of my_table:</span>
    952. 

  952. <span class="Comment"># | id | name     |</span>
    953. 

  953. <span class="Comment"># |----|----------|</span>
    954. 

  954. <span class="Comment"># |  1 | item#1   |</span>
    955. 

  955. <span class="Comment"># |  2 | item#2   |</span>
    956. 

  956. 

  957. <span class="Keyword">var</span> <span class="Identifier">columns</span><span class="Punctuation">:</span> <span class="Identifier">DbColumns</span>
    958. 

  958. <span class="Keyword">for</span> <span class="Identifier">row</span> <span class="Keyword">in</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">instantRows</span><span class="Punctuation">(</span><span class="Identifier">columns</span><span class="Punctuation">,</span> <span class="RawData">sql&quot;SELECT * FROM my_table&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    959. 

  959.   <span class="Keyword">discard</span>
    960. 

  960. <span class="Identifier">echo</span> <span class="Identifier">columns</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span>
    961. 

  961. 

  962. <span class="Comment"># Output:</span>
    963. 

  963. <span class="Comment"># (name: &quot;id&quot;, tableName: &quot;my_table&quot;, typ: (kind: dbNull,</span>
    964. 

  964. <span class="Comment"># notNull: false, name: &quot;INTEGER&quot;, size: 0, maxReprLen: 0, precision: 0,</span>
    965. 

  965. <span class="Comment"># scale: 0, min: 0, max: 0, validValues: @[]), primaryKey: false,</span>
    966. 

  966. <span class="Comment"># foreignKey: false)</span>
    967. 

  967. 

  968. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    969. 

  969. 

  970.     
    971. 

  971.   </dd>
    972. 

  972. </div>
    973. 

  973. <div id="instantRows.i,DbConn,SqlQuery,varargs[string,]">
    974. 

  974.   <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_sqlite.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_sqlite.html#InstantRow"><span class="Identifier">InstantRow</span></a> {.
    975. 

  975.     <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="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>
    976. 

  976.   <dd>
    977. 

  977.     
    978. 

  978.     <p>Similar to <a class="reference external" href="#fastRows.i,DbConn,SqlQuery,varargs[string,]">fastRows iterator</a> 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.</p>
    979. 

  979. <p><strong>Examples:</strong></p>
    980. 

  980. <p><pre class="listing"> <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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    981. 

  981.  
    982. 

  982.  <span class="Comment"># Records of my_table:</span>
    983. 

  983.  <span class="Comment"># | id | name     |</span>
    984. 

  984.  <span class="Comment"># |----|----------|</span>
    985. 

  985.  <span class="Comment"># |  1 | item#1   |</span>
    986. 

  986.  <span class="Comment"># |  2 | item#2   |</span>
    987. 

  987.  
    988. 

  988.  <span class="Keyword">for</span> <span class="Identifier">row</span> <span class="Keyword">in</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">instantRows</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT * FROM my_table&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    989. 

  989.    <span class="Identifier">echo</span> <span class="StringLit">&quot;id:&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">row</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span>
    990. 

  990.    <span class="Identifier">echo</span> <span class="StringLit">&quot;name:&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">row</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span>
    991. 

  991.    <span class="Identifier">echo</span> <span class="StringLit">&quot;length:&quot;</span> <span class="Operator">&amp;</span> <span class="Operator">$</span><span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">row</span><span class="Punctuation">)</span>
    992. 

  992.  
    993. 

  993.  <span class="Comment"># Output:</span>
    994. 

  994.  <span class="Comment"># id:1</span>
    995. 

  995.  <span class="Comment"># name:item#1</span>
    996. 

  996.  <span class="Comment"># length:2</span>
    997. 

  997.  <span class="Comment"># id:2</span>
    998. 

  998.  <span class="Comment"># name:item#2</span>
    999. 

  999.  <span class="Comment"># length:2</span>
    1000. 

  1000.  
    1001. 

  1001.  <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    1002. 

  1002. 

  1003.     
    1004. 

  1004.   </dd>
    1005. 

  1005. </div>
    1006. 

  1006. <div id="instantRows.i,DbConn,SqlPrepared">
    1007. 

  1007.   <dt><pre><span class="Keyword">iterator</span> <a href="#instantRows.i%2CDbConn%2CSqlPrepared"><span class="Identifier">instantRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">)</span><span class="Other">:</span> <a href="db_sqlite.html#InstantRow"><span class="Identifier">InstantRow</span></a> {.
    1008. 

  1008.     <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>
    1009. 

  1009.   <dd>
    1010. 

  1010.     
    1011. 

  1011.     
    1012. 

  1012.     
    1013. 

  1013.   </dd>
    1014. 

  1014. </div>
    1015. 

  1015. 

  1016. </div>
    1017. 

  1017. <div id="rows-iterators-all">
    1018. 

  1018.   <div id="rows.i,DbConn,SqlQuery,varargs[string,]">
    1019. 

  1019.   <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_sqlite.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_sqlite.html#Row"><span class="Identifier">Row</span></a> {.
    1020. 

  1020.     <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>
    1021. 

  1021.   <dd>
    1022. 

  1022.     
    1023. 

  1023.     <p>Similar to <a class="reference external" href="#fastRows.i,DbConn,SqlQuery,varargs[string,]">fastRows iterator</a>, but slower and safe.</p>
    1024. 

  1024. <p><strong>Examples:</strong></p>
    1025. 

  1025. <p><pre class="listing"><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">&quot;mytest.db&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;&quot;</span><span class="Punctuation">)</span>
    1026. 

  1026. 

  1027. <span class="Comment"># Records of my_table:</span>
    1028. 

  1028. <span class="Comment"># | id | name     |</span>
    1029. 

  1029. <span class="Comment"># |----|----------|</span>
    1030. 

  1030. <span class="Comment"># |  1 | item#1   |</span>
    1031. 

  1031. <span class="Comment"># |  2 | item#2   |</span>
    1032. 

  1032. 

  1033. <span class="Keyword">for</span> <span class="Identifier">row</span> <span class="Keyword">in</span> <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">rows</span><span class="Punctuation">(</span><span class="RawData">sql&quot;SELECT id, name FROM my_table&quot;</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
    1034. 

  1034.   <span class="Identifier">echo</span> <span class="Identifier">row</span>
    1035. 

  1035. 

  1036. <span class="Comment">## Output:</span>
    1037. 

  1037. <span class="Comment">## @[&quot;1&quot;, &quot;item#1&quot;]</span>
    1038. 

  1038. <span class="Comment">## @[&quot;2&quot;, &quot;item#2&quot;]</span>
    1039. 

  1039. 

  1040. <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
    1041. 

  1041. 

  1042.     
    1043. 

  1043.   </dd>
    1044. 

  1044. </div>
    1045. 

  1045. <div id="rows.i,DbConn,SqlPrepared">
    1046. 

  1046.   <dt><pre><span class="Keyword">iterator</span> <a href="#rows.i%2CDbConn%2CSqlPrepared"><span class="Identifier">rows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">)</span><span class="Other">:</span> <a href="db_sqlite.html#Row"><span class="Identifier">Row</span></a> {.
    1047. 

  1047.     <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>
    1048. 

  1048.   <dd>
    1049. 

  1049.     
    1050. 

  1050.     
    1051. 

  1051.     
    1052. 

  1052.   </dd>
    1053. 

  1053. </div>
    1054. 

  1054. 

  1055. </div>
    1056. 

  1056. 

  1057.   </dl>
    1058. 

  1058. </div>
    1059. 

  1059. <div class="section" id="17">
    1060. 

  1060.   <h1><a class="toc-backref" href="#17">Macros</a></h1>
    1061. 

  1061.   <dl class="item">
    1062. 

  1062.     <div id="bindParams-macros-all">
    1063. 

  1063.   <div id="bindParams.m,SqlPrepared,varargs[untyped]">
    1064. 

  1064.   <dt><pre><span class="Keyword">macro</span> <a href="#bindParams.m%2CSqlPrepared%2Cvarargs%5Buntyped%5D"><span class="Identifier">bindParams</span></a><span class="Other">(</span><span class="Identifier">ps</span><span class="Other">:</span> <a href="db_sqlite.html#SqlPrepared"><span class="Identifier">SqlPrepared</span></a><span class="Other">;</span> <span class="Identifier">params</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">untyped</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
    1065. 

  1065.   <dd>
    1066. 

  1066.     
    1067. 

  1067.     
    1068. 

  1068.     
    1069. 

  1069.   </dd>
    1070. 

  1070. </div>
    1071. 

  1071. 

  1072. </div>
    1073. 

  1073. 

  1074.   </dl>
    1075. 

  1075. </div>
    1076. 

  1076. <div class="section" id="18">
    1077. 

  1077.   <h1><a class="toc-backref" href="#18">Templates</a></h1>
    1078. 

  1078.   <dl class="item">
    1079. 

  1079.     <div id="dbBindParamError-templates-all">
    1080. 

  1080.   <div id="dbBindParamError.t,int,varargs[untyped]">
    1081. 

  1081.   <dt><pre><span class="Keyword">template</span> <a href="#dbBindParamError.t%2Cint%2Cvarargs%5Buntyped%5D"><span class="Identifier">dbBindParamError</span></a><span class="Other">(</span><span class="Identifier">paramIdx</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">untyped</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
    1082. 

  1082.   <dd>
    1083. 

  1083.     
    1084. 

  1084.     Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">DbError</span></span></tt> exception.
    1085. 

  1085.     
    1086. 

  1086.   </dd>
    1087. 

  1087. </div>
    1088. 

  1088. 

  1089. </div>
    1090. 

  1090. <div id="exec-templates-all">
    1091. 

  1091.   <div id="exec.t,DbConn,SqlPrepared,varargs[typed]">
    1092. 

  1092.   <dt><pre><span class="Keyword">template</span> <a href="#exec.t%2CDbConn%2CSqlPrepared%2Cvarargs%5Btyped%5D"><span class="Identifier">exec</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a><span class="Other">;</span> <span class="Identifier">stmtName</span><span class="Other">:</span> <a href="db_sqlite.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">typed</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
    1093. 

  1093.   <dd>
    1094. 

  1094.     
    1095. 

  1095.     
    1096. 

  1096.     
    1097. 

  1097.   </dd>
    1098. 

  1098. </div>
    1099. 

  1099. 

  1100. </div>
    1101. 

  1101. 

  1102.   </dl>
    1103. 

  1103. </div>
    1104. 

  1104. 

  1105.   </div>
    1106. 

  1106. </div>
    1107. 

  1107. 

  1108.       <div class="twelve-columns footer">
    1109. 

  1109.         <span class="nim-sprite"></span>
    1110. 

  1110.         <br>
    1111. 

  1111.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:39 UTC</small>
    1112. 

  1112.       </div>
    1113. 

  1113.     </div>
    1114. 

  1114.   </div>
    1115. 

  1115.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    1116. 

  1116.     
    1117. 

  1117. </body>
    1118. 

  1118. </html>
    1119. 

  1119.