Plan/all/com/djrapitops/plan/query/QueryService.html

494 lines
20 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>QueryService (Plan 5.4-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<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>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="QueryService (Plan 5.4-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":1,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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="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>
</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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.query</a></div>
<h2 title="Interface QueryService" class="title">Interface QueryService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="QuerySvc.html" title="class in com.djrapitops.plan.query">QuerySvc</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">QueryService</span></pre>
<div class="block">Service for Query API.
<p>
Requires Capability QUERY_API</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="QueryService.Holder.html" title="class in com.djrapitops.plan.query">QueryService.Holder</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a>&lt;<a href="QueryService.ThrowingConsumer.html" title="type parameter in QueryService.ThrowingConsumer">T</a>&gt;</span></code></th>
<td class="colLast">
<div class="block">See https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a>&lt;<a href="QueryService.ThrowingFunction.html" title="type parameter in QueryService.ThrowingFunction">T</a>,&#8203;<a href="QueryService.ThrowingFunction.html" title="type parameter in QueryService.ThrowingFunction">R</a>&gt;</span></code></th>
<td class="colLast">
<div class="block">See https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a></span></code></th>
<td class="colLast">
<div class="block">See https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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></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>
</tr>
<tr id="i0" 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="#execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)">execute</a></span>&#8203;(java.lang.String&nbsp;sql,
<a href="QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a>&lt;java.sql.PreparedStatement&gt;&nbsp;performStatement)</code></th>
<td class="colLast">
<div class="block">Execute SQL against Plan database.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query">CommonQueries</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCommonQueries()">getCommonQueries</a></span>()</code></th>
<td class="colLast">
<div class="block">Perform some commonly wanted queries.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDBType()">getDBType</a></span>()</code></th>
<td class="colLast">
<div class="block">Get what kind of database is in use.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance()">getInstance</a></span>()</code></th>
<td class="colLast">
<div class="block">Obtain instance of QueryService.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Optional&lt;java.util.UUID&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServerUUID()">getServerUUID</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the UUID of this server.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)">query</a></span>&#8203;(java.lang.String&nbsp;sql,
<a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a>&lt;java.sql.PreparedStatement,&#8203;T&gt;&nbsp;performQuery)</code></th>
<td class="colLast">
<div class="block">Perform a query against Plan database.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)">subscribeDataClearEvent</a></span>&#8203;(<a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a>&nbsp;eventListener)</code></th>
<td class="colLast">
<div class="block">Used for getting notified about removal of ALL data.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subscribeToPlayerRemoveEvent(java.util.function.Consumer)">subscribeToPlayerRemoveEvent</a></span>&#8203;(java.util.function.Consumer&lt;java.util.UUID&gt;&nbsp;eventListener)</code></th>
<td class="colLast">
<div class="block">Used for getting notified about removal of player data.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getInstance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre class="methodSignature">static&nbsp;<a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a>&nbsp;getInstance()</pre>
<div class="block">Obtain instance of QueryService.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>QueryService implementation.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NoClassDefFoundError</code> - If Plan is not installed and this class can not be found or if older Plan version is installed.</dd>
<dd><code>java.lang.IllegalStateException</code> - If Plan is installed, but not enabled.</dd>
</dl>
</li>
</ul>
<a id="getDBType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDBType</h4>
<pre class="methodSignature">java.lang.String&nbsp;getDBType()</pre>
<div class="block">Get what kind of database is in use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SQLITE or MYSQL</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If database has not been initialized (Plugin failed to enable)</dd>
</dl>
</li>
</ul>
<a id="query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre class="methodSignature">&lt;T&gt;&nbsp;T&nbsp;query&#8203;(java.lang.String&nbsp;sql,
<a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a>&lt;java.sql.PreparedStatement,&#8203;T&gt;&nbsp;performQuery)
throws java.lang.IllegalStateException</pre>
<div class="block">Perform a query against Plan database.
<p>
Blocks thread until query is complete.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Type of results.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sql</code> - SQL String to execute, can contain parameterized queries (<code>?</code>).</dd>
<dd><code>performQuery</code> - set your parameters to the PreparedStatement and execute the query, return results.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The object returned by <code>results</code>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If something goes wrong with the query. SQLException might be as cause.</dd>
</dl>
</li>
</ul>
<a id="execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature">java.util.concurrent.Future&lt;?&gt;&nbsp;execute&#8203;(java.lang.String&nbsp;sql,
<a href="QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a>&lt;java.sql.PreparedStatement&gt;&nbsp;performStatement)
throws java.lang.IllegalStateException</pre>
<div class="block">Execute SQL against Plan database.
<p>
Does not block thread, SQL is executed in a single transaction to the database.
<p>
Differs from <a href="#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)"><code>query(String, ThrowingFunction)</code></a> in that no results are returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sql</code> - SQL String to execute, can contain parameterized queries (<code>?</code>).</dd>
<dd><code>performStatement</code> - set your parameters to the PreparedStatement and execute the statement.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A Future that tells when the transaction has completed. Blocks thread if Future#get is called.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If something goes wrong with the query. SQLException might be as cause.</dd>
</dl>
</li>
</ul>
<a id="subscribeToPlayerRemoveEvent(java.util.function.Consumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subscribeToPlayerRemoveEvent</h4>
<pre class="methodSignature">void&nbsp;subscribeToPlayerRemoveEvent&#8203;(java.util.function.Consumer&lt;java.util.UUID&gt;&nbsp;eventListener)</pre>
<div class="block">Used for getting notified about removal of player data.
<p>
SQL for removing this player's data should be executed when this occurs.
<p>
Example usage:
<code>subscribeToPlayerRemoveEvent(playerUUID -&gt; { do stuff })</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>eventListener</code> - Functional interface that is called on the event.</dd>
</dl>
</li>
</ul>
<a id="subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subscribeDataClearEvent</h4>
<pre class="methodSignature">void&nbsp;subscribeDataClearEvent&#8203;(<a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a>&nbsp;eventListener)</pre>
<div class="block">Used for getting notified about removal of ALL data.
<p>
SQL for removing all extra tables (and data) should be performed
<p>
Example usage:
<code>subscribeDataClearEvent(() -&gt; { do stuff })</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>eventListener</code> - Functional interface that is called on the event.</dd>
</dl>
</li>
</ul>
<a id="getServerUUID()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerUUID</h4>
<pre class="methodSignature">java.util.Optional&lt;java.util.UUID&gt;&nbsp;getServerUUID()</pre>
<div class="block">Get the UUID of this server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Optional of the server UUID, empty if server did not start properly.</dd>
</dl>
</li>
</ul>
<a id="getCommonQueries()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCommonQueries</h4>
<pre class="methodSignature"><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query">CommonQueries</a>&nbsp;getCommonQueries()</pre>
<div class="block">Perform some commonly wanted queries.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query"><code>CommonQueries</code></a> implementation.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - If database has not been initialized (Plugin failed to enable)</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>