<!DOCTYPE HTML> <html lang="en"> <head> <!-- Generated by javadoc (17) --> <title>QueryService (Plan 5.5-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.query, interface: QueryService"> <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#class">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>Field | </li> <li>Constr | </li> <li><a href="#method-summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method-detail">Method</a></li> </ul> </div> <div class="nav-list-search"><label for="search-input">SEARCH:</label> <input type="text" id="search-input" value="search" disabled="disabled"> <input type="reset" id="reset-button" 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.query</a></div> <h1 title="Interface QueryService" class="title">Interface QueryService</h1> </div> <section class="class-description" id="class-description"> <dl class="notes"> <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> <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QueryService</span></div> <div class="block">Service for Query API. <p> Requires Capability QUERY_API</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="caption"><span>Nested Classes</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">Interface</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color"><code>static class </code></div> <div class="col-second even-row-color"><code><a href="QueryService.Holder.html" class="type-name-link" title="class in com.djrapitops.plan.query">QueryService.Holder</a></code></div> <div class="col-last even-row-color"> </div> <div class="col-first odd-row-color"><code>static interface </code></div> <div class="col-second odd-row-color"><code><a href="QueryService.ThrowingConsumer.html" class="type-name-link" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a><<a href="QueryService.ThrowingConsumer.html" title="type parameter in QueryService.ThrowingConsumer">T</a>></code></div> <div class="col-last odd-row-color"> <div class="block">See https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html</div> </div> <div class="col-first even-row-color"><code>static interface </code></div> <div class="col-second even-row-color"><code><a href="QueryService.ThrowingFunction.html" class="type-name-link" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a><<a href="QueryService.ThrowingFunction.html" title="type parameter in QueryService.ThrowingFunction">T</a>,<wbr><a href="QueryService.ThrowingFunction.html" title="type parameter in QueryService.ThrowingFunction">R</a>></code></div> <div class="col-last even-row-color"> <div class="block">See https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html</div> </div> <div class="col-first odd-row-color"><code>static interface </code></div> <div class="col-second odd-row-color"><code><a href="QueryService.VoidFunction.html" class="type-name-link" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a></code></div> <div class="col-last odd-row-color"> <div class="block">See https://docs.oracle.com/javase/8/docs/api/java/util/function/package-summary.html</div> </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></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 method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)" class="member-name-link">execute</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sql, <a href="QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/PreparedStatement.html" title="class or interface in java.sql" class="external-link">PreparedStatement</a>> performStatement)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Execute SQL against Plan database.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query">CommonQueries</a></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCommonQueries()" class="member-name-link">getCommonQueries</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Perform some commonly wanted queries.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDBType()" class="member-name-link">getDBType</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Get what kind of database is in use.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#getInstance()" class="member-name-link">getInstance</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> <div class="block">Obtain instance of QueryService.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getServerUUID()" class="member-name-link">getServerUUID</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Get the UUID of this server.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> T</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)" class="member-name-link">query</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sql, <a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/PreparedStatement.html" title="class or interface in java.sql" class="external-link">PreparedStatement</a>,<wbr>T> performQuery)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Perform a query against Plan database.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)" class="member-name-link">subscribeDataClearEvent</a><wbr>(<a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a> eventListener)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Used for getting notified about removal of ALL data.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#subscribeToPlayerRemoveEvent(java.util.function.Consumer)" class="member-name-link">subscribeToPlayerRemoveEvent</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>> eventListener)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Used for getting notified about removal of player data.</div> </div> </div> </div> </div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ============ METHOD DETAIL ========== --> <li> <section class="method-details" id="method-detail"> <h2>Method Details</h2> <ul class="member-list"> <li> <section class="detail" id="getInstance()"> <h3>getInstance</h3> <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="QueryService.html" title="interface in com.djrapitops.plan.query">QueryService</a></span> <span class="element-name">getInstance</span>()</div> <div class="block">Obtain instance of QueryService.</div> <dl class="notes"> <dt>Returns:</dt> <dd>QueryService implementation.</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NoClassDefFoundError.html" title="class or interface in java.lang" class="external-link">NoClassDefFoundError</a></code> - If Plan is not installed and this class can not be found or if older Plan version is installed.</dd> <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - If Plan is installed, but not enabled.</dd> </dl> </section> </li> <li> <section class="detail" id="getDBType()"> <h3>getDBType</h3> <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/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">getDBType</span>()</div> <div class="block">Get what kind of database is in use.</div> <dl class="notes"> <dt>Returns:</dt> <dd>SQLITE or MYSQL</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - If database has not been initialized (Plugin failed to enable)</dd> </dl> </section> </li> <li> <section class="detail" id="query(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingFunction)"> <h3>query</h3> <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">query</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sql, <a href="QueryService.ThrowingFunction.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingFunction</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/PreparedStatement.html" title="class or interface in java.sql" class="external-link">PreparedStatement</a>,<wbr>T> performQuery)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> <div class="block">Perform a query against Plan database. <p> Blocks thread until query is complete.</div> <dl class="notes"> <dt>Type Parameters:</dt> <dd><code>T</code> - Type of results.</dd> <dt>Parameters:</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>Returns:</dt> <dd>The object returned by <code>results</code>.</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - If something goes wrong with the query. SQLException might be as cause.</dd> </dl> </section> </li> <li> <section class="detail" id="execute(java.lang.String,com.djrapitops.plan.query.QueryService.ThrowingConsumer)"> <h3>execute</h3> <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/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">execute</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sql, <a href="QueryService.ThrowingConsumer.html" title="interface in com.djrapitops.plan.query">QueryService.ThrowingConsumer</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/PreparedStatement.html" title="class or interface in java.sql" class="external-link">PreparedStatement</a>> performStatement)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> <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 class="notes"> <dt>Parameters:</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>Returns:</dt> <dd>A Future that tells when the transaction has completed. Blocks thread if Future#get is called.</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - If something goes wrong with the query. SQLException might be as cause.</dd> </dl> </section> </li> <li> <section class="detail" id="subscribeToPlayerRemoveEvent(java.util.function.Consumer)"> <h3>subscribeToPlayerRemoveEvent</h3> <div class="member-signature"><span class="return-type">void</span> <span class="element-name">subscribeToPlayerRemoveEvent</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>> eventListener)</span></div> <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 -> { do stuff })</code></div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>eventListener</code> - Functional interface that is called on the event.</dd> </dl> </section> </li> <li> <section class="detail" id="subscribeDataClearEvent(com.djrapitops.plan.query.QueryService.VoidFunction)"> <h3>subscribeDataClearEvent</h3> <div class="member-signature"><span class="return-type">void</span> <span class="element-name">subscribeDataClearEvent</span><wbr><span class="parameters">(<a href="QueryService.VoidFunction.html" title="interface in com.djrapitops.plan.query">QueryService.VoidFunction</a> eventListener)</span></div> <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(() -> { do stuff })</code></div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>eventListener</code> - Functional interface that is called on the event.</dd> </dl> </section> </li> <li> <section class="detail" id="getServerUUID()"> <h3>getServerUUID</h3> <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a>></span> <span class="element-name">getServerUUID</span>()</div> <div class="block">Get the UUID of this server.</div> <dl class="notes"> <dt>Returns:</dt> <dd>Optional of the server UUID, empty if server did not start properly.</dd> </dl> </section> </li> <li> <section class="detail" id="getCommonQueries()"> <h3>getCommonQueries</h3> <div class="member-signature"><span class="return-type"><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query">CommonQueries</a></span> <span class="element-name">getCommonQueries</span>()</div> <div class="block">Perform some commonly wanted queries.</div> <dl class="notes"> <dt>Returns:</dt> <dd><a href="CommonQueries.html" title="interface in com.djrapitops.plan.query"><code>CommonQueries</code></a> implementation.</dd> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - If database has not been initialized (Plugin failed to enable)</dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>