mirror of
https://github.com/knex/knex.git
synced 2025-12-16 17:48:31 +00:00
56 lines
13 KiB
HTML
56 lines
13 KiB
HTML
<!DOCTYPE html><html lang="en"><head><title>lib/dialects/sqlite3/index</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content="../../../"><meta name="groc-document-path" content="lib/dialects/sqlite3/index"><meta name="groc-project-path" content="lib/dialects/sqlite3/index.js"><link rel="stylesheet" type="text/css" media="all" href="../../../assets/style.css"><script type="text/javascript" src="../../../assets/behavior.js"></script><body><div id="meta"><div class="file-path">lib/dialects/sqlite3/index.js</div></div><div id="document"><div class="segment"><div class="comments "><div class="wrapper"><h2 id="sqlite3">SQLite3</h2></div></div></div><div class="segment"><div class="code"><div class="wrapper"><span class="kd">var</span> <span class="nx">inherits</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'inherits'</span><span class="p">);</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">Client</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'../../client'</span><span class="p">);</span>
|
|
<span class="kd">var</span> <span class="nx">Promise</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'../../promise'</span><span class="p">);</span>
|
|
|
|
<span class="kd">function</span> <span class="nx">Client_SQLite3</span><span class="p">(</span><span class="nx">config</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">Client</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="nx">arguments</span><span class="p">);</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">config</span><span class="p">.</span><span class="nx">debug</span><span class="p">)</span> <span class="k">this</span><span class="p">.</span><span class="nx">isDebugging</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">config</span><span class="p">.</span><span class="nx">connection</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">initDriver</span><span class="p">();</span>
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">initRunner</span><span class="p">();</span>
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">connectionSettings</span> <span class="o">=</span> <span class="nx">config</span><span class="p">.</span><span class="nx">connection</span><span class="p">;</span>
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">initPool</span><span class="p">();</span>
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">pool</span> <span class="o">=</span> <span class="k">new</span> <span class="k">this</span><span class="p">.</span><span class="nx">Pool</span><span class="p">(</span><span class="nx">config</span><span class="p">.</span><span class="nx">pool</span><span class="p">);</span>
|
|
<span class="p">}</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Todo: Plugins here possibly??</p></div></div><div class="code"><div class="wrapper"><span class="p">}</span>
|
|
<span class="nx">inherits</span><span class="p">(</span><span class="nx">Client_SQLite3</span><span class="p">,</span> <span class="nx">Client</span><span class="p">);</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Lazy load the sqlite3 module, since we might just be using
|
|
the client to generate SQL strings.</p></div></div><div class="code"><div class="wrapper"><span class="kd">var</span> <span class="nx">sqlite3</span><span class="p">;</span>
|
|
|
|
<span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">dialect</span> <span class="o">=</span> <span class="s1">'sqlite3'</span><span class="p">,</span>
|
|
|
|
<span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">initTransaction</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="nx">require</span><span class="p">(</span><span class="s1">'./transaction'</span><span class="p">)(</span><span class="k">this</span><span class="p">);</span>
|
|
<span class="p">};</span>
|
|
|
|
<span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">initFormatter</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="nx">require</span><span class="p">(</span><span class="s1">'./formatter'</span><span class="p">)(</span><span class="k">this</span><span class="p">);</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Lazy-load the sqlite3 dependency.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">initDriver</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="nx">sqlite3</span> <span class="o">=</span> <span class="nx">sqlite3</span> <span class="o">||</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'sqlite3'</span><span class="p">);</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Initialize the raw connection on the client.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">initRaw</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="nx">require</span><span class="p">(</span><span class="s1">'./raw'</span><span class="p">)(</span><span class="k">this</span><span class="p">);</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Always initialize with the "Query" and "QueryCompiler"
|
|
objects, each of which is unique to this client (and thus)
|
|
can be altered without messing up anything for anyone else.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">initQuery</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="nx">require</span><span class="p">(</span><span class="s1">'./query'</span><span class="p">)(</span><span class="k">this</span><span class="p">);</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Initializes a new pool instance for the current client.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">initPool</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="nx">require</span><span class="p">(</span><span class="s1">'./pool'</span><span class="p">)(</span><span class="k">this</span><span class="p">);</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Initialize the query "runner"</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">initRunner</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="nx">require</span><span class="p">(</span><span class="s1">'./runner'</span><span class="p">)(</span><span class="k">this</span><span class="p">);</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Lazy-load the schema dependencies.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">initSchema</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="nx">require</span><span class="p">(</span><span class="s1">'./schema'</span><span class="p">)(</span><span class="k">this</span><span class="p">);</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Lazy-load the migration dependency</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">initMigrator</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="nx">require</span><span class="p">(</span><span class="s1">'./migrator'</span><span class="p">)(</span><span class="k">this</span><span class="p">);</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Get a raw connection from the database, returning a promise with the connection object.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">acquireRawConnection</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="kd">var</span> <span class="nx">driver</span> <span class="o">=</span> <span class="k">this</span><span class="p">;</span>
|
|
<span class="k">return</span> <span class="k">new</span> <span class="nx">Promise</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">resolve</span><span class="p">,</span> <span class="nx">reject</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="kd">var</span> <span class="nx">db</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">sqlite3</span><span class="p">.</span><span class="nx">Database</span><span class="p">(</span><span class="nx">driver</span><span class="p">.</span><span class="nx">connectionSettings</span><span class="p">.</span><span class="nx">filename</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="k">return</span> <span class="nx">reject</span><span class="p">(</span><span class="nx">err</span><span class="p">);</span>
|
|
<span class="nx">resolve</span><span class="p">(</span><span class="nx">db</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
<span class="p">});</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Used to explicitly close a connection, called internally by the pool
|
|
when a connection times out or the pool is shutdown.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_SQLite3</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">destroyRawConnection</span> <span class="o">=</span> <span class="nx">Promise</span><span class="p">.</span><span class="nx">method</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">connection</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">connection</span><span class="p">.</span><span class="nx">close</span><span class="p">();</span>
|
|
<span class="p">});</span>
|
|
|
|
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="nx">Client_SQLite3</span><span class="p">;</span></div></div></div></div></body></html> |