Plan/all/com/djrapitops/plan/storage/database/SQLDB.html

684 lines
28 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
2019-08-05 11:13:19 +02:00
<!-- NewPage -->
<html lang="en">
2019-08-05 11:13:19 +02:00
<head>
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>SQLDB (Plan 5.3-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2019-10-05 10:27:37 +02:00
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
2019-10-05 10:27:37 +02:00
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
2019-08-05 11:13:19 +02:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SQLDB (Plan 5.3-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":6,"i11":10,"i12":6};
2019-08-05 11:13:19 +02:00
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
2019-08-05 11:13:19 +02:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
2019-10-05 10:27:37 +02:00
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
2019-08-05 11:13:19 +02:00
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
2019-08-05 11:13:19 +02:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2019-08-05 11:13:19 +02:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
2019-08-05 11:13:19 +02:00
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
2019-08-05 11:13:19 +02:00
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
2019-08-05 11:13:19 +02:00
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
2019-08-05 11:13:19 +02:00
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.storage.database</a></div>
2019-08-05 11:13:19 +02:00
<h2 title="Class SQLDB" class="title">Class SQLDB</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="AbstractDatabase.html" title="class in com.djrapitops.plan.storage.database">com.djrapitops.plan.storage.database.AbstractDatabase</a></li>
2019-08-05 11:13:19 +02:00
<li>
<ul class="inheritance">
2019-10-05 10:27:37 +02:00
<li>com.djrapitops.plan.storage.database.SQLDB</li>
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a></code></dd>
2019-08-05 11:13:19 +02:00
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="H2DB.html" title="class in com.djrapitops.plan.storage.database">H2DB</a></code>, <code><a href="MySQLDB.html" title="class in com.djrapitops.plan.storage.database">MySQLDB</a></code>, <code><a href="SQLiteDB.html" title="class in com.djrapitops.plan.storage.database">SQLiteDB</a></code></dd>
2019-08-05 11:13:19 +02:00
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">SQLDB</span>
extends <a href="AbstractDatabase.html" title="class in com.djrapitops.plan.storage.database">AbstractDatabase</a></pre>
2019-08-05 11:13:19 +02:00
<div class="block">Class containing main logic for different data related save and load functionality.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.com.djrapitops.plan.storage.database.Database">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.djrapitops.plan.storage.database.<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a></h3>
<code><a href="Database.State.html" title="enum in com.djrapitops.plan.storage.database">Database.State</a></code></li>
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="field.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
2019-08-05 11:13:19 +02:00
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#config">config</a></span></code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#errorLogger">errorLogger</a></span></code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#locale">locale</a></span></code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected net.playeranalytics.plugin.server.PluginLogger</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logger">logger</a></span></code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected net.playeranalytics.plugin.scheduling.RunnableFactory</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#runnableFactory">runnableFactory</a></span></code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.com.djrapitops.plan.storage.database.AbstractDatabase">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.djrapitops.plan.storage.database.<a href="AbstractDatabase.html" title="class in com.djrapitops.plan.storage.database">AbstractDatabase</a></h3>
<code><a href="AbstractDatabase.html#accessLock">accessLock</a></code></li>
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
2019-08-05 11:13:19 +02:00
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
2019-08-05 11:13:19 +02:00
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.function.Supplier,com.djrapitops.plan.settings.locale.Locale,com.djrapitops.plan.settings.config.PlanConfig,net.playeranalytics.plugin.scheduling.RunnableFactory,net.playeranalytics.plugin.server.PluginLogger,com.djrapitops.plan.utilities.logging.ErrorLogger)">SQLDB</a></span>&#8203;(java.util.function.Supplier&lt;<a href="../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&gt;&nbsp;serverUUIDSupplier,
<a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a>&nbsp;locale,
<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
net.playeranalytics.plugin.scheduling.RunnableFactory&nbsp;runnableFactory,
net.playeranalytics.plugin.server.PluginLogger&nbsp;logger,
<a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a>&nbsp;errorLogger)</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.summary">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
2019-08-05 11:13:19 +02:00
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(java.lang.Object&nbsp;o)</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeTransaction(com.djrapitops.plan.storage.database.transactions.Transaction)">executeTransaction</a></span>&#8203;(<a href="transactions/Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a>&nbsp;transaction)</code></th>
<td class="colLast">
2019-08-05 11:13:19 +02:00
<div class="block">Execute an SQL Transaction.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract java.sql.Connection</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnection()">getConnection</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>net.playeranalytics.plugin.server.PluginLogger</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogger()">getLogger</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2020-10-11 17:01:29 +02:00
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>net.playeranalytics.plugin.scheduling.RunnableFactory</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRunnableFactory()">getRunnableFactory</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2020-10-11 17:01:29 +02:00
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.function.Supplier&lt;<a href="../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServerUUIDSupplier()">getServerUUIDSupplier</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
2020-10-11 17:01:29 +02:00
<tr id="i7" class="rowColor">
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
2020-10-11 17:01:29 +02:00
<tr id="i8" class="altColor">
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init()">init</a></span>()</code></th>
<td class="colLast">
2019-08-05 11:13:19 +02:00
<div class="block">Initializes the Database.</div>
</td>
</tr>
2020-10-11 17:01:29 +02:00
<tr id="i9" class="rowColor">
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(com.djrapitops.plan.storage.database.queries.Query)">query</a></span>&#8203;(<a href="queries/Query.html" title="interface in com.djrapitops.plan.storage.database.queries">Query</a>&lt;T&gt;&nbsp;query)</code></th>
<td class="colLast">
2019-08-05 11:13:19 +02:00
<div class="block">Execute an SQL Query statement to get a result.</div>
</td>
</tr>
2020-10-11 17:01:29 +02:00
<tr id="i10" class="altColor">
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#returnToPool(java.sql.Connection)">returnToPool</a></span>&#8203;(java.sql.Connection&nbsp;connection)</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
2020-10-11 17:01:29 +02:00
<tr id="i11" class="rowColor">
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTransactionExecutorServiceProvider(java.util.function.Supplier)">setTransactionExecutorServiceProvider</a></span>&#8203;(java.util.function.Supplier&lt;java.util.concurrent.ExecutorService&gt;&nbsp;transactionExecutorServiceProvider)</code></th>
<td class="colLast">&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
2020-10-11 17:01:29 +02:00
<tr id="i12" class="altColor">
2019-08-05 11:13:19 +02:00
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setupDataSource()">setupDataSource</a></span>()</code></th>
<td class="colLast">
2019-08-05 11:13:19 +02:00
<div class="block">Set up the source for connections.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.djrapitops.plan.storage.database.AbstractDatabase">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.djrapitops.plan.storage.database.<a href="AbstractDatabase.html" title="class in com.djrapitops.plan.storage.database">AbstractDatabase</a></h3>
<code><a href="AbstractDatabase.html#assumeNoMoreHeavyLoad()">assumeNoMoreHeavyLoad</a>, <a href="AbstractDatabase.html#getHeavyLoadDelayMs()">getHeavyLoadDelayMs</a>, <a href="AbstractDatabase.html#getState()">getState</a>, <a href="AbstractDatabase.html#increaseHeavyLoadDelay()">increaseHeavyLoadDelay</a>, <a href="AbstractDatabase.html#isUnderHeavyLoad()">isUnderHeavyLoad</a>, <a href="AbstractDatabase.html#setState(com.djrapitops.plan.storage.database.Database.State)">setState</a></code></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.djrapitops.plan.storage.database.Database">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.djrapitops.plan.storage.database.<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a></h3>
<code><a href="Database.html#getSql()">getSql</a>, <a href="Database.html#getType()">getType</a></code></li>
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="field.detail">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="locale">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>locale</h4>
<pre>protected final&nbsp;<a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a> locale</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="config">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>config</h4>
<pre>protected final&nbsp;<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="runnableFactory">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runnableFactory</h4>
<pre>protected final&nbsp;net.playeranalytics.plugin.scheduling.RunnableFactory runnableFactory</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="logger">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logger</h4>
<pre>protected final&nbsp;net.playeranalytics.plugin.server.PluginLogger logger</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="errorLogger">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
2020-06-21 19:24:04 +02:00
<h4>errorLogger</h4>
<pre>protected final&nbsp;<a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.util.function.Supplier,com.djrapitops.plan.settings.locale.Locale,com.djrapitops.plan.settings.config.PlanConfig,net.playeranalytics.plugin.scheduling.RunnableFactory,net.playeranalytics.plugin.server.PluginLogger,com.djrapitops.plan.utilities.logging.ErrorLogger)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SQLDB</h4>
<pre>protected&nbsp;SQLDB&#8203;(java.util.function.Supplier&lt;<a href="../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&gt;&nbsp;serverUUIDSupplier,
<a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a>&nbsp;locale,
<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
net.playeranalytics.plugin.scheduling.RunnableFactory&nbsp;runnableFactory,
net.playeranalytics.plugin.server.PluginLogger&nbsp;logger,
<a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a>&nbsp;errorLogger)</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
2019-08-05 11:13:19 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.detail">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="init()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;init()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Database.html#init()">Database</a></code></span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Initializes the Database.
<p>
Queries can be performed after this request has completed all required transactions for the database operations.</div>
</li>
</ul>
<a id="setupDataSource()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupDataSource</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;setupDataSource()</pre>
2019-08-05 11:13:19 +02:00
<div class="block">Set up the source for connections.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../exceptions/database/DBInitException.html" title="class in com.djrapitops.plan.exceptions.database">DBInitException</a></code> - If the DataSource fails to be initialized.</dd>
2019-08-05 11:13:19 +02:00
</dl>
</li>
</ul>
<a id="close()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="getConnection()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre class="methodSignature">public abstract&nbsp;java.sql.Connection&nbsp;getConnection()
2019-08-05 11:13:19 +02:00
throws java.sql.SQLException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.sql.SQLException</code></dd>
</dl>
</li>
</ul>
<a id="returnToPool(java.sql.Connection)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>returnToPool</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;returnToPool&#8203;(java.sql.Connection&nbsp;connection)</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="query(com.djrapitops.plan.storage.database.queries.Query)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre class="methodSignature">public&nbsp;&lt;T&gt;&nbsp;T&nbsp;query&#8203;(<a href="queries/Query.html" title="interface in com.djrapitops.plan.storage.database.queries">Query</a>&lt;T&gt;&nbsp;query)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Database.html#query(com.djrapitops.plan.storage.database.queries.Query)">Database</a></code></span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Execute an SQL Query statement to get a result.
<p>
This method should only be called from an asynchronous thread.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of the object to be returned.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>query</code> - QueryStatement to execute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Result of the query.</dd>
</dl>
</li>
</ul>
<a id="executeTransaction(com.djrapitops.plan.storage.database.transactions.Transaction)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeTransaction</h4>
<pre class="methodSignature">public&nbsp;java.util.concurrent.Future&lt;?&gt;&nbsp;executeTransaction&#8203;(<a href="transactions/Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a>&nbsp;transaction)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Database.html#executeTransaction(com.djrapitops.plan.storage.database.transactions.Transaction)">Database</a></code></span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Execute an SQL Transaction.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transaction</code> - Transaction to execute.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Future that is finished when the transaction has been executed.</dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(java.lang.Object&nbsp;o)</pre>
2019-08-05 11:13:19 +02:00
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
2019-08-05 11:13:19 +02:00
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="getServerUUIDSupplier()">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerUUIDSupplier</h4>
<pre class="methodSignature">public&nbsp;java.util.function.Supplier&lt;<a href="../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>&gt;&nbsp;getServerUUIDSupplier()</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="setTransactionExecutorServiceProvider(java.util.function.Supplier)">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
2020-10-11 17:01:29 +02:00
<ul class="blockList">
2019-08-05 11:13:19 +02:00
<li class="blockList">
<h4>setTransactionExecutorServiceProvider</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTransactionExecutorServiceProvider&#8203;(java.util.function.Supplier&lt;java.util.concurrent.ExecutorService&gt;&nbsp;transactionExecutorServiceProvider)</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
<a id="getRunnableFactory()">
2020-10-11 17:01:29 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRunnableFactory</h4>
<pre class="methodSignature">public&nbsp;net.playeranalytics.plugin.scheduling.RunnableFactory&nbsp;getRunnableFactory()</pre>
2020-10-11 17:01:29 +02:00
</li>
</ul>
<a id="getLogger()">
2020-10-11 17:01:29 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLogger</h4>
<pre class="methodSignature">public&nbsp;net.playeranalytics.plugin.server.PluginLogger&nbsp;getLogger()</pre>
2020-10-11 17:01:29 +02:00
</li>
</ul>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
</div>
</main>
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
2019-08-05 11:13:19 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
2019-10-05 10:27:37 +02:00
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
2019-08-05 11:13:19 +02:00
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2019-08-05 11:13:19 +02:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
2019-08-05 11:13:19 +02:00
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
2019-08-05 11:13:19 +02:00
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
2019-08-05 11:13:19 +02:00
</body>
</html>