<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `database/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../database/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../database/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../database/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
</pre><pre class="rust"><code><span class="comment">// FIXME: We have a shim in dim/utils but we cant depend on dim because itd be a circular dep.
</span><span class="attribute">#![feature(result_option_inspect)]
</span><span class="kw">use </span><span class="kw">crate</span>::utils::ffpath;
<span class="kw">use </span>std::str::FromStr;
<span class="kw">use </span>std::sync::atomic::AtomicBool;
<span class="kw">use </span>std::sync::atomic::Ordering;
<span class="kw">use </span>sqlx::ConnectOptions;
<span class="kw">use </span>tracing::{info, instrument};
<span class="kw">use </span>once_cell::sync::OnceCell;
<span class="kw">pub mod </span>asset;
<span class="kw">pub mod </span>compact_mediafile;
<span class="kw">pub mod </span>episode;
<span class="kw">pub mod </span>error;
<span class="kw">pub mod </span>genre;
<span class="kw">pub mod </span>library;
<span class="kw">pub mod </span>media;
<span class="kw">pub mod </span>mediafile;
<span class="kw">pub mod </span>movie;
<span class="kw">pub mod </span>progress;
<span class="kw">pub mod </span>query_ext;
<span class="attribute">#[cfg(feature = <span class="string">"sqlite"</span>)]
</span><span class="kw">pub mod </span>rw_pool;
<span class="kw">pub mod </span>season;
<span class="attribute">#[cfg(test)]
</span><span class="kw">pub mod </span>tests;
<span class="kw">pub mod </span>tv;
<span class="kw">pub mod </span>user;
<span class="kw">pub mod </span>utils;
<span class="kw">pub use </span><span class="kw">crate</span>::error::DatabaseError;
<span class="doccomment">/// Ugly hack because of a shitty deadlock in `Pool`
</span><span class="kw">pub use </span><span class="kw">crate</span>::rw_pool::write_tx;
<span class="kw">pub use </span>auth::generate_key;
<span class="kw">pub use </span>auth::set_key;
<span class="kw">pub type </span>DbConnection = rw_pool::SqlitePool;
<span class="kw">pub type </span>Transaction<<span class="lifetime">'tx</span>> = sqlx::Transaction<<span class="lifetime">'tx</span>, sqlx::Sqlite>;
<span class="macro">lazy_static::lazy_static! </span>{
<span class="kw">static </span><span class="kw-2">ref </span>MIGRATIONS_FLAG: AtomicBool = AtomicBool::new(<span class="bool-val">false</span>);
}
<span class="kw">static </span>__GLOBAL: OnceCell<DbConnection> = OnceCell::new();
<span class="kw">const </span>MIGRATOR: sqlx::migrate::Migrator = <span class="macro">sqlx::migrate!</span>(<span class="string">"./migrations/"</span>);
<span class="doccomment">/// Function runs all migrations embedded to make sure the database works as expected.
///
/// # Arguments
/// * `conn` - diesel connection
</span><span class="kw">async fn </span>run_migrations(conn: <span class="kw-2">&</span><span class="kw">crate</span>::DbConnection) -> <span class="prelude-ty">Result</span><(), sqlx::migrate::MigrateError> {
<span class="kw">let </span><span class="kw-2">mut </span>lock = conn.writer().lock_owned().<span class="kw">await</span>;
MIGRATOR.run(<span class="kw-2">&mut *</span>lock).<span class="kw">await
</span>}
<span class="doccomment">/// Function which returns a Result<T, E> where T is a new connection session or E is a connection
/// error.
</span><span class="kw">pub async fn </span>get_conn() -> sqlx::Result<<span class="kw">crate</span>::DbConnection> {
<span class="kw">let </span>conn = <span class="kw">if let </span><span class="prelude-val">Some</span>(conn) = __GLOBAL.get() {
conn
} <span class="kw">else </span>{
<span class="kw">let </span>conn = internal_get_conn().<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let _ </span>= __GLOBAL.set(conn);
__GLOBAL.get().unwrap()
};
<span class="kw">if </span>!MIGRATIONS_FLAG.load(Ordering::SeqCst) {
<span class="kw">if let </span><span class="prelude-val">Err</span>(err) = run_migrations(conn).<span class="kw">await </span>{
<span class="macro">panic!</span>(
<span class="string">"Failed to run migrations (maybe you need to delete the old database?): {:?}"</span>,
err
);
} <span class="kw">else </span>{
MIGRATIONS_FLAG.store(<span class="bool-val">true</span>, Ordering::SeqCst);
}
}
<span class="prelude-val">Ok</span>(conn.clone())
}
<span class="attribute">#[doc(hidden)]
</span><span class="kw">pub fn </span>set_conn(conn: <span class="kw">crate</span>::DbConnection) {
__GLOBAL.set(conn).unwrap();
}
<span class="kw">pub fn </span>try_get_conn() -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'static </span><span class="kw">crate</span>::DbConnection> {
__GLOBAL.get()
}
<span class="attribute">#[cfg(feature = <span class="string">"sqlite"</span>)]
</span><span class="kw">pub async fn </span>get_conn_memory() -> sqlx::Result<<span class="kw">crate</span>::DbConnection> {
<span class="kw">let </span>pool = sqlx::Pool::connect(<span class="string">":memory:"</span>).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>connection: sqlx::pool::PoolConnection<sqlx::Sqlite> = pool.acquire().<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>rw = connection.detach();
<span class="kw">let </span>pool = rw_pool::SqlitePool::new(rw, pool);
<span class="kw">let _ </span>= run_migrations(<span class="kw-2">&</span>pool).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(pool)
}
<span class="doccomment">/// Function returns a connection to the development table of dim. This is mainly used for unit
/// tests.
</span><span class="attribute">#[doc(hidden)]
</span><span class="kw">pub async fn </span>get_conn_devel() -> sqlx::Result<<span class="kw">crate</span>::DbConnection> {
<span class="kw">let </span>rw_only = sqlx::sqlite::SqliteConnectOptions::new()
.create_if_missing(<span class="bool-val">true</span>)
.filename(<span class="string">"./dim_dev.db"</span>)
.connect()
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>rd_only = sqlx::pool::PoolOptions::new()
.connect_with(
sqlx::sqlite::SqliteConnectOptions::new()
.read_only(<span class="bool-val">true</span>)
.create_if_missing(<span class="bool-val">true</span>)
.filename(<span class="string">"./dim_dev.db"</span>),
)
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>pool = rw_pool::SqlitePool::new(rw_only, rd_only);
<span class="kw">if </span>!MIGRATIONS_FLAG.load(Ordering::SeqCst) && run_migrations(<span class="kw-2">&</span>pool).<span class="kw">await</span>.is_ok() {
MIGRATIONS_FLAG.store(<span class="bool-val">true</span>, Ordering::SeqCst);
}
<span class="prelude-val">Ok</span>(pool)
}
<span class="doccomment">/// Function which returns a Result<T, E> where T is a new connection session or E is a connection
/// error. It takes in a logger instance.
///
/// # Arguments
/// * `log` - a Slog logger instance
</span><span class="attribute">#[instrument]
</span><span class="kw">pub async fn </span>get_conn_logged() -> sqlx::Result<DbConnection> {
<span class="comment">// This is the URL for the database inside a docker container
</span><span class="kw">let </span>conn = <span class="kw">if let </span><span class="prelude-val">Some</span>(conn) = __GLOBAL.get() {
conn
} <span class="kw">else </span>{
<span class="kw">let </span>conn = internal_get_conn().<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let _ </span>= __GLOBAL.set(conn);
__GLOBAL.get().unwrap()
};
<span class="macro">info!</span>(<span class="string">"Creating new database connection"</span>);
<span class="kw">if </span>!MIGRATIONS_FLAG.load(Ordering::SeqCst) && <span class="macro">dbg!</span>(run_migrations(<span class="kw-2">&</span>conn).<span class="kw">await</span>).is_ok() {
MIGRATIONS_FLAG.store(<span class="bool-val">true</span>, Ordering::SeqCst);
}
<span class="prelude-val">Ok</span>(conn.clone())
}
<span class="kw">async fn </span>internal_get_conn() -> sqlx::Result<DbConnection> {
<span class="kw">let </span>rw_only = sqlx::sqlite::SqliteConnectOptions::new()
.create_if_missing(<span class="bool-val">true</span>)
.filename(ffpath(<span class="string">"config/dim.db"</span>))
.connect()
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>rd_only = sqlx::pool::PoolOptions::new()
.connect_with(
sqlx::sqlite::SqliteConnectOptions::from_str(ffpath(<span class="string">"config/dim.db"</span>))<span class="question-mark">?
</span>.read_only(<span class="bool-val">true</span>)
.synchronous(sqlx::sqlite::SqliteSynchronous::Normal)
.create_if_missing(<span class="bool-val">true</span>),
)
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(rw_pool::SqlitePool::new(rw_only, rd_only))
}
<span class="attribute">#[doc(hidden)]
</span><span class="kw">pub async fn </span>get_conn_file(file: <span class="kw-2">&</span>str) -> sqlx::Result<<span class="kw">crate</span>::DbConnection> {
<span class="kw">let </span>rw_only = sqlx::sqlite::SqliteConnectOptions::new()
.create_if_missing(<span class="bool-val">true</span>)
.filename(file)
.connect()
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>rd_only = sqlx::pool::PoolOptions::new()
.connect_with(
sqlx::sqlite::SqliteConnectOptions::from_str(file)<span class="question-mark">?
</span>.read_only(<span class="bool-val">true</span>)
.synchronous(sqlx::sqlite::SqliteSynchronous::Normal)
.create_if_missing(<span class="bool-val">true</span>),
)
.<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>pool = rw_pool::SqlitePool::new(rw_only, rd_only);
run_migrations(<span class="kw-2">&</span>pool)
.<span class="kw">await
</span>.expect(<span class="string">"Failed to run migrations"</span>);
<span class="prelude-val">Ok</span>(pool)
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="database" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (e7119a030 2022-09-22)" ></div></body></html>