Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-10-31 16:01:00 +01:00
Code Issues Projects Releases Wiki Activity
70e83a12b4
Plan/docs/main/java/com/djrapitops/plan/database/databases/SQLDB.html
Rsl1122 2d77fe720b Updated Javadoc docs folder
2017-10-02 21:52:57 +03:00

689 lines
40 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
<!-- Generated by javadoc (1.8.0_112) on Mon Oct 02 21:49:46 EEST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SQLDB (Plan 4.0.0 API)</title>
<meta name="date" content="2017-10-02">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SQLDB (Plan 4.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":6,"i16":10,"i17":10};
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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SQLDB.html">Use</a></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="subNav">
<ul class="navList">
<li><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/MySQLDB.html" title="class in main.java.com.djrapitops.plan.database.databases"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLiteDB.html" title="class in main.java.com.djrapitops.plan.database.databases"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?main/java/com/djrapitops/plan/database/databases/SQLDB.html" target="_top">Frames</a></li>
<li><a href="SQLDB.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.main.java.com.djrapitops.plan.database.Database">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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">main.java.com.djrapitops.plan.database.databases</div>
<h2 title="Class SQLDB" class="title">Class SQLDB</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">main.java.com.djrapitops.plan.database.Database</a></li>
<li>
<ul class="inheritance">
<li>main.java.com.djrapitops.plan.database.databases.SQLDB</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/MySQLDB.html" title="class in main.java.com.djrapitops.plan.database.databases">MySQLDB</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLiteDB.html" title="class in main.java.com.djrapitops.plan.database.databases">SQLiteDB</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">SQLDB</span>
extends <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></pre>
<div class="block">Class containing main logic for different data related save and load functionality.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Rsl1122</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.main.java.com.djrapitops.plan.database.Database">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;main.java.com.djrapitops.plan.database.<a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></h3>
<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#actionsTable">actionsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#commandUseTable">commandUseTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#dataSource">dataSource</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#ipsTable">ipsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#killsTable">killsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#nicknamesTable">nicknamesTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#plugin">plugin</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#securityTable">securityTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#serverTable">serverTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#sessionsTable">sessionsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#tpsTable">tpsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#userInfoTable">userInfoTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#usersTable">usersTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#versionTable">versionTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#worldTable">worldTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#worldTimesTable">worldTimesTable</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#SQLDB-main.java.com.djrapitops.plan.api.IPlan-">SQLDB</a></span>(<a href="../../../../../../../main/java/com/djrapitops/plan/api/IPlan.html" title="interface in main.java.com.djrapitops.plan.api">IPlan</a>&nbsp;plugin)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#close--">close</a></span>()</code>
<div class="block">Closes the SQLDB</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#commit-java.sql.Connection-">commit</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a>&nbsp;connection)</code>
<div class="block">Commits changes to the .db file when using SQLite Database.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/tables/Table.html" title="class in main.java.com.djrapitops.plan.database.tables">Table</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#getAllTables--">getAllTables</a></span>()</code>
<div class="block">Get all tables in a good order.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/tables/Table.html" title="class in main.java.com.djrapitops.plan.database.tables">Table</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#getAllTablesInRemoveOrder--">getAllTablesInRemoveOrder</a></span>()</code>
<div class="block">Get all tables for removal of data.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#getConnection--">getConnection</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#getVersion--">getVersion</a></span>()</code>
<div class="block">Used to get the database schema version.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#init--">init</a></span>()</code>
<div class="block">Initializes the Database.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#isNewDatabase--">isNewDatabase</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#isOpen--">isOpen</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#removeAccount-java.util.UUID-">removeAccount</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)</code>
<div class="block">Removes all data related to an account from the database.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#removeAllData--">removeAllData</a></span>()</code>
<div class="block">Used to clear all data from the database.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#rollback-java.sql.Connection-">rollback</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a>&nbsp;connection)</code>
<div class="block">Reverts transaction when using SQLite Database.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#scheduleClean-long-">scheduleClean</a></span>(long&nbsp;secondsDelay)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#setAvailable--">setAvailable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#setupDatabase--">setupDatabase</a></span>()</code>
<div class="block">Ensures connection functions correctly and all tables exist.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#setupDataSource--">setupDataSource</a></span>()</code>
<div class="block">Setups the <code>BasicDataSource</code></div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#setVersion-int-">setVersion</a></span>(int&nbsp;version)</code>
<div class="block">Used to set the database schema version.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLDB.html#wasSeenBefore-java.util.UUID-">wasSeenBefore</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)</code>
<div class="block">Check if the user is saved in the database.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.main.java.com.djrapitops.plan.database.Database">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;main.java.com.djrapitops.plan.database.<a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></h3>
<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getActionsTable--">getActionsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getCommandUse--">getCommandUse</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getCommandUseTable--">getCommandUseTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getConfigName--">getConfigName</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getDataSource--">getDataSource</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getIpsTable--">getIpsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getKillsTable--">getKillsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getName--">getName</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getNicknamesTable--">getNicknamesTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getSavedUUIDs--">getSavedUUIDs</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getSecurityTable--">getSecurityTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getServerTable--">getServerTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getSessionsTable--">getSessionsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getTpsTable--">getTpsTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getUserInfoTable--">getUserInfoTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getUsersTable--">getUsersTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getWorldTable--">getWorldTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getWorldTimesTable--">getWorldTimesTable</a>, <a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#isUsingMySQL--">isUsingMySQL</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SQLDB-main.java.com.djrapitops.plan.api.IPlan-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SQLDB</h4>
<pre>public&nbsp;SQLDB(<a href="../../../../../../../main/java/com/djrapitops/plan/api/IPlan.html" title="interface in main.java.com.djrapitops.plan.api">IPlan</a>&nbsp;plugin)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init()
throws <a href="../../../../../../../main/java/com/djrapitops/plan/api/exceptions/DatabaseInitException.html" title="class in main.java.com.djrapitops.plan.api.exceptions">DatabaseInitException</a></pre>
<div class="block">Initializes the Database.
<p>
All tables exist in the database after call to this.
Updates Schema to latest version.
Converts Unsaved Bukkit player files to database data.
Cleans the database.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#init--">init</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/api/exceptions/DatabaseInitException.html" title="class in main.java.com.djrapitops.plan.api.exceptions">DatabaseInitException</a></code> - if Database fails to initiate.</dd>
</dl>
</li>
</ul>
<a name="scheduleClean-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleClean</h4>
<pre>public&nbsp;void&nbsp;scheduleClean(long&nbsp;secondsDelay)</pre>
</li>
</ul>
<a name="setupDatabase--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupDatabase</h4>
<pre>public&nbsp;void&nbsp;setupDatabase()
throws <a href="../../../../../../../main/java/com/djrapitops/plan/api/exceptions/DatabaseInitException.html" title="class in main.java.com.djrapitops.plan.api.exceptions">DatabaseInitException</a></pre>
<div class="block">Ensures connection functions correctly and all tables exist.
<p>
Updates to latest schema.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/api/exceptions/DatabaseInitException.html" title="class in main.java.com.djrapitops.plan.api.exceptions">DatabaseInitException</a></code> - if something goes wrong.</dd>
</dl>
</li>
</ul>
<a name="getAllTables--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllTables</h4>
<pre>public&nbsp;<a href="../../../../../../../main/java/com/djrapitops/plan/database/tables/Table.html" title="class in main.java.com.djrapitops.plan.database.tables">Table</a>[]&nbsp;getAllTables()</pre>
<div class="block">Get all tables in a good order.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Table array.</dd>
</dl>
</li>
</ul>
<a name="getAllTablesInRemoveOrder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllTablesInRemoveOrder</h4>
<pre>public&nbsp;<a href="../../../../../../../main/java/com/djrapitops/plan/database/tables/Table.html" title="class in main.java.com.djrapitops.plan.database.tables">Table</a>[]&nbsp;getAllTablesInRemoveOrder()</pre>
<div class="block">Get all tables for removal of data.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Tables in the order the data should be removed in.</dd>
</dl>
</li>
</ul>
<a name="setupDataSource--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupDataSource</h4>
<pre>public abstract&nbsp;void&nbsp;setupDataSource()
throws <a href="../../../../../../../main/java/com/djrapitops/plan/api/exceptions/DatabaseInitException.html" title="class in main.java.com.djrapitops.plan.api.exceptions">DatabaseInitException</a></pre>
<div class="block">Setups the <code>BasicDataSource</code></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/api/exceptions/DatabaseInitException.html" title="class in main.java.com.djrapitops.plan.api.exceptions">DatabaseInitException</a></code></dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Closes the SQLDB</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#close--">close</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - DB Error</dd>
</dl>
</li>
</ul>
<a name="getVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre>public&nbsp;int&nbsp;getVersion()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getVersion--">Database</a></code></span></div>
<div class="block">Used to get the database schema version.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#getVersion--">getVersion</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>@throws SQLException</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - If a database error occurs.</dd>
</dl>
</li>
</ul>
<a name="setVersion-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVersion</h4>
<pre>public&nbsp;void&nbsp;setVersion(int&nbsp;version)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#setVersion-int-">Database</a></code></span></div>
<div class="block">Used to set the database schema version.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#setVersion-int-">setVersion</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>version</code> - Integer starting from 0, incremented by one when schema is
updated.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - If a database error occurs.</dd>
</dl>
</li>
</ul>
<a name="isNewDatabase--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewDatabase</h4>
<pre>public&nbsp;boolean&nbsp;isNewDatabase()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#isNewDatabase--">isNewDatabase</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd>
</dl>
</li>
</ul>
<a name="wasSeenBefore-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wasSeenBefore</h4>
<pre>public&nbsp;boolean&nbsp;wasSeenBefore(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#wasSeenBefore-java.util.UUID-">Database</a></code></span></div>
<div class="block">Check if the user is saved in the database.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#wasSeenBefore-java.util.UUID-">wasSeenBefore</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - UUID of the user.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true/false</dd>
</dl>
</li>
</ul>
<a name="removeAccount-java.util.UUID-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAccount</h4>
<pre>public&nbsp;void&nbsp;removeAccount(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a>&nbsp;uuid)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#removeAccount-java.util.UUID-">Database</a></code></span></div>
<div class="block">Removes all data related to an account from the database.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#removeAccount-java.util.UUID-">removeAccount</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uuid</code> - UUID of the account.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - If a database error occurs.</dd>
</dl>
</li>
</ul>
<a name="removeAllData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAllData</h4>
<pre>public&nbsp;void&nbsp;removeAllData()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#removeAllData--">Database</a></code></span></div>
<div class="block">Used to clear all data from the database.
<p>
Uses DELETE * FROM table.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#removeAllData--">removeAllData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code> - if remove fails.</dd>
</dl>
</li>
</ul>
<a name="setAvailable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAvailable</h4>
<pre>public&nbsp;void&nbsp;setAvailable()</pre>
</li>
</ul>
<a name="getConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a>&nbsp;getConnection()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd>
</dl>
</li>
</ul>
<a name="commit-java.sql.Connection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commit</h4>
<pre>public&nbsp;void&nbsp;commit(<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a>&nbsp;connection)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Commits changes to the .db file when using SQLite Database.
<p>
MySQL has Auto Commit enabled.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html#commit-java.sql.Connection-">commit</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd>
</dl>
</li>
</ul>
<a name="rollback-java.sql.Connection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rollback</h4>
<pre>public&nbsp;void&nbsp;rollback(<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a>&nbsp;connection)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Reverts transaction when using SQLite Database.
<p>
MySQL has Auto Commit enabled.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd>
</dl>
</li>
</ul>
<a name="isOpen--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isOpen</h4>
<pre>public&nbsp;boolean&nbsp;isOpen()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SQLDB.html">Use</a></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="subNav">
<ul class="navList">
<li><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/MySQLDB.html" title="class in main.java.com.djrapitops.plan.database.databases"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../main/java/com/djrapitops/plan/database/databases/SQLiteDB.html" title="class in main.java.com.djrapitops.plan.database.databases"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?main/java/com/djrapitops/plan/database/databases/SQLDB.html" target="_top">Frames</a></li>
<li><a href="SQLDB.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.main.java.com.djrapitops.plan.database.Database">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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink