mirror of
https://gitea.invidious.io/iv-org/shard-crystal-db.git
synced 2024-08-15 00:53:32 +00:00
512 lines
16 KiB
HTML
512 lines
16 KiB
HTML
|
<!DOCTYPE html>
|
||
|
<html lang="en">
|
||
|
<head>
|
||
|
<meta charset="utf-8" />
|
||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
<meta name="generator" content="Crystal Docs 1.5.1">
|
||
|
<meta name="crystal_docs.project_version" content="0.13.1">
|
||
|
<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::Serializable - db 0.13.1</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="currentColor" 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>
|
||
|
<input type="checkbox" id="sidebar-btn">
|
||
|
<label for="sidebar-btn" id="sidebar-btn-label">
|
||
|
<svg class="open" xmlns="http://www.w3.org/2000/svg" height="2em" width="2em" viewBox="0 0 512 512"><title>Open Sidebar</title><path fill="currentColor" d="M80 96v64h352V96H80zm0 112v64h352v-64H80zm0 112v64h352v-64H80z"></path></svg>
|
||
|
<svg class="close" xmlns="http://www.w3.org/2000/svg" width="2em" height="2em" viewBox="0 0 512 512"><title>Close Sidebar</title><path fill="currentColor" d="m118.6 73.4-45.2 45.2L210.7 256 73.4 393.4l45.2 45.2L256 301.3l137.4 137.3 45.2-45.2L301.3 256l137.3-137.4-45.2-45.2L256 210.7Z"></path></svg>
|
||
|
</label>
|
||
|
<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.13.1
|
||
|
</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="parent " data-id="db/DB/Connection" data-name="db::connection">
|
||
|
<a href="../DB/Connection.html">Connection</a>
|
||
|
|
||
|
<ul>
|
||
|
|
||
|
<li class=" " data-id="db/DB/Connection/Options" data-name="db::connection::options">
|
||
|
<a href="../DB/Connection/Options.html">Options</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
</li>
|
||
|
|
||
|
<li class=" " data-id="db/DB/ConnectionBuilder" data-name="db::connectionbuilder">
|
||
|
<a href="../DB/ConnectionBuilder.html">ConnectionBuilder</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=" " 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/Options" data-name="db::pool::options">
|
||
|
<a href="../DB/Pool/Options.html">Options</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
<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 open current" 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>
|
||
|
|
||
|
<li class=" " data-id="db/Enum" data-name="enum">
|
||
|
<a href="../Enum.html">Enum</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
<div class="main-content">
|
||
|
<h1 class="type-name">
|
||
|
|
||
|
<span class="kind">module</span> DB::<wbr>Serializable
|
||
|
|
||
|
</h1>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h2>
|
||
|
<a id="overview" class="anchor" href="#overview">
|
||
|
<svg class="octicon-link" aria-hidden="true">
|
||
|
<use href="#octicon-link"/>
|
||
|
</svg>
|
||
|
</a>
|
||
|
Overview
|
||
|
</h2>
|
||
|
|
||
|
<p>The <code>DB::Serialization</code> module automatically generates methods for DB serialization when included.</p>
|
||
|
<p>Once included, <code><a href="../DB/ResultSet.html#read%28type%3AEnum.class%29-instance-method">ResultSet#read(t)</a></code> populates properties of the class from the
|
||
|
<code><a href="../DB/ResultSet.html">ResultSet</a></code>.</p>
|
||
|
<h3><a id="example" class="anchor" href="#example">
|
||
|
<svg class="octicon-link" aria-hidden="true">
|
||
|
<use href="#octicon-link"/>
|
||
|
</svg>
|
||
|
</a>Example</h3>
|
||
|
<pre><code class="language-crystal"><span class="k">require</span> <span class="s">"db"</span>
|
||
|
|
||
|
<span class="k">class</span> <span class="t">Employee</span>
|
||
|
<span class="k">include</span> <span class="t">DB</span><span class="t">::</span><span class="t">Serializable</span>
|
||
|
|
||
|
property title : <span class="t">String</span>
|
||
|
property name : <span class="t">String</span>
|
||
|
<span class="k">end</span>
|
||
|
|
||
|
employees <span class="o">=</span> <span class="t">Employee</span>.from_rs(db.query(<span class="s">"SELECT title, name FROM employees"</span>))
|
||
|
employees[<span class="n">0</span>].title <span class="c"># => "Manager"</span>
|
||
|
employees[<span class="n">0</span>].name <span class="c"># => "John"</span></code></pre>
|
||
|
<h3><a id="usage" class="anchor" href="#usage">
|
||
|
<svg class="octicon-link" aria-hidden="true">
|
||
|
<use href="#octicon-link"/>
|
||
|
</svg>
|
||
|
</a>Usage</h3>
|
||
|
<p><code><a href="../DB/Serializable.html">DB::Serializable</a></code> was designed in analogue with <code>JSON::Serializable</code>, so usage is identical.
|
||
|
However, like <code><a href="../DB.html#mapping%28%2A%2Aproperties%29-macro">DB.mapping</a></code>, <code><a href="../DB/Serializable.html">DB::Serializable</a></code> is <strong>strict by default</strong>, so extra columns will raise <code><a href="../DB/MappingException.html">DB::MappingException</a></code>s.</p>
|
||
|
<p>Similar to <code>JSON::Field</code>, there is an annotation <code><a href="../DB/Field.html">DB::Field</a></code> that can be used to set serialization behavior
|
||
|
on individual instance variables.</p>
|
||
|
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">Employee</span>
|
||
|
<span class="k">include</span> <span class="t">DB</span><span class="t">::</span><span class="t">Serializable</span>
|
||
|
|
||
|
property title : <span class="t">String</span>
|
||
|
|
||
|
@[<span class="t">DB</span><span class="t">::</span><span class="t">Field</span>(key: <span class="s">"firstname"</span>)]
|
||
|
property name : <span class="t">String</span>?
|
||
|
<span class="k">end</span></code></pre>
|
||
|
<p><code><a href="../DB/Field.html">DB::Field</a></code> properties:</p>
|
||
|
<ul>
|
||
|
<li><strong>ignore</strong>: if <code>true</code>, skip this field in serialization and deserialization (<code>false</code> by default)</li>
|
||
|
<li><strong>key</strong>: defines which column to read from a <code><a href="../DB/ResultSet.html">ResultSet</a></code> (name of the instance variable by default)</li>
|
||
|
<li><strong>converter</strong>: defines an alternate type for parsing results. The given type must define <code>#from_rs(DB::ResultSet)</code> and return an instance of the included type.</li>
|
||
|
</ul>
|
||
|
<h3><a id="dbserializablenon-strict" class="anchor" href="#dbserializablenon-strict">
|
||
|
<svg class="octicon-link" aria-hidden="true">
|
||
|
<use href="#octicon-link"/>
|
||
|
</svg>
|
||
|
</a><code><a href="../DB/Serializable/NonStrict.html">DB::Serializable::NonStrict</a></code></h3>
|
||
|
<p>Including this module is functionally identical to passing <code>{strict: false}</code> to <code><a href="../DB.html#mapping%28%2A%2Aproperties%29-macro">DB.mapping</a></code>: extra columns will not raise.</p>
|
||
|
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">Employee</span>
|
||
|
<span class="k">include</span> <span class="t">DB</span><span class="t">::</span><span class="t">Serializable</span>
|
||
|
<span class="k">include</span> <span class="t">DB</span><span class="t">::</span><span class="t">Serializable</span><span class="t">::</span><span class="t">NonStrict</span>
|
||
|
|
||
|
property title : <span class="t">String</span>
|
||
|
property name : <span class="t">String</span>
|
||
|
<span class="k">end</span>
|
||
|
|
||
|
<span class="c"># does not raise!</span>
|
||
|
employees <span class="o">=</span> <span class="t">Employee</span>.from_rs(db.query(<span class="s">"SELECT title, name, age FROM employees"</span>))</code></pre>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<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.13.1/src/db/serializable.cr#L67" target="_blank">
|
||
|
db/serializable.cr
|
||
|
</a>
|
||
|
|
||
|
<br/>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<h2>
|
||
|
<a id="constructors" class="anchor" href="#constructors">
|
||
|
<svg class="octicon-link" aria-hidden="true">
|
||
|
<use href="#octicon-link"/>
|
||
|
</svg>
|
||
|
</a>
|
||
|
Constructors
|
||
|
</h2>
|
||
|
<ul class="list-summary">
|
||
|
|
||
|
<li class="entry-summary">
|
||
|
<a href="#new%28%2A%2C__set_for_db_serializablers%3ADB%3A%3AResultSet%29-class-method" class="signature"><strong>.new</strong>(*, __set_for_db_serializable rs : DB::ResultSet)</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="methods-inherited">
|
||
|
|
||
|
</div>
|
||
|
|
||
|
|
||
|
<h2>
|
||
|
<a id="constructor-detail" class="anchor" href="#constructor-detail">
|
||
|
<svg class="octicon-link" aria-hidden="true">
|
||
|
<use href="#octicon-link"/>
|
||
|
</svg>
|
||
|
</a>
|
||
|
Constructor Detail
|
||
|
</h2>
|
||
|
|
||
|
<div class="entry-detail" id="new(*,__set_for_db_serializablers:DB::ResultSet)-class-method">
|
||
|
<div class="signature">
|
||
|
|
||
|
def self.<strong>new</strong>(*, __set_for_db_serializable rs : <a href="../DB/ResultSet.html">DB::ResultSet</a>)
|
||
|
|
||
|
<a class="method-permalink" href="#new%28%2A%2C__set_for_db_serializablers%3ADB%3A%3AResultSet%29-class-method">#</a>
|
||
|
</div>
|
||
|
|
||
|
<br/>
|
||
|
<div>
|
||
|
|
||
|
[<a href="https://github.com/crystal-lang/crystal-db/blob/v0.13.1/src/db/serializable.cr#L104" target="_blank">View source</a>]
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</div>
|
||
|
|
||
|
</body>
|
||
|
</html>
|