Vivek Shukla - SQLite
I am a Software Engineer from India. I am currently building Daestro. I work in Rust, Javascript and Python.
Zola
2025-04-13T00:00:00+00:00
https://vshukla.com/tags/sqlite/atom.xml
Using SQLite Database in Rust with Sqlx
2025-04-13T00:00:00+00:00
2025-04-13T00:00:00+00:00
Vivek Shukla
https://vshukla.com/tech/sqlite-in-rust-with-sqlx/
Guide to use SQLite database in Rust with Sqlx
<p>SQLite is self-contained, file based relational database. If you have a simple use case and want to avoid complex databases then SQLite is one of the best choice.</p>
<p>We will use <a rel="noopener external" target="_blank" href="https://github.com/launchbadge/sqlx"><code>sqlx</code> crate</a> to interact with SQLite database.</p>
<p>Why Sqlx?</p>
<ul>
<li>Async support</li>
<li>Supports migrations</li>
<li>Compile time type safety</li>
<li>Supports SQLite, Postgres and MySQL</li>
</ul>
<h2 id="setup"><a class="zola-anchor" href="#setup" aria-label="Anchor link for: setup">π</a>Setup</h2>
<pre class="giallo z-code"><code data-lang="shellscript"><span class="giallo-l"><span class="z-entity z-name">cargo</span><span class="z-string"> init sqlite-demo</span></span></code></pre><h3 id="cargo-toml"><a class="zola-anchor" href="#cargo-toml" aria-label="Anchor link for: cargo-toml">π</a>Cargo.toml</h3>
<p>Add the following dependencies to your <code>Cargo.toml</code> file. We are using <a rel="noopener external" target="_blank" href="https://github.com/tokio-rs/tokio">tokio runtime</a> and sqlite features of <code>sqlx</code>.</p>
<pre class="giallo z-code"><code data-lang="toml"><span class="giallo-l"><span>[</span><span class="z-entity z-name">package</span><span>]</span></span>
<span class="giallo-l"><span class="z-variable">name</span><span class="z-punctuation z-separator"> =</span><span class="z-string"> "sqlite-demo"</span></span>
<span class="giallo-l"><span class="z-variable">version</span><span class="z-punctuation z-separator"> =</span><span class="z-string"> "0.1.0"</span></span>
<span class="giallo-l"><span class="z-variable">edition</span><span class="z-punctuation z-separator"> =</span><span class="z-string"> "2024"</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span>[</span><span class="z-entity z-name">dependencies</span><span>]</span></span>
<span class="giallo-l"><span class="z-variable">sqlx</span><span class="z-punctuation z-separator"> =</span><span class="z-variable"> { version</span><span class="z-punctuation z-separator"> =</span><span class="z-string"> "0.8"</span><span class="z-punctuation z-separator">,</span><span class="z-variable"> features</span><span class="z-punctuation z-separator"> =</span><span> [</span></span>
<span class="giallo-l"><span class="z-string"> "runtime-tokio"</span><span class="z-punctuation z-separator">,</span></span>
<span class="giallo-l"><span class="z-string"> "sqlite"</span><span class="z-punctuation z-separator">,</span></span>
<span class="giallo-l"><span class="z-string"> "migrate"</span><span class="z-punctuation z-separator">,</span></span>
<span class="giallo-l"><span>] }</span></span>
<span class="giallo-l"><span class="z-variable">tokio</span><span class="z-punctuation z-separator"> =</span><span class="z-variable"> { version</span><span class="z-punctuation z-separator"> =</span><span class="z-string"> "1.44.2"</span><span class="z-punctuation z-separator">,</span><span class="z-variable"> features</span><span class="z-punctuation z-separator"> =</span><span> [</span><span class="z-string">"full"</span><span>] }</span></span></code></pre><h2 id="connect-to-sqlite-database"><a class="zola-anchor" href="#connect-to-sqlite-database" aria-label="Anchor link for: connect-to-sqlite-database">π</a>Connect to SQLite Database</h2>
<p>Here we are using <code>SqliteConnectOptions</code> to connect to SQLite database. We are also creating the database file if it doesnβt exist. We are using <code>SqliteJournalMode::Delete</code> to delete the journal file after commit so that we will only have one file in the database directory.</p>
<p>Since we want file based database, we are using <code>sqlite://main.db</code> as connection string. For memory based database, we can use <code>sqlite::memory:</code> as connection string.</p>
<pre class="giallo z-code"><code data-lang="rust"><span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span>{</span><span class="z-entity z-name">ConnectOptions</span><span>,</span><span class="z-entity z-name"> Connection</span><span>,</span><span class="z-entity z-name"> sqlite</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">SqliteConnectOptions</span><span>};</span></span>
<span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> std</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">str</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">FromStr</span><span>;</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span>#[tokio</span><span class="z-keyword z-operator">::</span><span>main]</span></span>
<span class="giallo-l"><span class="z-keyword">async fn</span><span class="z-entity z-name z-function"> main</span><span>() {</span></span>
<span class="giallo-l"><span class="z-storage"> let mut</span><span class="z-variable"> conn</span><span class="z-keyword z-operator"> =</span><span class="z-entity z-name"> SqliteConnectOptions</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_str</span><span>(</span><span class="z-string">"sqlite://main.db"</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">create_if_missing</span><span>(</span><span class="z-constant z-language">true</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">journal_mode</span><span>(</span><span class="z-entity z-name">sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">sqlite</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">SqliteJournalMode</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">Delete</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">connect</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">expect</span><span>(</span><span class="z-string">"Failed to connect to database"</span><span>);</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-comment"> // Create the users table if it doesn't exist</span></span>
<span class="giallo-l"><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">query</span><span>(</span></span>
<span class="giallo-l"><span class="z-string"> "CREATE TABLE IF NOT EXISTS users (</span></span>
<span class="giallo-l"><span class="z-string"> id INTEGER PRIMARY KEY AUTOINCREMENT,</span></span>
<span class="giallo-l"><span class="z-string"> name TEXT NOT NULL,</span></span>
<span class="giallo-l"><span class="z-string"> age INTEGER</span></span>
<span class="giallo-l"><span class="z-string"> )"</span><span>,</span></span>
<span class="giallo-l"><span> )</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">execute</span><span>(</span><span class="z-keyword z-operator">&</span><span class="z-storage">mut</span><span class="z-variable"> conn)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>();</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-storage"> let</span><span class="z-variable"> _</span><span class="z-keyword z-operator"> =</span><span class="z-variable"> conn</span><span class="z-keyword z-operator">.</span><span class="z-entity z-name z-function">close</span><span>()</span><span class="z-keyword z-operator">.</span><span class="z-keyword">await</span><span>;</span></span>
<span class="giallo-l"><span>}</span></span></code></pre><h2 id="creating-connection-pool"><a class="zola-anchor" href="#creating-connection-pool" aria-label="Anchor link for: creating-connection-pool">π</a>Creating Connection Pool</h2>
<p>We will use <a rel="noopener external" target="_blank" href="https://docs.rs/sqlx/latest/sqlx/sqlite/type.SqlitePoolOptions.html"><code>SqlitePoolOptions</code></a> to create a connection pool.</p>
<p>We will create a helper function <code>db_conn</code> to create a connection pool. This function will return a connection pool that can be used to interact with the database.</p>
<pre class="giallo z-code"><code data-lang="rust"><span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span>{</span></span>
<span class="giallo-l"><span class="z-entity z-name"> Pool</span><span>,</span><span class="z-entity z-name"> Sqlite</span><span>,</span></span>
<span class="giallo-l"><span class="z-entity z-name"> sqlite</span><span class="z-keyword z-operator">::</span><span>{</span><span class="z-entity z-name">SqliteConnectOptions</span><span>,</span><span class="z-entity z-name"> SqlitePoolOptions</span><span>},</span></span>
<span class="giallo-l"><span>};</span></span>
<span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> std</span><span class="z-keyword z-operator">::</span><span>{</span><span class="z-entity z-name">str</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">FromStr</span><span>,</span><span class="z-entity z-name"> time</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">Duration</span><span>};</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span>#[tokio</span><span class="z-keyword z-operator">::</span><span>main]</span></span>
<span class="giallo-l"><span class="z-keyword">async fn</span><span class="z-entity z-name z-function"> main</span><span>() {</span></span>
<span class="giallo-l"><span class="z-storage"> let</span><span class="z-variable"> conn</span><span class="z-keyword z-operator"> =</span><span class="z-entity z-name z-function"> db_conn</span><span>()</span><span class="z-keyword z-operator">.</span><span class="z-keyword">await</span><span>;</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-comment"> // Create the users table if it doesn't exist</span></span>
<span class="giallo-l"><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">query</span><span>(</span></span>
<span class="giallo-l"><span class="z-string"> "CREATE TABLE IF NOT EXISTS users (</span></span>
<span class="giallo-l"><span class="z-string"> id INTEGER PRIMARY KEY AUTOINCREMENT,</span></span>
<span class="giallo-l"><span class="z-string"> name TEXT NOT NULL,</span></span>
<span class="giallo-l"><span class="z-string"> age INTEGER</span></span>
<span class="giallo-l"><span class="z-string"> )"</span><span>,</span></span>
<span class="giallo-l"><span> )</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">execute</span><span>(</span><span class="z-keyword z-operator">&</span><span class="z-variable">conn)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>();</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-storage"> let</span><span class="z-variable"> _</span><span class="z-keyword z-operator"> =</span><span class="z-variable"> conn</span><span class="z-keyword z-operator">.</span><span class="z-entity z-name z-function">close</span><span>()</span><span class="z-keyword z-operator">.</span><span class="z-keyword">await</span><span>;</span></span>
<span class="giallo-l"><span>}</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-keyword">async fn</span><span class="z-entity z-name z-function"> db_conn</span><span>()</span><span class="z-keyword z-operator"> -></span><span class="z-entity z-name"> Pool</span><span><</span><span class="z-entity z-name">Sqlite</span><span>> {</span></span>
<span class="giallo-l"><span class="z-storage"> let</span><span class="z-variable"> db_url</span><span class="z-keyword z-operator"> =</span><span class="z-string"> "sqlite://main.db"</span><span>;</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-entity z-name"> SqlitePoolOptions</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">new</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">max_connections</span><span>(</span><span class="z-constant z-numeric">20</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">idle_timeout</span><span>(</span><span class="z-entity z-name">Duration</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_secs</span><span>(</span><span class="z-constant z-numeric">60</span><span>))</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">acquire_timeout</span><span>(</span><span class="z-entity z-name">Duration</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_secs</span><span>(</span><span class="z-constant z-numeric">5</span><span>))</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">connect_with</span><span>(</span></span>
<span class="giallo-l"><span class="z-entity z-name"> SqliteConnectOptions</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_str</span><span class="z-variable">(db_url)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">create_if_missing</span><span>(</span><span class="z-constant z-language">true</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">journal_mode</span><span>(</span><span class="z-entity z-name">sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">sqlite</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">SqliteJournalMode</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">Delete</span><span>),</span></span>
<span class="giallo-l"><span> )</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>()</span></span>
<span class="giallo-l"><span>}</span></span></code></pre><h2 id="using-oncecell-to-create-a-connection-pool"><a class="zola-anchor" href="#using-oncecell-to-create-a-connection-pool" aria-label="Anchor link for: using-oncecell-to-create-a-connection-pool">π</a>Using OnceCell to create a connection pool</h2>
<p>We can use <a rel="noopener external" target="_blank" href="https://docs.rs/tokio/latest/tokio/sync/struct.OnceCell.html"><code>OnceCell</code></a> to create a connection pool. This will ensure that the connection pool is created only once and can be shared across multiple threads. So that we wonβt to pass connection pool to every function, we can just use this helper function to get the connection pool and it will re-use the same one.</p>
<pre class="giallo z-code"><code data-lang="rust"><span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span>{</span></span>
<span class="giallo-l"><span class="z-entity z-name"> Pool</span><span>,</span><span class="z-entity z-name"> Sqlite</span><span>,</span></span>
<span class="giallo-l"><span class="z-entity z-name"> sqlite</span><span class="z-keyword z-operator">::</span><span>{</span><span class="z-entity z-name">SqliteConnectOptions</span><span>,</span><span class="z-entity z-name"> SqlitePoolOptions</span><span>},</span></span>
<span class="giallo-l"><span>};</span></span>
<span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> std</span><span class="z-keyword z-operator">::</span><span>{</span><span class="z-entity z-name">str</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">FromStr</span><span>,</span><span class="z-entity z-name"> time</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">Duration</span><span>};</span></span>
<span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> tokio</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">sync</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">OnceCell</span><span>;</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-storage">static</span><span class="z-constant z-other"> DB_CONN</span><span class="z-keyword z-operator">:</span><span class="z-entity z-name"> OnceCell</span><span><</span><span class="z-entity z-name">Pool</span><span><</span><span class="z-entity z-name">Sqlite</span><span>>></span><span class="z-keyword z-operator"> =</span><span class="z-entity z-name"> OnceCell</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">const_new</span><span>();</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-keyword">async fn</span><span class="z-entity z-name z-function"> db_conn</span><span>()</span><span class="z-keyword z-operator"> -></span><span class="z-entity z-name"> Pool</span><span><</span><span class="z-entity z-name">Sqlite</span><span>> {</span></span>
<span class="giallo-l"><span class="z-storage"> let</span><span class="z-variable"> db_url</span><span class="z-keyword z-operator"> =</span><span class="z-string"> "sqlite://main.db"</span><span>;</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-constant z-other"> DB_CONN</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">get_or_init</span><span>(</span><span class="z-keyword z-operator">||</span><span class="z-keyword"> async</span><span> {</span></span>
<span class="giallo-l"><span class="z-entity z-name"> SqlitePoolOptions</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">new</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">max_connections</span><span>(</span><span class="z-constant z-numeric">20</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">idle_timeout</span><span>(</span><span class="z-entity z-name">Duration</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_secs</span><span>(</span><span class="z-constant z-numeric">60</span><span>))</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">acquire_timeout</span><span>(</span><span class="z-entity z-name">Duration</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_secs</span><span>(</span><span class="z-constant z-numeric">5</span><span>))</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">connect_with</span><span>(</span></span>
<span class="giallo-l"><span class="z-entity z-name"> SqliteConnectOptions</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_str</span><span class="z-variable">(db_url)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">create_if_missing</span><span>(</span><span class="z-constant z-language">true</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">journal_mode</span><span>(</span><span class="z-entity z-name">sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">sqlite</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">SqliteJournalMode</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">Delete</span><span>),</span></span>
<span class="giallo-l"><span> )</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>()</span></span>
<span class="giallo-l"><span> })</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">clone</span><span>()</span></span>
<span class="giallo-l"><span>}</span></span></code></pre><h2 id="handling-database-migrations"><a class="zola-anchor" href="#handling-database-migrations" aria-label="Anchor link for: handling-database-migrations">π</a>Handling Database Migrations</h2>
<p>We will use <a rel="noopener external" target="_blank" href="https://github.com/launchbadge/sqlx/blob/main/sqlx-cli/README.md"><code>sqlx-cli</code></a> to handle migrations.</p>
<pre class="giallo z-code"><code data-lang="shellscript"><span class="giallo-l"><span class="z-entity z-name">cargo</span><span class="z-string"> install sqlx-cli</span></span></code></pre>
<p>Create migration file for users table.</p>
<pre class="giallo z-code"><code data-lang="shellscript"><span class="giallo-l"><span class="z-entity z-name">sqlx</span><span class="z-string"> migrate add users</span></span></code></pre>
<p>This will create a migration file in <code>migrations</code> directory with empty migration file for users table. Add the following content to the newly created migration file.</p>
<pre class="giallo z-code"><code data-lang="sql"><span class="giallo-l"><span class="z-comment">-- Add migration script here</span></span>
<span class="giallo-l"><span class="z-keyword">CREATE TABLE</span><span class="z-entity z-name z-function"> IF</span><span class="z-keyword"> NOT EXISTS</span><span> users (</span></span>
<span class="giallo-l"><span> id </span><span class="z-storage">INTEGER PRIMARY KEY</span><span> AUTOINCREMENT,</span></span>
<span class="giallo-l"><span class="z-keyword z-storage"> name TEXT NOT NULL</span><span>,</span></span>
<span class="giallo-l"><span> age </span><span class="z-storage">INTEGER</span></span>
<span class="giallo-l"><span>);</span></span></code></pre>
<p>Embed the migration file in the executable.</p>
<pre class="giallo z-code"><code data-lang="rust"><span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span>{</span></span>
<span class="giallo-l"><span class="z-entity z-name"> Pool</span><span>,</span><span class="z-entity z-name"> Sqlite</span><span>,</span></span>
<span class="giallo-l"><span class="z-entity z-name"> sqlite</span><span class="z-keyword z-operator">::</span><span>{</span><span class="z-entity z-name">SqliteConnectOptions</span><span>,</span><span class="z-entity z-name"> SqlitePoolOptions</span><span>},</span></span>
<span class="giallo-l"><span>};</span></span>
<span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> std</span><span class="z-keyword z-operator">::</span><span>{</span><span class="z-entity z-name">str</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">FromStr</span><span>,</span><span class="z-entity z-name"> time</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">Duration</span><span>};</span></span>
<span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> tokio</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">sync</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">OnceCell</span><span>;</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span>#[tokio</span><span class="z-keyword z-operator">::</span><span>main]</span></span>
<span class="giallo-l"><span class="z-keyword">async fn</span><span class="z-entity z-name z-function"> main</span><span>() {</span></span>
<span class="giallo-l"><span class="z-comment"> // this will make sure migrations are added to the executable</span></span>
<span class="giallo-l"><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">migrate!</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">run</span><span>(</span><span class="z-keyword z-operator">&</span><span class="z-entity z-name z-function">db_conn</span><span>()</span><span class="z-keyword z-operator">.</span><span class="z-keyword">await</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">expect</span><span>(</span><span class="z-string">"Migrations went wrong :("</span><span>);</span></span>
<span class="giallo-l"><span>}</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-storage">static</span><span class="z-constant z-other"> DB_CONN</span><span class="z-keyword z-operator">:</span><span class="z-entity z-name"> OnceCell</span><span><</span><span class="z-entity z-name">Pool</span><span><</span><span class="z-entity z-name">Sqlite</span><span>>></span><span class="z-keyword z-operator"> =</span><span class="z-entity z-name"> OnceCell</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">const_new</span><span>();</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-keyword">async fn</span><span class="z-entity z-name z-function"> db_conn</span><span>()</span><span class="z-keyword z-operator"> -></span><span class="z-entity z-name"> Pool</span><span><</span><span class="z-entity z-name">Sqlite</span><span>> {</span></span>
<span class="giallo-l"><span class="z-storage"> let</span><span class="z-variable"> db_url</span><span class="z-keyword z-operator"> =</span><span class="z-string"> "sqlite://main.db"</span><span>;</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-constant z-other"> DB_CONN</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">get_or_init</span><span>(</span><span class="z-keyword z-operator">||</span><span class="z-keyword"> async</span><span> {</span></span>
<span class="giallo-l"><span class="z-entity z-name"> SqlitePoolOptions</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">new</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">max_connections</span><span>(</span><span class="z-constant z-numeric">20</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">idle_timeout</span><span>(</span><span class="z-entity z-name">Duration</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_secs</span><span>(</span><span class="z-constant z-numeric">60</span><span>))</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">acquire_timeout</span><span>(</span><span class="z-entity z-name">Duration</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_secs</span><span>(</span><span class="z-constant z-numeric">5</span><span>))</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">connect_with</span><span>(</span></span>
<span class="giallo-l"><span class="z-entity z-name"> SqliteConnectOptions</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_str</span><span class="z-variable">(db_url)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">create_if_missing</span><span>(</span><span class="z-constant z-language">true</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">journal_mode</span><span>(</span><span class="z-entity z-name">sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">sqlite</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">SqliteJournalMode</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">Delete</span><span>),</span></span>
<span class="giallo-l"><span> )</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>()</span></span>
<span class="giallo-l"><span> })</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">clone</span><span>()</span></span>
<span class="giallo-l"><span>}</span></span></code></pre><h2 id="full-code-with-example-queries"><a class="zola-anchor" href="#full-code-with-example-queries" aria-label="Anchor link for: full-code-with-example-queries">π</a>Full Code with Example Queries</h2>
<p><strong>main.rs</strong></p>
<pre class="giallo z-code"><code data-lang="rust"><span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span>{</span></span>
<span class="giallo-l"><span class="z-entity z-name"> Pool</span><span>,</span><span class="z-entity z-name"> Row</span><span>,</span><span class="z-entity z-name"> Sqlite</span><span>,</span></span>
<span class="giallo-l"><span class="z-entity z-name"> prelude</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">FromRow</span><span>,</span></span>
<span class="giallo-l"><span class="z-entity z-name"> sqlite</span><span class="z-keyword z-operator">::</span><span>{</span><span class="z-entity z-name">SqliteConnectOptions</span><span>,</span><span class="z-entity z-name"> SqlitePoolOptions</span><span>},</span></span>
<span class="giallo-l"><span>};</span></span>
<span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> std</span><span class="z-keyword z-operator">::</span><span>{</span><span class="z-entity z-name">str</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">FromStr</span><span>,</span><span class="z-entity z-name"> time</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">Duration</span><span>};</span></span>
<span class="giallo-l"><span class="z-keyword">use</span><span class="z-entity z-name"> tokio</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">sync</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">OnceCell</span><span>;</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span>#[tokio</span><span class="z-keyword z-operator">::</span><span>main]</span></span>
<span class="giallo-l"><span class="z-keyword">async fn</span><span class="z-entity z-name z-function"> main</span><span>() {</span></span>
<span class="giallo-l"><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">migrate!</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">run</span><span>(</span><span class="z-keyword z-operator">&</span><span class="z-entity z-name z-function">db_conn</span><span>()</span><span class="z-keyword z-operator">.</span><span class="z-keyword">await</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">expect</span><span>(</span><span class="z-string">"β Migrations went wrong :("</span><span>);</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">query</span><span>(</span><span class="z-string">"INSERT INTO users (name, age) VALUES (?, ?)"</span><span>)</span><span class="z-comment"> // Use ? for placeholders</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">bind</span><span>(</span><span class="z-string">"Alice"</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">bind</span><span>(</span><span class="z-constant z-numeric">30</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">execute</span><span>(</span><span class="z-keyword z-operator">&</span><span class="z-entity z-name z-function">db_conn</span><span>()</span><span class="z-keyword z-operator">.</span><span class="z-keyword">await</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>();</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-storage"> let</span><span class="z-variable"> query</span><span class="z-keyword z-operator"> =</span><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">query</span><span>(</span><span class="z-string">"SELECT count(*) AS count FROM users"</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">fetch_one</span><span>(</span><span class="z-keyword z-operator">&</span><span class="z-entity z-name z-function">db_conn</span><span>()</span><span class="z-keyword z-operator">.</span><span class="z-keyword">await</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>();</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-entity z-name z-function"> println!</span><span>(</span><span class="z-string">"Count: {:?}"</span><span class="z-variable">, query</span><span class="z-keyword z-operator">.</span><span class="z-entity z-name z-function">get</span><span class="z-keyword z-operator">::</span><span><</span><span class="z-entity z-name">i64</span><span>,</span><span class="z-keyword z-operator"> &</span><span class="z-entity z-name">str</span><span>>(</span><span class="z-string">"count"</span><span>));</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-storage"> let</span><span class="z-variable"> users</span><span class="z-keyword z-operator"> =</span><span class="z-entity z-name"> sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">query_as</span><span class="z-keyword z-operator">::</span><span class="z-variable"><_,</span><span class="z-entity z-name"> User</span><span>>(</span><span class="z-string">"SELECT id, name, age FROM users"</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">fetch_all</span><span>(</span><span class="z-keyword z-operator">&</span><span class="z-entity z-name z-function">db_conn</span><span>()</span><span class="z-keyword z-operator">.</span><span class="z-keyword">await</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>();</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-keyword"> for</span><span class="z-variable"> user</span><span class="z-keyword"> in</span><span class="z-variable"> users {</span></span>
<span class="giallo-l"><span class="z-entity z-name z-function"> println!</span><span>(</span><span class="z-string">"Found user: {:?}"</span><span class="z-variable">, user);</span></span>
<span class="giallo-l"><span> }</span></span>
<span class="giallo-l"><span>}</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-storage">static</span><span class="z-constant z-other"> DB_CONN</span><span class="z-keyword z-operator">:</span><span class="z-entity z-name"> OnceCell</span><span><</span><span class="z-entity z-name">Pool</span><span><</span><span class="z-entity z-name">Sqlite</span><span>>></span><span class="z-keyword z-operator"> =</span><span class="z-entity z-name"> OnceCell</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">const_new</span><span>();</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-keyword">async fn</span><span class="z-entity z-name z-function"> db_conn</span><span>()</span><span class="z-keyword z-operator"> -></span><span class="z-entity z-name"> Pool</span><span><</span><span class="z-entity z-name">Sqlite</span><span>> {</span></span>
<span class="giallo-l"><span class="z-storage"> let</span><span class="z-variable"> db_url</span><span class="z-keyword z-operator"> =</span><span class="z-string"> "sqlite://main.db"</span><span>;</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span class="z-constant z-other"> DB_CONN</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">get_or_init</span><span>(</span><span class="z-keyword z-operator">||</span><span class="z-keyword"> async</span><span> {</span></span>
<span class="giallo-l"><span class="z-entity z-name"> SqlitePoolOptions</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">new</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">max_connections</span><span>(</span><span class="z-constant z-numeric">20</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">idle_timeout</span><span>(</span><span class="z-entity z-name">Duration</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_secs</span><span>(</span><span class="z-constant z-numeric">60</span><span>))</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">acquire_timeout</span><span>(</span><span class="z-entity z-name">Duration</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_secs</span><span>(</span><span class="z-constant z-numeric">5</span><span>))</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">connect_with</span><span>(</span></span>
<span class="giallo-l"><span class="z-entity z-name"> SqliteConnectOptions</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name z-function">from_str</span><span class="z-variable">(db_url)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>()</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">create_if_missing</span><span>(</span><span class="z-constant z-language">true</span><span>)</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">journal_mode</span><span>(</span><span class="z-entity z-name">sqlx</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">sqlite</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">SqliteJournalMode</span><span class="z-keyword z-operator">::</span><span class="z-entity z-name">Delete</span><span>),</span></span>
<span class="giallo-l"><span> )</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">unwrap</span><span>()</span></span>
<span class="giallo-l"><span> })</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-keyword">await</span></span>
<span class="giallo-l"><span class="z-keyword z-operator"> .</span><span class="z-entity z-name z-function">clone</span><span>()</span></span>
<span class="giallo-l"><span>}</span></span>
<span class="giallo-l"></span>
<span class="giallo-l"><span>#[derive(</span><span class="z-entity z-name">Debug</span><span>,</span><span class="z-entity z-name"> FromRow</span><span>)]</span></span>
<span class="giallo-l"><span class="z-storage">struct</span><span class="z-entity z-name"> User</span><span> {</span></span>
<span class="giallo-l"><span class="z-variable"> id</span><span class="z-keyword z-operator">:</span><span class="z-entity z-name"> i64</span><span>,</span></span>
<span class="giallo-l"><span class="z-variable"> name</span><span class="z-keyword z-operator">:</span><span class="z-entity z-name"> String</span><span>,</span></span>
<span class="giallo-l"><span class="z-variable"> age</span><span class="z-keyword z-operator">:</span><span class="z-entity z-name"> Option</span><span><</span><span class="z-entity z-name">i32</span><span>>,</span></span>
<span class="giallo-l"><span>}</span></span></code></pre>