mirror of
https://github.com/knex/knex.git
synced 2025-08-03 06:12:10 +00:00
25 lines
6.6 KiB
HTML
25 lines
6.6 KiB
HTML
<!DOCTYPE html><html lang="en"><head><title>clients/base</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="clients/base"><meta name="groc-project-path" content="clients/base.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">clients/base.js</div></div><div id="document"><div class="segment"><div class="comments"><div class="wrapper"><h2 id="clientbase">ClientBase</h2></div></div></div><div class="segment"><div class="code"><div class="wrapper"><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">define</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="s2">"use strict"</span><span class="p">;</span>
|
|
|
|
<span class="nx">define</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">require</span><span class="p">,</span> <span class="nx">exports</span><span class="p">)</span> <span class="p">{</span>
|
|
|
|
<span class="kd">var</span> <span class="nx">Helpers</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'../lib/helpers'</span><span class="p">).</span><span class="nx">Helpers</span><span class="p">;</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>The <code>ClientBase</code> is assumed as the object that all database <code>clients</code>
|
|
inherit from, and is used in an <code>instanceof</code> check when initializing the
|
|
library. If you wish to write or customize an adapter, just inherit from
|
|
this base, with <code>ClientBase.extend</code>, and you're good to go.</p></div></div><div class="code"><div class="wrapper"> <span class="kd">var</span> <span class="nx">ClientBase</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{};</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>The methods assumed when building a client.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">ClientBase</span><span class="p">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="p">{</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Gets the raw connection for the current client.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">getRawConnection</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Execute a query on the specified <code>Builder</code> or <code>SchemaBuilder</code>
|
|
interface. If a <code>connection</code> is specified, use it, otherwise
|
|
acquire a connection, and then dispose of it when we're done.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">query</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Retrieves a connection from the connection pool,
|
|
returning a promise.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">getConnection</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Releases a connection from the connection pool,
|
|
returning a promise.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">releaseConnection</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">conn</span><span class="p">)</span> <span class="p">{},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Begins a transaction statement on the instance,
|
|
resolving with the connection of the current transaction.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">startTransaction</span><span class="o">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>Finishes a transaction, taking the <code>type</code></p></div></div><div class="code"><div class="wrapper"> <span class="nx">finishTransaction</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">type</span><span class="p">,</span> <span class="nx">transaction</span><span class="p">,</span> <span class="nx">msg</span><span class="p">)</span> <span class="p">{},</span></div></div></div><div class="segment"><div class="comments"><div class="wrapper"><p>The pool defaults.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">poolDefaults</span><span class="o">:</span> <span class="kd">function</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>Grab the standard <code>Object.extend</code> as popularized by Backbone.js.</p></div></div><div class="code"><div class="wrapper"> <span class="nx">ClientBase</span><span class="p">.</span><span class="nx">extend</span> <span class="o">=</span> <span class="nx">Helpers</span><span class="p">.</span><span class="nx">extend</span><span class="p">;</span>
|
|
|
|
<span class="nx">exports</span><span class="p">.</span><span class="nx">ClientBase</span> <span class="o">=</span> <span class="nx">ClientBase</span><span class="p">;</span>
|
|
|
|
<span class="p">});</span>
|
|
|
|
<span class="p">})(</span>
|
|
<span class="k">typeof</span> <span class="nx">define</span> <span class="o">===</span> <span class="s1">'function'</span> <span class="o">&&</span> <span class="nx">define</span><span class="p">.</span><span class="nx">amd</span> <span class="o">?</span> <span class="nx">define</span> <span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">factory</span><span class="p">)</span> <span class="p">{</span> <span class="nx">factory</span><span class="p">(</span><span class="nx">require</span><span class="p">,</span> <span class="nx">exports</span><span class="p">);</span>
|
|
<span class="p">});</span></div></div></div></div></body></html> |