mirror of
https://github.com/knex/knex.git
synced 2025-12-16 09:38:25 +00:00
61 lines
15 KiB
HTML
61 lines
15 KiB
HTML
<!DOCTYPE html><html lang="en"><head><title>lib/dialects/mysql/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/mysql/index"><meta name="groc-project-path" content="lib/dialects/mysql/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/mysql/index.js</div></div><div id="document"><div class="segment"><div class="comments "><div class="wrapper"><h2 id="mysql-client">MySQL Client</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">_</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'lodash'</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">var</span> <span class="nx">mysql</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Always initialize with the "QueryBuilder" and "QueryCompiler"
|
|
objects, which extend the base 'lib/query/builder' and
|
|
'lib/query/compiler', respectively.</p></div></div><div class="code"><div class="wrapper"><span class="kd">function</span> <span class="nx">Client_MySQL</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>
|
|
<span class="p">}</span>
|
|
<span class="nx">inherits</span><span class="p">(</span><span class="nx">Client_MySQL</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>The "dialect", for reference elsewhere.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_MySQL</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">'mysql'</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Lazy-load the mysql dependency, since we might just be
|
|
using the client to generate SQL strings.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_MySQL</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">mysql</span> <span class="o">=</span> <span class="nx">mysql</span> <span class="o">||</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'mysql'</span><span class="p">);</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Attach a <code>Formatter</code> constructor to the client object.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_MySQL</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>Attaches the <code>Raw</code> constructor to the client object.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_MySQL</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>Attaches the <code>Transaction</code> constructor to the client object.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_MySQL</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></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Attaches <code>QueryBuilder</code> and <code>QueryCompiler</code> constructors
|
|
to the client object.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_MySQL</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_MySQL</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_MySQL</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; we may not need to use them.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_MySQL</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_MySQL</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, called by the <code>pool</code> whenever a new
|
|
connection needs to be added to the pool.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_MySQL</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">connection</span><span class="p">;</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">connectionSettings</span><span class="p">.</span><span class="nx">charset</span> <span class="o">===</span> <span class="s1">'utf8'</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">connection</span> <span class="o">=</span> <span class="nx">mysql</span><span class="p">.</span><span class="nx">createConnection</span><span class="p">(</span><span class="nx">_</span><span class="p">.</span><span class="nx">omit</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">connectionSettings</span><span class="p">,</span> <span class="s1">'charset'</span><span class="p">));</span>
|
|
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
|
|
<span class="nx">connection</span> <span class="o">=</span> <span class="nx">mysql</span><span class="p">.</span><span class="nx">createConnection</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">connectionSettings</span><span class="p">);</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">resolver</span><span class="p">,</span> <span class="nx">rejecter</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">connection</span><span class="p">.</span><span class="nx">connect</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">rejecter</span><span class="p">(</span><span class="nx">err</span><span class="p">);</span>
|
|
<span class="nx">resolver</span><span class="p">(</span><span class="nx">connection</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_MySQL</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="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">end</span><span class="p">();</span>
|
|
<span class="p">};</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Return the database for the MySQL client.</p></div></div><div class="code"><div class="wrapper"><span class="nx">Client_MySQL</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">database</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">connectionSettings</span><span class="p">.</span><span class="nx">database</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_MySQL</span><span class="p">;</span></div></div></div></div></body></html> |