mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-02 00:39:34 +01:00
473 lines
40 KiB
HTML
473 lines
40 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (16) -->
|
|
<title>SQLDB (Plan 5.4-SNAPSHOT API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: com.djrapitops.plan.storage.database, class: SQLDB">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar.top">
|
|
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<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>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip.navbar.top">
|
|
<!-- -->
|
|
</span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.djrapitops.plan.storage.database</a></div>
|
|
<h1 title="Class SQLDB" class="title">Class SQLDB</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance"><a href="AbstractDatabase.html" title="class in com.djrapitops.plan.storage.database">com.djrapitops.plan.storage.database.AbstractDatabase</a>
|
|
<div class="inheritance">com.djrapitops.plan.storage.database.SQLDB</div>
|
|
</div>
|
|
</div>
|
|
<section class="description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a></code></dd>
|
|
</dl>
|
|
<dl class="notes">
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><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>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">SQLDB</span>
|
|
<span class="extends-implements">extends <a href="AbstractDatabase.html" title="class in com.djrapitops.plan.storage.database">AbstractDatabase</a></span></div>
|
|
<div class="block">Class containing main logic for different data related save and load functionality.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li>
|
|
<section class="nested-class-summary" id="nested.class.summary">
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="inherited-list">
|
|
<h2 id="nested.classes.inherited.from.class.com.djrapitops.plan.storage.database.Database">Nested classes/interfaces inherited from interface com.djrapitops.plan.storage.database.<a href="Database.html" title="interface in com.djrapitops.plan.storage.database">Database</a></h2>
|
|
<code><a href="Database.State.html" title="enum class in com.djrapitops.plan.storage.database">Database.State</a></code></div>
|
|
</section>
|
|
</li>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field.summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="caption"><span>Fields</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Field</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>protected <a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a></code></div>
|
|
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#config">config</a></span></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a></code></div>
|
|
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#driverClassLoader">driverClassLoader</a></span></code></div>
|
|
<div class="col-last odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>protected <a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a></code></div>
|
|
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#errorLogger">errorLogger</a></span></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>protected <a href="../file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a></code></div>
|
|
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#files">files</a></span></code></div>
|
|
<div class="col-last odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>protected <a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a></code></div>
|
|
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#locale">locale</a></span></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
<div class="col-first odd-row-color"><code>protected net.playeranalytics.plugin.server.PluginLogger</code></div>
|
|
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#logger">logger</a></span></code></div>
|
|
<div class="col-last odd-row-color"> </div>
|
|
<div class="col-first even-row-color"><code>protected net.playeranalytics.plugin.scheduling.RunnableFactory</code></div>
|
|
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#runnableFactory">runnableFactory</a></span></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="fields.inherited.from.class.com.djrapitops.plan.storage.database.AbstractDatabase">Fields inherited from class 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></div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor.summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier</div>
|
|
<div class="table-header col-second">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>protected </code></div>
|
|
<div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E(java.util.function.Supplier,com.djrapitops.plan.settings.locale.Locale,com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.file.PlanFiles,net.playeranalytics.plugin.scheduling.RunnableFactory,net.playeranalytics.plugin.server.PluginLogger,com.djrapitops.plan.utilities.logging.ErrorLogger)">SQLDB</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>> serverUUIDSupplier,
|
|
<a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a> locale,
|
|
<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config,
|
|
<a href="../file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a> files,
|
|
net.playeranalytics.plugin.scheduling.RunnableFactory runnableFactory,
|
|
net.playeranalytics.plugin.server.PluginLogger logger,
|
|
<a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger)</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method.summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#close()">close</a></span>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#downloadDriver()">downloadDriver</a></span>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><?></code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#executeTransaction(com.djrapitops.plan.storage.database.transactions.Transaction)">executeTransaction</a></span>​(<a href="transactions/Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a> transaction)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Execute an SQL Transaction.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.sql/java/sql/Connection.html" title="class or interface in java.sql" class="external-link">Connection</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getConnection()">getConnection</a></span>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> </div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>protected abstract <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getDependencyResource()">getDependencyResource</a></span>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> </div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>net.playeranalytics.plugin.server.PluginLogger</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getLogger()">getLogger</a></span>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>net.playeranalytics.plugin.scheduling.RunnableFactory</code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getRunnableFactory()">getRunnableFactory</a></span>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#getServerUUIDSupplier()">getServerUUIDSupplier</a></span>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>int</code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#hashCode()">hashCode</a></span>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#init()">init</a></span>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Initializes the Database.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><T> T</code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#query(com.djrapitops.plan.storage.database.queries.Query)">query</a></span>​(<a href="queries/Query.html" title="interface in com.djrapitops.plan.storage.database.queries">Query</a><T> query)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table">
|
|
<div class="block">Execute an SQL Query statement to get a result.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract void</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#returnToPool(java.sql.Connection)">returnToPool</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.sql/java/sql/Connection.html" title="class or interface in java.sql" class="external-link">Connection</a> connection)</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> </div>
|
|
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setDownloadDriver(boolean)">setDownloadDriver</a></span>​(boolean downloadDriver)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> </div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setTransactionExecutorServiceProvider(java.util.function.Supplier)">setTransactionExecutorServiceProvider</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a>> transactionExecutorServiceProvider)</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table-tab4 method-summary-table"> </div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>abstract void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#setupDataSource()">setupDataSource</a></span>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
|
|
<div class="block">Set up the source for connections.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods.inherited.from.class.com.djrapitops.plan.storage.database.AbstractDatabase">Methods inherited from class 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></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods.inherited.from.class.com.djrapitops.plan.storage.database.Database">Methods inherited from interface 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></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field.detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="locale">
|
|
<h3>locale</h3>
|
|
<div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a></span> <span class="element-name">locale</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="config">
|
|
<h3>config</h3>
|
|
<div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a></span> <span class="element-name">config</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="files">
|
|
<h3>files</h3>
|
|
<div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a></span> <span class="element-name">files</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="runnableFactory">
|
|
<h3>runnableFactory</h3>
|
|
<div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">net.playeranalytics.plugin.scheduling.RunnableFactory</span> <span class="element-name">runnableFactory</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="logger">
|
|
<h3>logger</h3>
|
|
<div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">net.playeranalytics.plugin.server.PluginLogger</span> <span class="element-name">logger</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="errorLogger">
|
|
<h3>errorLogger</h3>
|
|
<div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a></span> <span class="element-name">errorLogger</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="driverClassLoader">
|
|
<h3>driverClassLoader</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a></span> <span class="element-name">driverClassLoader</span></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor.detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>(java.util.function.Supplier,com.djrapitops.plan.settings.locale.Locale,com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.file.PlanFiles,net.playeranalytics.plugin.scheduling.RunnableFactory,net.playeranalytics.plugin.server.PluginLogger,com.djrapitops.plan.utilities.logging.ErrorLogger)">
|
|
<h3>SQLDB</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">SQLDB</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>> serverUUIDSupplier,
|
|
<a href="../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a> locale,
|
|
<a href="../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a> config,
|
|
<a href="../file/PlanFiles.html" title="class in com.djrapitops.plan.storage.file">PlanFiles</a> files,
|
|
net.playeranalytics.plugin.scheduling.RunnableFactory runnableFactory,
|
|
net.playeranalytics.plugin.server.PluginLogger logger,
|
|
<a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a> errorLogger)</span></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method.detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="setDownloadDriver(boolean)">
|
|
<h3>setDownloadDriver</h3>
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">setDownloadDriver</span>​<span class="parameters">(boolean downloadDriver)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDependencyResource()">
|
|
<h3>getDependencyResource</h3>
|
|
<div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getDependencyResource</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="downloadDriver()">
|
|
<h3>downloadDriver</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">downloadDriver</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="init()">
|
|
<h3>init</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">init</span>()</div>
|
|
<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Database.html#init()">Database</a></code></span></div>
|
|
<div class="block">Initializes the Database.
|
|
<p>
|
|
Queries can be performed after this request has completed all required transactions for the database operations.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setupDataSource()">
|
|
<h3>setupDataSource</h3>
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">setupDataSource</span>()</div>
|
|
<div class="block">Set up the source for connections.</div>
|
|
<dl class="notes">
|
|
<dt>Throws:</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>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="close()">
|
|
<h3>close</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getConnection()">
|
|
<h3>getConnection</h3>
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.sql/java/sql/Connection.html" title="class or interface in java.sql" class="external-link">Connection</a></span> <span class="element-name">getConnection</span>()
|
|
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.sql/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></span></div>
|
|
<dl class="notes">
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.sql/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="returnToPool(java.sql.Connection)">
|
|
<h3>returnToPool</h3>
|
|
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">returnToPool</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.sql/java/sql/Connection.html" title="class or interface in java.sql" class="external-link">Connection</a> connection)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="query(com.djrapitops.plan.storage.database.queries.Query)">
|
|
<h3>query</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">query</span>​<span class="parameters">(<a href="queries/Query.html" title="interface in com.djrapitops.plan.storage.database.queries">Query</a><T> query)</span></div>
|
|
<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Database.html#query(com.djrapitops.plan.storage.database.queries.Query)">Database</a></code></span></div>
|
|
<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 class="notes">
|
|
<dt>Type Parameters:</dt>
|
|
<dd><code>T</code> - Type of the object to be returned.</dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>query</code> - QueryStatement to execute.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Result of the query.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="executeTransaction(com.djrapitops.plan.storage.database.transactions.Transaction)">
|
|
<h3>executeTransaction</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><?></span> <span class="element-name">executeTransaction</span>​<span class="parameters">(<a href="transactions/Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a> transaction)</span></div>
|
|
<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Database.html#executeTransaction(com.djrapitops.plan.storage.database.transactions.Transaction)">Database</a></code></span></div>
|
|
<div class="block">Execute an SQL Transaction.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>transaction</code> - Transaction to execute.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Future that is finished when the transaction has been executed.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="equals(java.lang.Object)">
|
|
<h3>equals</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</span></div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hashCode()">
|
|
<h3>hashCode</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getServerUUIDSupplier()">
|
|
<h3>getServerUUIDSupplier</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="../../identification/ServerUUID.html" title="class in com.djrapitops.plan.identification">ServerUUID</a>></span> <span class="element-name">getServerUUIDSupplier</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setTransactionExecutorServiceProvider(java.util.function.Supplier)">
|
|
<h3>setTransactionExecutorServiceProvider</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTransactionExecutorServiceProvider</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a>> transactionExecutorServiceProvider)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getRunnableFactory()">
|
|
<h3>getRunnableFactory</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">net.playeranalytics.plugin.scheduling.RunnableFactory</span> <span class="element-name">getRunnableFactory</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLogger()">
|
|
<h3>getLogger</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">net.playeranalytics.plugin.server.PluginLogger</span> <span class="element-name">getLogger</span>()</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|