Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-12-30 21:17:49 +01:00
Code Issues Projects Releases Wiki Activity
8e35fe2fe5
Plan/api/com/djrapitops/plan/query/QueryService.html

448 lines
20 KiB
HTML
Raw Normal View History

Updated javadocs
2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
Updated javadocs
2019-08-09 09:23:33 +02:00
<!-- Generated by javadoc (1.8.0_201) on Fri Aug 09 10:21:05 EEST 2019 -->
<title>QueryService (api 4.9.2 API)</title>
<meta name="date" content="2019-08-09">
Updated javadocs
2019-08-05 11:13:19 +02:00
<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) {
Updated javadocs
2019-08-09 09:23:33 +02:00
parent.document.title="QueryService (api 4.9.2 API)";
Updated javadocs
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":17,"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"],16:["t5","Default 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="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="../../../../com/djrapitops/plan/query/CommonQueries.html" title="interface in com.djrapitops.plan.query"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/query/QueryService.QueryServiceHolder.html" title="class in com.djrapitops.plan.query"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/query/QueryService.html" target="_top">Frames</a></li>
<li><a href="QueryService.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><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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.djrapitops.plan.query</div>
<h2 title="Interface QueryService" class="title">Interface QueryService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<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 ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.QueryServiceHolder.html" title="class in com.djrapitops.plan.query">QueryService.QueryServiceHolder</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a>&lt;<a href="../../../../com/djrapitops/plan/query/QueryService.ThrowingConsumer.html" title="type parameter in QueryService.ThrowingConsumer">T</a>&gt;</span></code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a>&lt;<a href="../../../../com/djrapitops/plan/query/QueryService.ThrowingFunction.html" title="type parameter in QueryService.ThrowingFunction">T</a>,<a href="../../../../com/djrapitops/plan/query/QueryService.ThrowingFunction.html" title="type parameter in QueryService.ThrowingFunction">R</a>&gt;</span></code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a></span></code>
<div class="block">See https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html</div>
</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="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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>java.util.concurrent.Future&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.html#execute-java.lang.String-com.djrapitops.plan.query.QueryService.ThrowingConsumer-">execute</a></span>(java.lang.String&nbsp;sql,
<a href="../../../../com/djrapitops/plan/query/QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a>&lt;java.sql.PreparedStatement&gt;&nbsp;performStatement)</code>
<div class="block">Execute SQL against Plan database.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/djrapitops/plan/query/CommonQueries.html" title="interface in com.djrapitops.plan.query">CommonQueries</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.html#getCommonQueries--">getCommonQueries</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.html#getDBType--">getDBType</a></span>()</code>
<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="../../../../com/djrapitops/plan/query/QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.html#getInstance--">getInstance</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.html#getServerUUID--">getServerUUID</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.html#query-java.lang.String-com.djrapitops.plan.query.QueryService.ThrowingFunction-">query</a></span>(java.lang.String&nbsp;sql,
<a href="../../../../com/djrapitops/plan/query/QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a>&lt;java.sql.PreparedStatement,T&gt;&nbsp;performQuery)</code>
<div class="block">Perform a query against Plan database.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.html#subscribeDataClearEvent-com.djrapitops.plan.query.QueryService.VoidFunction-">subscribeDataClearEvent</a></span>(<a href="../../../../com/djrapitops/plan/query/QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a>&nbsp;eventListener)</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/djrapitops/plan/query/QueryService.html#subscribeToPlayerRemoveEvent-java.util.function.Consumer-">subscribeToPlayerRemoveEvent</a></span>(java.util.function.Consumer&lt;java.util.UUID&gt;&nbsp;eventListener)</code>
<div class="block">Used for getting notified about removal of player data.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>static&nbsp;<a href="../../../../com/djrapitops/plan/query/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 name="getDBType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDBType</h4>
<pre>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>H2, 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 name="query-java.lang.String-com.djrapitops.plan.query.QueryService.ThrowingFunction-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre>&lt;T&gt;&nbsp;T&nbsp;query(java.lang.String&nbsp;sql,
<a href="../../../../com/djrapitops/plan/query/QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a>&lt;java.sql.PreparedStatement,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 name="execute-java.lang.String-com.djrapitops.plan.query.QueryService.ThrowingConsumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>java.util.concurrent.Future&lt;?&gt;&nbsp;execute(java.lang.String&nbsp;sql,
<a href="../../../../com/djrapitops/plan/query/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="../../../../com/djrapitops/plan/query/QueryService.html#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 name="subscribeToPlayerRemoveEvent-java.util.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subscribeToPlayerRemoveEvent</h4>
<pre>void&nbsp;subscribeToPlayerRemoveEvent(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 name="subscribeDataClearEvent-com.djrapitops.plan.query.QueryService.VoidFunction-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subscribeDataClearEvent</h4>
<pre>void&nbsp;subscribeDataClearEvent(<a href="../../../../com/djrapitops/plan/query/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 name="getServerUUID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerUUID</h4>
<pre>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>Optinal of the server UUID, empty if server did not start properly.</dd>
</dl>
</li>
</ul>
<a name="getCommonQueries--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCommonQueries</h4>
<pre><a href="../../../../com/djrapitops/plan/query/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="../../../../com/djrapitops/plan/query/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>
</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="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="../../../../com/djrapitops/plan/query/CommonQueries.html" title="interface in com.djrapitops.plan.query"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/djrapitops/plan/query/QueryService.QueryServiceHolder.html" title="class in com.djrapitops.plan.query"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/djrapitops/plan/query/QueryService.html" target="_top">Frames</a></li>
<li><a href="QueryService.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><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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink