bitcoin-s/api/org/bitcoins/db/index.html

11 lines
56 KiB
HTML
Raw Normal View History

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title></title><meta content="" name="description"/><meta content="" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../lib/index.js"></script><script type="text/javascript" src="../../../index.js"></script><script type="text/javascript" src="../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../';</script></head><body><div id="search"><span id="doc-title"><span id="doc-version"></span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></a> <span class="permalink"><a href="../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.org" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="org" class="anchorToMember"></a><a id="org:org" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">org</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="org.bitcoins" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="bitcoins" class="anchorToMember"></a><a id="bitcoins:bitcoins" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">bitcoins</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="org" id="org" class="extype">org</a></dd></dl></div></li><li class="indented3 " name="org.bitcoins.asyncutil" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asyncutil" class="anchorToMember"></a><a id="asyncutil:asyncutil" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/asyncutil/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../asyncutil/index.html" title=""><span class="name">asyncutil</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="org.bitcoins" id="org.bitcoins" class="extype">bitcoins</a></dd></dl></div></li><li class="indented3 " name="org.bitcoins.bench" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="bench" class="anchorToMember"></a><a id="bench:bench" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/bench/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class=
This is an abstract actor that can be used to implement any sort of
actor that accesses a Postgres database. It creates
read, update, upsert, and delete methods for your actor to call.
You are responsible for the create function. You also need to specify
the table and the database you are connecting to.
</p></div></div></li><li class="indented0 " name="org.bitcoins.db.CRUDAction" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="CRUDAction[T,PrimaryKeyType]extendsJdbcProfileComponent[org.bitcoins.db.DbAppConfig]" class="anchorToMember"></a><a id="CRUDAction[T,PrimaryKeyType]:CRUDAction[T,PrimaryKeyType]" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/db/CRUDAction.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="CRUDAction.html" title=""><span class="name">CRUDAction</span></a><span class="tparams">[<span name="T">T</span>, <span name="PrimaryKeyType">PrimaryKeyType</span>]</span><span class="result"> extends <a href="JdbcProfileComponent.html" name="org.bitcoins.db.JdbcProfileComponent" id="org.bitcoins.db.JdbcProfileComponent" class="extype">JdbcProfileComponent</a>[<a href="DbAppConfig.html" name="org.bitcoins.db.DbAppConfig" id="org.bitcoins.db.DbAppConfig" class="extype">DbAppConfig</a>]</span></span></li><li class="indented0 " name="org.bitcoins.db.CRUDAutoInc" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="CRUDAutoInc[T&lt;:org.bitcoins.core.api.db.DbRowAutoInc[T]]extendsCRUD[T,Long]withTableAutoIncComponent[T]" class="anchorToMember"></a><a id="CRUDAutoInc[T&lt;:DbRowAutoInc[T]]:CRUDAutoInc[T]" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/db/CRUDAutoInc.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="CRUDAutoInc.html" title=""><span class="name">CRUDAutoInc</span></a><span class="tparams">[<span name="T">T &lt;: <a href="../core/api/db/DbRowAutoInc.html" name="org.bitcoins.core.api.db.DbRowAutoInc" id="org.bitcoins.core.api.db.DbRowAutoInc" class="extype">DbRowAutoInc</a>[<span name="org.bitcoins.db.CRUDAutoInc.T" class="extype">T</span>]</span>]</span><span class="result"> extends <a href="CRUD.html" name="org.bitcoins.db.CRUD" id="org.bitcoins.db.CRUD" class="extype">CRUD</a>[<span name="org.bitcoins.db.CRUDAutoInc.T" class="extype">T</span>, <a href="https://www.scala-lang.org/api/2.13.8/scala/Long.html#scala.Long" name="scala.Long" id="scala.Long" class="extype">Long</a>] with <a href="TableAutoIncComponent.html" name="org.bitcoins.db.TableAutoIncComponent" id="org.bitcoins.db.TableAutoIncComponent" class="extype">TableAutoIncComponent</a>[<span name="org.bitcoins.db.CRUDAutoInc.T" class="extype">T</span>]</span></span></li><li class="indented0 " name="org.bitcoins.db.DatabaseDriver" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="DatabaseDriverextendsAnyRef" class="anchorToMember"></a><a id="DatabaseDriver:DatabaseDriver" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/db/DatabaseDriver.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="DatabaseDriver.html" title=""><span class="name">DatabaseDriver</span></a><span class="result"> extends <a href="../../../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span></li><li class="indented0 " name="org.bitcoins.db.DbAppConfig" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="DbAppConfigextendsAppConfig" class="anchorToMember"></a><a id="DbAppConfig:DbAppConfig" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/db/DbAppConfig.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="DbAppConfig.html" title=""><span class="name">DbAppConfig</span></a><span class="re
This is useful for things we want to store that don't have an
inherent id such as a hash.</p></div></div></li><li class="indented0 " name="org.bitcoins.db.UpdateFailedException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UpdateFailedExceptionextendsRuntimeExceptionwithProductwithSerializable" class="anchorToMember"></a><a id="UpdateFailedException:UpdateFailedException" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/db/UpdateFailedException.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case class</span></span> <span class="symbol"><a href="UpdateFailedException.html" title=""><span class="name">UpdateFailedException</span></a><span class="params">(<span name="message">message: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result"> extends <a href="../../../scala/index.html#RuntimeException=RuntimeException" name="scala.RuntimeException" id="scala.RuntimeException" class="extmbr">RuntimeException</a> with <a href="https://www.scala-lang.org/api/2.13.8/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../../../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span></li><li class="indented0 " name="org.bitcoins.db.UpsertFailedException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="UpsertFailedExceptionextendsRuntimeExceptionwithProductwithSerializable" class="anchorToMember"></a><a id="UpsertFailedException:UpsertFailedException" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/db/UpsertFailedException.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case class</span></span> <span class="symbol"><a href="UpsertFailedException.html" title=""><span class="name">UpsertFailedException</span></a><span class="params">(<span name="message">message: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result"> extends <a href="../../../scala/index.html#RuntimeException=RuntimeException" name="scala.RuntimeException" id="scala.RuntimeException" class="extmbr">RuntimeException</a> with <a href="https://www.scala-lang.org/api/2.13.8/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../../../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="org.bitcoins.db.DatabaseDriver" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="DatabaseDriver" class="anchorToMember"></a><a id="DatabaseDriver:DatabaseDriver" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/db/DatabaseDriver$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="DatabaseDriver$.html" title=""><span class="name">DatabaseDriver</span></a><span class="result"> extends <a href="../crypto/StringFactory.html" name="org.bitcoins.crypto.StringFactory" id="org.bitcoins.crypto.StringFactory" class="extype">StringFactory</a>[<a href="DatabaseDriver.html" name="org.bitcoins.db.DatabaseDriver" id="org.bitcoins.db.DatabaseDriver" class="extype">DatabaseDriver</a>]</span></span></li><li class="indented0 " name="org.bitcoins.db.DatadirUtil" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="DatadirUtil" class="anchorToMember"></a><a id="DatadirUtil:DatadirUtil" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/db/DatadirUtil$.html" title="Permalink"><i class="material-icons"></i></a></span>