123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119 |
- <?xml version="1.0" encoding="utf-8" ?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <!-- This file is generated by Nim. -->
- <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>src/db_connector/db_sqlite</title>
- <!-- Google fonts -->
- <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
- <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
- <!-- Favicon -->
- <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
- <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
- <!-- CSS -->
- <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
- <!-- JS -->
- <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
- </head>
- <body>
- <div class="document" id="documentId">
- <div class="container">
- <h1 class="title">src/db_connector/db_sqlite</h1>
- <div class="row">
- <div class="three columns">
- <div class="theme-select-wrapper">
- <label for="theme-select">Theme: </label>
- <select id="theme-select" onchange="setTheme(this.value)">
- <option value="auto">🌗 Match OS</option>
- <option value="dark">🌑 Dark</option>
- <option value="light">🌕 Light</option>
- </select>
- </div>
- <div id="global-links">
- <ul class="simple-boot">
- <li><a href="manual.html">Manual</a></li>
- <li><a href="lib.html">Standard library</a></li>
- <li> <a id="indexLink" href="theindex.html">Index</a></li>
- <li><a href="compiler/theindex.html">Compiler docs</a></li>
- <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
- <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
- </ul>
- </div>
- <div id="searchInputDiv">
- Search: <input type="search" id="searchInput"
- oninput="search()" />
- </div>
-
- <ul class="simple simple-toc" id="toc-list">
- <li><a class="reference" id="basic-usage_toc" href="#basic-usage">Basic usage</a></li>
- <ul class="simple"><li><a class="reference" id="basic-usage-parameter-substitution_toc" href="#basic-usage-parameter-substitution">Parameter substitution</a></li>
- <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>
- <li><a class="reference" id="basic-usage-creating-a-table_toc" href="#basic-usage-creating-a-table">Creating a table</a></li>
- <li><a class="reference" id="basic-usage-inserting-data_toc" href="#basic-usage-inserting-data">Inserting data</a></li>
- <li><a class="reference" id="basic-usage-larger-example_toc" href="#basic-usage-larger-example">Larger example</a></li>
- <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>
- </ul><li><a class="reference" id="note_toc" href="#note">Note</a></li>
- <li><a class="reference" id="see-also_toc" href="#see-also">See also</a></li>
- <li>
- <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#DbConn" title="DbConn = PSqlite3">DbConn</a></li>
- <li><a class="reference" href="#InstantRow" title="InstantRow = PStmt">InstantRow</a></li>
- <li><a class="reference" href="#Row" title="Row = seq[string]">Row</a></li>
- <li><a class="reference" href="#SqlPrepared" title="SqlPrepared = distinct PStmt">SqlPrepared</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">[]
- <li><a class="reference" href="#%5B%5D%2CInstantRow%2Cint32" title="`[]`(row: InstantRow; col: int32): string">`[]`(row: InstantRow; col: int32): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">bindNull
- <li><a class="reference" href="#bindNull%2CSqlPrepared%2Cint" title="bindNull(ps: SqlPrepared; paramIdx: int)">bindNull(ps: SqlPrepared; paramIdx: int)</a></li>
- </ul>
- <ul class="simple nested-toc-section">bindParam
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- </ul>
- <ul class="simple nested-toc-section">close
- <li><a class="reference" href="#close%2CDbConn" title="close(db: DbConn)">close(db: DbConn)</a></li>
- </ul>
- <ul class="simple nested-toc-section">dbError
- <li><a class="reference" href="#dbError%2CDbConn" title="dbError(db: DbConn)">dbError(db: DbConn)</a></li>
- </ul>
- <ul class="simple nested-toc-section">dbQuote
- <li><a class="reference" href="#dbQuote%2Cstring" title="dbQuote(s: string): string">dbQuote(s: string): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">exec
- <li><a class="reference" href="#exec%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="exec(db: DbConn; query: SqlQuery; args: varargs[string, `$`])">exec(db: DbConn; query: SqlQuery; args: varargs[string, `$`])</a></li>
- </ul>
- <ul class="simple nested-toc-section">execAffectedRows
- <li><a class="reference" href="#execAffectedRows%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="execAffectedRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64">execAffectedRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64</a></li>
- <li><a class="reference" href="#execAffectedRows%2CDbConn%2CSqlPrepared" title="execAffectedRows(db: DbConn; stmtName: SqlPrepared): int64">execAffectedRows(db: DbConn; stmtName: SqlPrepared): int64</a></li>
- </ul>
- <ul class="simple nested-toc-section">finalize
- <li><a class="reference" href="#finalize%2CSqlPrepared" title="finalize(sqlPrepared: SqlPrepared)">finalize(sqlPrepared: SqlPrepared)</a></li>
- </ul>
- <ul class="simple nested-toc-section">getAllRows
- <li><a class="reference" href="#getAllRows%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="getAllRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): seq[Row]">getAllRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): seq[Row]</a></li>
- <li><a class="reference" href="#getAllRows%2CDbConn%2CSqlPrepared" title="getAllRows(db: DbConn; stmtName: SqlPrepared): seq[Row]">getAllRows(db: DbConn; stmtName: SqlPrepared): seq[Row]</a></li>
- </ul>
- <ul class="simple nested-toc-section">getRow
- <li><a class="reference" href="#getRow%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="getRow(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row">getRow(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row</a></li>
- </ul>
- <ul class="simple nested-toc-section">getValue
- <li><a class="reference" href="#getValue%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="getValue(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): string">getValue(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): string</a></li>
- <li><a class="reference" href="#getValue%2CDbConn%2CSqlPrepared" title="getValue(db: DbConn; stmtName: SqlPrepared): string">getValue(db: DbConn; stmtName: SqlPrepared): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">insert
- <li><a class="reference" href="#insert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D" title="insert(db: DbConn; query: SqlQuery; pkName: string; args: varargs[string, `$`]): int64">insert(db: DbConn; query: SqlQuery; pkName: string; args: varargs[string, `$`]): int64</a></li>
- </ul>
- <ul class="simple nested-toc-section">insertID
- <li><a class="reference" href="#insertID%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="insertID(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64">insertID(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64</a></li>
- </ul>
- <ul class="simple nested-toc-section">len
- <li><a class="reference" href="#len%2CInstantRow" title="len(row: InstantRow): int32">len(row: InstantRow): int32</a></li>
- </ul>
- <ul class="simple nested-toc-section">open
- <li><a class="reference" href="#open%2Cstring%2Cstring%2Cstring%2Cstring" title="open(connection, user, password, database: string): DbConn">open(connection, user, password, database: string): DbConn</a></li>
- </ul>
- <ul class="simple nested-toc-section">prepare
- <li><a class="reference" href="#prepare%2CDbConn%2Cstring" title="prepare(db: DbConn; q: string): SqlPrepared">prepare(db: DbConn; q: string): SqlPrepared</a></li>
- </ul>
- <ul class="simple nested-toc-section">setEncoding
- <li><a class="reference" href="#setEncoding%2CDbConn%2Cstring" title="setEncoding(connection: DbConn; encoding: string): bool">setEncoding(connection: DbConn; encoding: string): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">tryExec
- <li><a class="reference" href="#tryExec%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="tryExec(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): bool">tryExec(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): bool</a></li>
- <li><a class="reference" href="#tryExec%2CDbConn%2CSqlPrepared" title="tryExec(db: DbConn; stmtName: SqlPrepared): bool">tryExec(db: DbConn; stmtName: SqlPrepared): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">tryInsert
- <li><a class="reference" href="#tryInsert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D" title="tryInsert(db: DbConn; query: SqlQuery; pkName: string;
- args: varargs[string, `$`]): int64">tryInsert(db: DbConn; query: SqlQuery; pkName: string;
- args: varargs[string, `$`]): int64</a></li>
- </ul>
- <ul class="simple nested-toc-section">tryInsertID
- <li><a class="reference" href="#tryInsertID%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="tryInsertID(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64">tryInsertID(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): int64</a></li>
- </ul>
- <ul class="simple nested-toc-section">unsafeColumnAt
- <li><a class="reference" href="#unsafeColumnAt%2CInstantRow%2Cint32" title="unsafeColumnAt(row: InstantRow; index: int32): cstring">unsafeColumnAt(row: InstantRow; index: int32): cstring</a></li>
- </ul>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">fastRows
- <li><a class="reference" href="#fastRows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="fastRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row">fastRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row</a></li>
- <li><a class="reference" href="#fastRows.i%2CDbConn%2CSqlPrepared" title="fastRows(db: DbConn; stmtName: SqlPrepared): Row">fastRows(db: DbConn; stmtName: SqlPrepared): Row</a></li>
- </ul>
- <ul class="simple nested-toc-section">instantRows
- <li><a class="reference" href="#instantRows.i%2CDbConn%2CDbColumns%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="instantRows(db: DbConn; columns: var DbColumns; query: SqlQuery;
- args: varargs[string, `$`]): InstantRow">instantRows(db: DbConn; columns: var DbColumns; query: SqlQuery;
- args: varargs[string, `$`]): InstantRow</a></li>
- <li><a class="reference" href="#instantRows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="instantRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): InstantRow">instantRows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): InstantRow</a></li>
- <li><a class="reference" href="#instantRows.i%2CDbConn%2CSqlPrepared" title="instantRows(db: DbConn; stmtName: SqlPrepared): InstantRow">instantRows(db: DbConn; stmtName: SqlPrepared): InstantRow</a></li>
- </ul>
- <ul class="simple nested-toc-section">rows
- <li><a class="reference" href="#rows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D" title="rows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row">rows(db: DbConn; query: SqlQuery; args: varargs[string, `$`]): Row</a></li>
- <li><a class="reference" href="#rows.i%2CDbConn%2CSqlPrepared" title="rows(db: DbConn; stmtName: SqlPrepared): Row">rows(db: DbConn; stmtName: SqlPrepared): Row</a></li>
- </ul>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#17" id="67">Macros</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">bindParams
- <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>
- </ul>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">dbBindParamError
- <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>
- </ul>
- <ul class="simple nested-toc-section">exec
- <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>
- </ul>
- </ul>
- </details>
- </li>
- </ul>
- </div>
- <div class="nine columns" id="content">
-
- <div id="tocRoot"></div>
-
- <p class="module-desc"><div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
- In order to use this module, run <tt class="docutils literal"><span class="pre"><span class="Identifier">nimble</span> <span class="Identifier">install</span> <span class="Identifier">db_connector</span></span></tt>.</div>
- <p>A higher level <span id="sqlite_1">SQLite</span> database wrapper. This interface is implemented for other databases too.</p>
- <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>
- <ol class="simple"><li>Open database connection</li>
- <li>Execute SQL query</li>
- <li>Close database connection</li>
- </ol>
- <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>
- <p><pre class="listing"><span class="RawData">sql"INSERT INTO my_table (colA, colB, colC) VALUES (?, ?, ?)"</span></pre></p>
- <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>
- <span class="Comment"># user, password, database name can be empty.</span>
- <span class="Comment"># These params are not used on db_sqlite module.</span>
- <span class="Keyword">let</span> <span class="Identifier">db</span> <span class="Operator">=</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
- <h2><a class="toc-backref" id="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"DROP TABLE IF EXISTS my_table"</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="LongStringLit">sql"""CREATE TABLE my_table (
- id INTEGER,
- name VARCHAR(50) NOT NULL
- )"""</span><span class="Punctuation">)</span></pre></p>
- <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"INSERT INTO my_table (id, name) VALUES (0, ?)"</span><span class="Punctuation">,</span>
- <span class="StringLit">"Jack"</span><span class="Punctuation">)</span></pre></p>
- <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>
- <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">math</span>
- <span class="Keyword">let</span> <span class="Identifier">db</span> <span class="Operator">=</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql"DROP TABLE IF EXISTS my_table"</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="LongStringLit">sql"""CREATE TABLE my_table (
- id INTEGER PRIMARY KEY,
- name VARCHAR(50) NOT NULL,
- i INT(11),
- f DECIMAL(18, 10)
- )"""</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql"BEGIN"</span><span class="Punctuation">)</span>
- <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>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql"INSERT INTO my_table (name, i, f) VALUES (?, ?, ?)"</span><span class="Punctuation">,</span>
- <span class="StringLit">"Item#"</span> <span class="Operator">&</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>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql"COMMIT"</span><span class="Punctuation">)</span>
- <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"SELECT * FROM my_table"</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="Identifier">x</span>
- <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"""INSERT INTO my_table (name, i, f)
- VALUES (?, ?, ?)"""</span><span class="Punctuation">,</span>
- <span class="StringLit">"Item#1001"</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>
- <span class="Identifier">echo</span> <span class="StringLit">"Inserted item: "</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"SELECT name FROM my_table WHERE id=?"</span><span class="Punctuation">,</span> <span class="Identifier">id</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
- <h2><a class="toc-backref" id="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>
- <span class="Comment">## Generate random float datas</span>
- <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>
- <span class="Identifier">randomize</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <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>
- <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>
- <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">"mysqlite.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Keyword">block</span><span class="Punctuation">:</span> <span class="Comment">## Create database</span>
- <span class="Comment">## Binary datas needs to be of type BLOB in SQLite</span>
- <span class="Keyword">let</span> <span class="Identifier">createTableStr</span> <span class="Operator">=</span> <span class="LongStringLit">sql"""CREATE TABLE test(
- id INTEGER NOT NULL PRIMARY KEY,
- data BLOB
- )
- """</span>
- <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>
- <span class="Keyword">block</span><span class="Punctuation">:</span> <span class="Comment">## Insert data</span>
- <span class="Keyword">var</span> <span class="Identifier">id</span> <span class="Operator">=</span> <span class="DecNumber">1</span>
- <span class="Comment">## Data needs to be converted to seq[byte] to be interpreted as binary by bindParams</span>
- <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>
- <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>
-
- <span class="Comment">## Use prepared statement to insert binary data into database</span>
- <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">"INSERT INTO test (id, data) VALUES (?, ?)"</span><span class="Punctuation">)</span>
- <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>
- <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>
- <span class="Comment">## Check insert</span>
- <span class="Identifier">doAssert</span><span class="Punctuation">(</span><span class="Identifier">bres</span><span class="Punctuation">)</span>
- <span class="Comment"># Destroy statement</span>
- <span class="Identifier">finalize</span><span class="Punctuation">(</span><span class="Identifier">insertStmt</span><span class="Punctuation">)</span>
- <span class="Keyword">block</span><span class="Punctuation">:</span> <span class="Comment">## Use getValue to select data</span>
- <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"SELECT data FROM test WHERE id = ?"</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span>
- <span class="Comment">## Calculate sequence size from buffer size</span>
- <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>
- <span class="Comment">## Copy binary string data in dataTest into a seq</span>
- <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>
- <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>
-
- <span class="Comment">## Check datas obtained is identical</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">res</span> <span class="Operator">==</span> <span class="Identifier">orig</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
- <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>
- <p>The reasoning is as follows:</p>
- <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>
- <li>it hides the number of types that the DB supports (int? int64? decimal up to 10 places? geo coords?)</li>
- <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>
- </ol>
- <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>
- <li><a class="reference external" href="db_mysql.html">db_mysql module</a> for MySQL database wrapper</li>
- <li><a class="reference external" href="db_postgres.html">db_postgres module</a> for PostgreSQL database wrapper</li>
- </ul>
- </p>
- <div class="section" id="6">
- <h1><a class="toc-backref" href="#6">Imports</a></h1>
- <dl class="item">
- <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>
- </dl>
- </div>
- <div class="section" id="7">
- <h1><a class="toc-backref" href="#7">Types</a></h1>
- <dl class="item">
- <div id="DbConn">
- <dt><pre><a href="db_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>
- <dd>
-
- Encapsulates a database connection.
-
- </dd>
- </div>
- <div id="InstantRow">
- <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>
- <dd>
-
- A handle that can be used to get a row's column text on demand.
-
- </dd>
- </div>
- <div id="Row">
- <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>
- <dd>
-
- 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.
-
- </dd>
- </div>
- <div id="SqlPrepared">
- <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>
- <dd>
-
- a identifier for the prepared queries
-
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="12">
- <h1><a class="toc-backref" href="#12">Procs</a></h1>
- <dl class="item">
- <div id="[]-procs-all">
- <div id="[],InstantRow,int32">
- <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>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns text for given column of the row.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#instantRows.i,DbConn,SqlQuery,varargs[string,]">instantRows iterator</a> example code</li>
- </ul>
-
- </dd>
- </div>
- </div>
- <div id="bindNull-procs-all">
- <div id="bindNull,SqlPrepared,int">
- <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>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- <div id="bindParam-procs-all">
- <div id="bindParam,SqlPrepared,int,float64">
- <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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- <div id="bindParam,SqlPrepared,int,int">
- <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>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- <div id="bindParam,SqlPrepared,int,int32">
- <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>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- <div id="bindParam,SqlPrepared,int,int64">
- <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>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- <div id="bindParam,SqlPrepared,int,openArray[byte]">
- <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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- <div id="bindParam,SqlPrepared,int,string">
- <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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- <div id="close-procs-all">
- <div id="close,DbConn">
- <dt><pre><span class="Keyword">proc</span> <a href="#close%2CDbConn"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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>
- <dd>
-
- <p>Closes the database connection.</p>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- </div>
- <div id="dbError-procs-all">
- <div id="dbError,DbConn">
- <dt><pre><span class="Keyword">proc</span> <a href="#dbError%2CDbConn"><span class="Identifier">dbError</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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>
- <dd>
-
- <p>Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">DbError</span></span></tt> exception.</p>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="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"SELECT * FROM not_exist_table"</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">dbError</span><span class="Punctuation">(</span><span class="Identifier">db</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- </div>
- <div id="dbQuote-procs-all">
- <div id="dbQuote,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#dbQuote%2Cstring"><span class="Identifier">dbQuote</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- 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.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">dbQuote</span><span class="Punctuation">(</span><span class="StringLit">"'"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"''''"</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">dbQuote</span><span class="Punctuation">(</span><span class="StringLit">"A Foobar's pen."</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"'A Foobar''s pen.'"</span></pre>
-
- </dd>
- </div>
- </div>
- <div id="exec-procs-all">
- <div id="exec,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#exec%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">exec</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <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>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Keyword">try</span><span class="Punctuation">:</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql"INSERT INTO my_table (id, name) VALUES (?, ?)"</span><span class="Punctuation">,</span>
- <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="StringLit">"item#1"</span><span class="Punctuation">)</span>
- <span class="Keyword">except</span><span class="Punctuation">:</span>
- <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>
- <span class="Keyword">finally</span><span class="Punctuation">:</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- </div>
- <div id="execAffectedRows-procs-all">
- <div id="execAffectedRows,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#execAffectedRows%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">execAffectedRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Executes the query (typically "UPDATE") and returns the number of affected rows.</p>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Comment"># Records of my_table:</span>
- <span class="Comment"># | id | name |</span>
- <span class="Comment"># |----|----------|</span>
- <span class="Comment"># | 1 | item#1 |</span>
- <span class="Comment"># | 2 | item#2 |</span>
- <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"UPDATE my_table SET name = 'TEST'"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- <div id="execAffectedRows,DbConn,SqlPrepared">
- <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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- <div id="finalize-procs-all">
- <div id="finalize,SqlPrepared">
- <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>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- <div id="getAllRows-procs-all">
- <div id="getAllRows,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#getAllRows%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">getAllRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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>
- <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>
- <dd>
-
- <p>Executes the query and returns the whole result dataset.</p>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Comment"># Records of my_table:</span>
- <span class="Comment"># | id | name |</span>
- <span class="Comment"># |----|----------|</span>
- <span class="Comment"># | 1 | item#1 |</span>
- <span class="Comment"># | 2 | item#2 |</span>
- <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"SELECT id, name FROM my_table"</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">"1"</span><span class="Punctuation">,</span> <span class="StringLit">"item#1"</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">"2"</span><span class="Punctuation">,</span> <span class="StringLit">"item#2"</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">]</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- <div id="getAllRows,DbConn,SqlPrepared">
- <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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- <div id="getRow-procs-all">
- <div id="getRow,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#getRow%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">getRow</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <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>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Comment"># Records of my_table:</span>
- <span class="Comment"># | id | name |</span>
- <span class="Comment"># |----|----------|</span>
- <span class="Comment"># | 1 | item#1 |</span>
- <span class="Comment"># | 2 | item#2 |</span>
- <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"SELECT id, name FROM my_table"</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">"1"</span><span class="Punctuation">,</span> <span class="StringLit">"item#1"</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
- <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"SELECT id, name FROM my_table WHERE id = ?"</span><span class="Punctuation">,</span>
- <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">"2"</span><span class="Punctuation">,</span> <span class="StringLit">"item#2"</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
- <span class="Comment"># Returns empty.</span>
- <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"INSERT INTO my_table (id, name) VALUES (?, ?)"</span><span class="Punctuation">,</span>
- <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="StringLit">"item#3"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">]</span>
- <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"DELETE FROM my_table WHERE id = ?"</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>
- <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"UPDATE my_table SET name = 'ITEM#1' WHERE id = ?"</span><span class="Punctuation">,</span>
- <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>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- </div>
- <div id="getValue-procs-all">
- <div id="getValue,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#getValue%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">getValue</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <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">""</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>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Comment"># Records of my_table:</span>
- <span class="Comment"># | id | name |</span>
- <span class="Comment"># |----|----------|</span>
- <span class="Comment"># | 1 | item#1 |</span>
- <span class="Comment"># | 2 | item#2 |</span>
- <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"SELECT name FROM my_table WHERE id = ?"</span><span class="Punctuation">,</span>
- <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"item#2"</span>
- <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"SELECT id, name FROM my_table"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"1"</span>
- <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"SELECT name, id FROM my_table"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"item#1"</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- <div id="getValue,DbConn,SqlPrepared">
- <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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- <div id="insert-procs-all">
- <div id="insert,DbConn,SqlQuery,string,varargs[string,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#insert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">insert</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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>
- <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int64</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- same as insertId
-
- </dd>
- </div>
- </div>
- <div id="insertID-procs-all">
- <div id="insertID,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#insertID%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">insertID</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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> {.
- <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>
- <dd>
-
- <p>Executes the query (typically "INSERT") and returns the generated ID for the row.</p>
- <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>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql"CREATE TABLE my_table (id INTEGER, name VARCHAR(50) NOT NULL)"</span><span class="Punctuation">)</span>
- <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>
- <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"INSERT INTO my_table (id, name) VALUES (?, ?)"</span><span class="Punctuation">,</span> <span class="Identifier">i</span><span class="Punctuation">,</span> <span class="StringLit">"item#"</span> <span class="Operator">&</span> <span class="Operator">$</span><span class="Identifier">i</span><span class="Punctuation">)</span>
- <span class="Identifier">echo</span> <span class="StringLit">"LoopIndex = "</span><span class="Punctuation">,</span> <span class="Identifier">i</span><span class="Punctuation">,</span> <span class="StringLit">", InsertID = "</span><span class="Punctuation">,</span> <span class="Identifier">id</span>
- <span class="Comment"># Output:</span>
- <span class="Comment"># LoopIndex = 0, InsertID = 1</span>
- <span class="Comment"># LoopIndex = 1, InsertID = 2</span>
- <span class="Comment"># LoopIndex = 2, InsertID = 3</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- </div>
- <div id="len-procs-all">
- <div id="len,InstantRow">
- <dt><pre><span class="Keyword">proc</span> <a href="#len%2CInstantRow"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">row</span><span class="Other">:</span> <a href="db_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>
- <dd>
-
- <p>Returns number of columns in a row.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#instantRows.i,DbConn,SqlQuery,varargs[string,]">instantRows iterator</a> example code</li>
- </ul>
-
- </dd>
- </div>
- </div>
- <div id="open-procs-all">
- <div id="open,string,string,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#open%2Cstring%2Cstring%2Cstring%2Cstring"><span class="Identifier">open</span></a><span class="Other">(</span><span class="Identifier">connection</span><span class="Other">,</span> <span class="Identifier">user</span><span class="Other">,</span> <span class="Identifier">password</span><span class="Other">,</span> <span class="Identifier">database</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="db_sqlite.html#DbConn"><span class="Identifier">DbConn</span></a> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#DbEffect"><span class="Identifier">DbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Opens a database connection. Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">DbError</span></span></tt> exception if the connection could not be established.</p>
- <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>
- <p><strong>Examples:</strong></p>
- <p><pre class="listing"><span class="Keyword">try</span><span class="Punctuation">:</span>
- <span class="Keyword">let</span> <span class="Identifier">db</span> <span class="Operator">=</span> <span class="Identifier">open</span><span class="Punctuation">(</span><span class="StringLit">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Comment">## do something...</span>
- <span class="Comment">## db.getAllRows(sql"SELECT * FROM my_table")</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Keyword">except</span><span class="Punctuation">:</span>
- <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>
-
- </dd>
- </div>
- </div>
- <div id="prepare-procs-all">
- <div id="prepare,DbConn,string">
- <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>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">SqlPrepared</span></span></tt> statement.
-
- </dd>
- </div>
- </div>
- <div id="setEncoding-procs-all">
- <div id="setEncoding,DbConn,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#setEncoding%2CDbConn%2Cstring"><span class="Identifier">setEncoding</span></a><span class="Other">(</span><span class="Identifier">connection</span><span class="Other">:</span> <a href="db_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>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>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>
- <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>
-
- </dd>
- </div>
- </div>
- <div id="tryExec-procs-all">
- <div id="tryExec,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#tryExec%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">tryExec</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <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>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="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"SELECT * FROM my_table"</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">dbError</span><span class="Punctuation">(</span><span class="Identifier">db</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- <div id="tryExec,DbConn,SqlPrepared">
- <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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- <div id="tryInsert-procs-all">
- <div id="tryInsert,DbConn,SqlQuery,string,varargs[string,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#tryInsert%2CDbConn%2CSqlQuery%2Cstring%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">tryInsert</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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>
- <span class="Identifier">args</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int64</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><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>
- <dd>
-
- same as tryInsertID
-
- </dd>
- </div>
- </div>
- <div id="tryInsertID-procs-all">
- <div id="tryInsertID,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#tryInsertID%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">tryInsertID</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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> {.
- <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>
- <dd>
-
- <p>Executes the query (typically "INSERT") and returns the generated ID for the row or -1 in case of an error.</p>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">exec</span><span class="Punctuation">(</span><span class="RawData">sql"CREATE TABLE my_table (id INTEGER, name VARCHAR(50) NOT NULL)"</span><span class="Punctuation">)</span>
- <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"INSERT INTO not_exist_table (id, name) VALUES (?, ?)"</span><span class="Punctuation">,</span>
- <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="StringLit">"item#1"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- </div>
- <div id="unsafeColumnAt-procs-all">
- <div id="unsafeColumnAt,InstantRow,int32">
- <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>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns cstring for given column of the row.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#instantRows.i,DbConn,SqlQuery,varargs[string,]">instantRows iterator</a> example code</li>
- </ul>
-
- </dd>
- </div>
- </div>
- </dl>
- </div>
- <div class="section" id="15">
- <h1><a class="toc-backref" href="#15">Iterators</a></h1>
- <dl class="item">
- <div id="fastRows-iterators-all">
- <div id="fastRows.i,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">iterator</span> <a href="#fastRows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">fastRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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> {.
- <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>
- <dd>
-
- <p>Executes the query and iterates over the result dataset.</p>
- <p>This is very fast, but potentially dangerous. Use this iterator only if you require <strong>ALL</strong> the rows.</p>
- <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>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Comment"># Records of my_table:</span>
- <span class="Comment"># | id | name |</span>
- <span class="Comment"># |----|----------|</span>
- <span class="Comment"># | 1 | item#1 |</span>
- <span class="Comment"># | 2 | item#2 |</span>
- <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"SELECT id, name FROM my_table"</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="Identifier">row</span>
- <span class="Comment"># Output:</span>
- <span class="Comment"># @["1", "item#1"]</span>
- <span class="Comment"># @["2", "item#2"]</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- <div id="fastRows.i,DbConn,SqlPrepared">
- <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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- <div id="instantRows-iterators-all">
- <div id="instantRows.i,DbConn,DbColumns,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">iterator</span> <a href="#instantRows.i%2CDbConn%2CDbColumns%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">instantRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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>
- <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> {.
- <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>
- <dd>
-
- <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>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Comment"># Records of my_table:</span>
- <span class="Comment"># | id | name |</span>
- <span class="Comment"># |----|----------|</span>
- <span class="Comment"># | 1 | item#1 |</span>
- <span class="Comment"># | 2 | item#2 |</span>
- <span class="Keyword">var</span> <span class="Identifier">columns</span><span class="Punctuation">:</span> <span class="Identifier">DbColumns</span>
- <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"SELECT * FROM my_table"</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">discard</span>
- <span class="Identifier">echo</span> <span class="Identifier">columns</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span>
- <span class="Comment"># Output:</span>
- <span class="Comment"># (name: "id", tableName: "my_table", typ: (kind: dbNull,</span>
- <span class="Comment"># notNull: false, name: "INTEGER", size: 0, maxReprLen: 0, precision: 0,</span>
- <span class="Comment"># scale: 0, min: 0, max: 0, validValues: @[]), primaryKey: false,</span>
- <span class="Comment"># foreignKey: false)</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- <div id="instantRows.i,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">iterator</span> <a href="#instantRows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">instantRows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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> {.
- <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>
- <dd>
-
- <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>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
-
- <span class="Comment"># Records of my_table:</span>
- <span class="Comment"># | id | name |</span>
- <span class="Comment"># |----|----------|</span>
- <span class="Comment"># | 1 | item#1 |</span>
- <span class="Comment"># | 2 | item#2 |</span>
-
- <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"SELECT * FROM my_table"</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="StringLit">"id:"</span> <span class="Operator">&</span> <span class="Identifier">row</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span>
- <span class="Identifier">echo</span> <span class="StringLit">"name:"</span> <span class="Operator">&</span> <span class="Identifier">row</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span>
- <span class="Identifier">echo</span> <span class="StringLit">"length:"</span> <span class="Operator">&</span> <span class="Operator">$</span><span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">row</span><span class="Punctuation">)</span>
-
- <span class="Comment"># Output:</span>
- <span class="Comment"># id:1</span>
- <span class="Comment"># name:item#1</span>
- <span class="Comment"># length:2</span>
- <span class="Comment"># id:2</span>
- <span class="Comment"># name:item#2</span>
- <span class="Comment"># length:2</span>
-
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- <div id="instantRows.i,DbConn,SqlPrepared">
- <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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- <div id="rows-iterators-all">
- <div id="rows.i,DbConn,SqlQuery,varargs[string,]">
- <dt><pre><span class="Keyword">iterator</span> <a href="#rows.i%2CDbConn%2CSqlQuery%2Cvarargs%5Bstring%2C%5D"><span class="Identifier">rows</span></a><span class="Other">(</span><span class="Identifier">db</span><span class="Other">:</span> <a href="db_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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Similar to <a class="reference external" href="#fastRows.i,DbConn,SqlQuery,varargs[string,]">fastRows iterator</a>, but slower and safe.</p>
- <p><strong>Examples:</strong></p>
- <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">"mytest.db"</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">,</span> <span class="StringLit">""</span><span class="Punctuation">)</span>
- <span class="Comment"># Records of my_table:</span>
- <span class="Comment"># | id | name |</span>
- <span class="Comment"># |----|----------|</span>
- <span class="Comment"># | 1 | item#1 |</span>
- <span class="Comment"># | 2 | item#2 |</span>
- <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"SELECT id, name FROM my_table"</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="Identifier">row</span>
- <span class="Comment">## Output:</span>
- <span class="Comment">## @["1", "item#1"]</span>
- <span class="Comment">## @["2", "item#2"]</span>
- <span class="Identifier">db</span><span class="Operator">.</span><span class="Identifier">close</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre></p>
-
- </dd>
- </div>
- <div id="rows.i,DbConn,SqlPrepared">
- <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> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="db_common.html#ReadDbEffect"><span class="Identifier">ReadDbEffect</span></a><span class="Other">,</span> <a href="db_common.html#WriteDbEffect"><span class="Identifier">WriteDbEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">DbError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- </dl>
- </div>
- <div class="section" id="17">
- <h1><a class="toc-backref" href="#17">Macros</a></h1>
- <dl class="item">
- <div id="bindParams-macros-all">
- <div id="bindParams.m,SqlPrepared,varargs[untyped]">
- <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>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- </dl>
- </div>
- <div class="section" id="18">
- <h1><a class="toc-backref" href="#18">Templates</a></h1>
- <dl class="item">
- <div id="dbBindParamError-templates-all">
- <div id="dbBindParamError.t,int,varargs[untyped]">
- <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>
- <dd>
-
- Raises a <tt class="docutils literal"><span class="pre"><span class="Identifier">DbError</span></span></tt> exception.
-
- </dd>
- </div>
- </div>
- <div id="exec-templates-all">
- <div id="exec.t,DbConn,SqlPrepared,varargs[typed]">
- <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>
- <dd>
-
-
-
- </dd>
- </div>
- </div>
- </dl>
- </div>
- </div>
- </div>
- <div class="twelve-columns footer">
- <span class="nim-sprite"></span>
- <br>
- <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:39 UTC</small>
- </div>
- </div>
- </div>
- <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
-
- </body>
- </html>
|