mirror of
https://gitea.invidious.io/iv-org/shard-crystal-db.git
synced 2024-08-15 00:53:32 +00:00
482 lines
13 KiB
HTML
482 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="generator" content="Crystal Docs 1.2.2">
|
|
<meta name="crystal_docs.project_version" content="0.11.0">
|
|
<meta name="crystal_docs.project_name" content="db">
|
|
|
|
|
|
|
|
<link href="../css/style.css" rel="stylesheet" type="text/css" />
|
|
<script type="text/javascript" src="../js/doc.js"></script>
|
|
|
|
<meta name="repository-name" content="db">
|
|
<title>DB::Driver - db 0.11.0</title>
|
|
<script type="text/javascript">
|
|
CrystalDocs.base_path = "../";
|
|
</script>
|
|
</head>
|
|
<body>
|
|
|
|
<svg class="hidden">
|
|
<symbol id="octicon-link" viewBox="0 0 16 16">
|
|
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
|
|
</symbol>
|
|
</svg>
|
|
<div class="sidebar">
|
|
<div class="sidebar-header">
|
|
<div class="search-box">
|
|
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
|
|
</div>
|
|
|
|
<div class="project-summary">
|
|
<h1 class="project-name">
|
|
<a href="../index.html">
|
|
db
|
|
</a>
|
|
</h1>
|
|
|
|
<span class="project-version">
|
|
0.11.0
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="search-results hidden">
|
|
<ul class="search-list"></ul>
|
|
</div>
|
|
|
|
<div class="types-list">
|
|
<ul>
|
|
|
|
<li class="parent open current" data-id="db/DB" data-name="db">
|
|
<a href="../DB.html">DB</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="db/DB/Any" data-name="db::any">
|
|
<a href="../DB/Any.html">Any</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/BeginTransaction" data-name="db::begintransaction">
|
|
<a href="../DB/BeginTransaction.html">BeginTransaction</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/ColumnTypeMismatchError" data-name="db::columntypemismatcherror">
|
|
<a href="../DB/ColumnTypeMismatchError.html">ColumnTypeMismatchError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Connection" data-name="db::connection">
|
|
<a href="../DB/Connection.html">Connection</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/ConnectionContext" data-name="db::connectioncontext">
|
|
<a href="../DB/ConnectionContext.html">ConnectionContext</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/ConnectionLost" data-name="db::connectionlost">
|
|
<a href="../DB/ConnectionLost.html">ConnectionLost</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/ConnectionRefused" data-name="db::connectionrefused">
|
|
<a href="../DB/ConnectionRefused.html">ConnectionRefused</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Database" data-name="db::database">
|
|
<a href="../DB/Database.html">Database</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Disposable" data-name="db::disposable">
|
|
<a href="../DB/Disposable.html">Disposable</a>
|
|
|
|
</li>
|
|
|
|
<li class=" current" data-id="db/DB/Driver" data-name="db::driver">
|
|
<a href="../DB/Driver.html">Driver</a>
|
|
|
|
</li>
|
|
|
|
<li class="parent " data-id="db/DB/DriverSpecs" data-name="db::driverspecs(dbanytype)">
|
|
<a href="../DB/DriverSpecs.html">DriverSpecs</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="db/DB/DriverSpecs/ColumnDef" data-name="db::driverspecs::columndef">
|
|
<a href="../DB/DriverSpecs/ColumnDef.html">ColumnDef</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Error" data-name="db::error">
|
|
<a href="../DB/Error.html">Error</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/ExecResult" data-name="db::execresult">
|
|
<a href="../DB/ExecResult.html">ExecResult</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Field" data-name="db::field">
|
|
<a href="../DB/Field.html">Field</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Mappable" data-name="db::mappable">
|
|
<a href="../DB/Mappable.html">Mappable</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/MappingException" data-name="db::mappingexception">
|
|
<a href="../DB/MappingException.html">MappingException</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/MetadataValueConverter" data-name="db::metadatavalueconverter">
|
|
<a href="../DB/MetadataValueConverter.html">MetadataValueConverter</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/NoResultsError" data-name="db::noresultserror">
|
|
<a href="../DB/NoResultsError.html">NoResultsError</a>
|
|
|
|
</li>
|
|
|
|
<li class="parent " data-id="db/DB/Pool" data-name="db::pool(t)">
|
|
<a href="../DB/Pool.html">Pool</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="db/DB/Pool/Stats" data-name="db::pool::stats">
|
|
<a href="../DB/Pool/Stats.html">Stats</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolPreparedStatement" data-name="db::poolpreparedstatement">
|
|
<a href="../DB/PoolPreparedStatement.html">PoolPreparedStatement</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolResourceLost" data-name="db::poolresourcelost(t)">
|
|
<a href="../DB/PoolResourceLost.html">PoolResourceLost</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolResourceRefused" data-name="db::poolresourcerefused">
|
|
<a href="../DB/PoolResourceRefused.html">PoolResourceRefused</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolRetryAttemptsExceeded" data-name="db::poolretryattemptsexceeded">
|
|
<a href="../DB/PoolRetryAttemptsExceeded.html">PoolRetryAttemptsExceeded</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolStatement" data-name="db::poolstatement">
|
|
<a href="../DB/PoolStatement.html">PoolStatement</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolTimeout" data-name="db::pooltimeout">
|
|
<a href="../DB/PoolTimeout.html">PoolTimeout</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/PoolUnpreparedStatement" data-name="db::poolunpreparedstatement">
|
|
<a href="../DB/PoolUnpreparedStatement.html">PoolUnpreparedStatement</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/QueryMethods" data-name="db::querymethods(stmt)">
|
|
<a href="../DB/QueryMethods.html">QueryMethods</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/ResultSet" data-name="db::resultset">
|
|
<a href="../DB/ResultSet.html">ResultSet</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Rollback" data-name="db::rollback">
|
|
<a href="../DB/Rollback.html">Rollback</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/SavePointTransaction" data-name="db::savepointtransaction">
|
|
<a href="../DB/SavePointTransaction.html">SavePointTransaction</a>
|
|
|
|
</li>
|
|
|
|
<li class="parent " data-id="db/DB/Serializable" data-name="db::serializable">
|
|
<a href="../DB/Serializable.html">Serializable</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="db/DB/Serializable/NonStrict" data-name="db::serializable::nonstrict">
|
|
<a href="../DB/Serializable/NonStrict.html">NonStrict</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="parent " data-id="db/DB/SessionMethods" data-name="db::sessionmethods(session, stmt)">
|
|
<a href="../DB/SessionMethods.html">SessionMethods</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="db/DB/SessionMethods/PreparedQuery" data-name="db::sessionmethods::preparedquery(session, stmt)">
|
|
<a href="../DB/SessionMethods/PreparedQuery.html">PreparedQuery</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/SessionMethods/UnpreparedQuery" data-name="db::sessionmethods::unpreparedquery(session, stmt)">
|
|
<a href="../DB/SessionMethods/UnpreparedQuery.html">UnpreparedQuery</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Statement" data-name="db::statement">
|
|
<a href="../DB/Statement.html">Statement</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/StatementMethods" data-name="db::statementmethods">
|
|
<a href="../DB/StatementMethods.html">StatementMethods</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/StringKeyCache" data-name="db::stringkeycache(t)">
|
|
<a href="../DB/StringKeyCache.html">StringKeyCache</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/TopLevelTransaction" data-name="db::topleveltransaction">
|
|
<a href="../DB/TopLevelTransaction.html">TopLevelTransaction</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="db/DB/Transaction" data-name="db::transaction">
|
|
<a href="../DB/Transaction.html">Transaction</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="main-content">
|
|
<h1 class="type-name">
|
|
|
|
<span class="kind">abstract class</span> DB::Driver
|
|
|
|
</h1>
|
|
|
|
|
|
<ul class="superclass-hierarchy"><li class="superclass"><a href="../DB/Driver.html">DB::Driver</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="overview" class="anchor" href="#overview">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Overview
|
|
</h2>
|
|
|
|
<p>Database driver implementors must subclass <code><a href="../DB/Driver.html">Driver</a></code>,
|
|
register with a driver_name using <code><a href="../DB.html#register_driver%28driver_name%2Cdriver_class%3ADriver.class%29-class-method">DB#register_driver</a></code> and
|
|
override the factory method <code><a href="../DB/Driver.html#build_connection%28context%3AConnectionContext%29%3AConnection-instance-method">#build_connection</a></code>.</p>
|
|
<pre><code class="language-crystal"><span class="k">require</span> <span class="s">"db"</span>
|
|
|
|
<span class="k">class</span> <span class="t">FakeDriver</span> <span class="o"><</span> <span class="t">DB</span><span class="t">::</span><span class="t">Driver</span>
|
|
<span class="k">def</span> <span class="m">build_connection</span>(context : <span class="t">DB</span><span class="t">::</span><span class="t">ConnectionContext</span>)
|
|
<span class="t">FakeConnection</span>.<span class="k">new</span> context
|
|
<span class="k">end</span>
|
|
<span class="k">end</span>
|
|
|
|
<span class="t">DB</span>.register_driver <span class="s">"fake"</span>, <span class="t">FakeDriver</span></code></pre>
|
|
<p>Access to this fake datbase will be available with</p>
|
|
<pre><code class="language-crystal"><span class="t">DB</span>.open <span class="s">"fake://..."</span> <span class="k">do</span> <span class="o">|</span>db<span class="o">|</span>
|
|
<span class="c"># ... use db ...</span>
|
|
<span class="k">end</span></code></pre>
|
|
<p>Refer to <code><a href="../DB/Connection.html">Connection</a></code>, <code><a href="../DB/Statement.html">Statement</a></code> and <code><a href="../DB/ResultSet.html">ResultSet</a></code> for further
|
|
driver implementation instructions.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="defined-in" class="anchor" href="#defined-in">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Defined in:
|
|
</h2>
|
|
|
|
|
|
<a href="https://github.com/crystal-lang/crystal-db/blob/v0.11.0/src/db/driver.cr#L28" target="_blank">
|
|
db/driver.cr
|
|
</a>
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="instance-method-summary" class="anchor" href="#instance-method-summary">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Instance Method Summary
|
|
</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#build_connection%28context%3AConnectionContext%29%3AConnection-instance-method" class="signature"><strong>#build_connection</strong>(context : ConnectionContext) : Connection</a>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#connection_pool_options%28params%3AHTTP%3A%3AParams%29-instance-method" class="signature"><strong>#connection_pool_options</strong>(params : HTTP::Params)</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="methods-inherited">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="instance-method-detail" class="anchor" href="#instance-method-detail">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Instance Method Detail
|
|
</h2>
|
|
|
|
<div class="entry-detail" id="build_connection(context:ConnectionContext):Connection-instance-method">
|
|
<div class="signature">
|
|
abstract
|
|
def <strong>build_connection</strong>(context : <a href="../DB/ConnectionContext.html">ConnectionContext</a>) : <a href="../DB/Connection.html">Connection</a>
|
|
|
|
<a class="method-permalink" href="#build_connection%28context%3AConnectionContext%29%3AConnection-instance-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/v0.11.0/src/db/driver.cr#L29" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="connection_pool_options(params:HTTP::Params)-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>connection_pool_options</strong>(params : HTTP::Params)
|
|
|
|
<a class="method-permalink" href="#connection_pool_options%28params%3AHTTP%3A%3AParams%29-instance-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/v0.11.0/src/db/driver.cr#L31" target="_blank">View source</a>]
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|