Plan/all/com/djrapitops/plan/storage/database/Database.html

342 lines
30 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
<html lang="en">
2019-08-05 11:13:19 +02:00
<head>
<!-- Generated by javadoc (17) -->
<title>Database (Plan 5.4-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.djrapitops.plan.storage.database, interface: Database">
<meta name="generator" content="javadoc/ClassWriterImpl">
2019-10-05 10:27:37 +02:00
<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">
2019-10-05 10:27:37 +02:00
<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>
2019-08-05 11:13:19 +02:00
</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>
2019-08-05 11:13:19 +02:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
2019-08-05 11:13:19 +02:00
<!-- ========= 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>
2019-08-05 11:13:19 +02:00
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
2019-08-05 11:13:19 +02:00
<li><a href="package-tree.html">Tree</a></li>
2019-10-05 10:27:37 +02:00
<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>
2019-08-05 11:13:19 +02:00
</ul>
</div>
<div class="sub-nav">
2019-08-05 11:13:19 +02:00
<div>
<ul class="sub-nav-list">
2019-08-05 11:13:19 +02:00
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
2019-08-05 11:13:19 +02:00
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="sub-nav-list">
2019-08-05 11:13:19 +02:00
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
2019-08-05 11:13:19 +02:00
</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 ======== -->
2019-08-05 11:13:19 +02:00
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.storage.database</a></div>
<h1 title="Interface Database" class="title">Interface Database</h1>
2019-08-05 11:13:19 +02:00
</div>
<section class="class-description" id="class-description">
<dl class="notes">
2019-08-05 11:13:19 +02:00
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AbstractDatabase.html" title="class in com.djrapitops.plan.storage.database">AbstractDatabase</a></code>, <code><a href="MySQLDB.html" title="class in com.djrapitops.plan.storage.database">MySQLDB</a></code>, <code><a href="SQLDB.html" title="class in com.djrapitops.plan.storage.database">SQLDB</a></code>, <code><a href="SQLiteDB.html" title="class in com.djrapitops.plan.storage.database">SQLiteDB</a></code></dd>
2019-08-05 11:13:19 +02:00
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Database</span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Interface for interacting with a Plan SQL database.</div>
</section>
<section class="summary">
<ul class="summary-list">
2019-08-05 11:13:19 +02:00
<!-- ======== 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 enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Database.State.html" class="type-name-link" title="enum class in com.djrapitops.plan.storage.database">Database.State</a></code></div>
<div class="col-last even-row-color">
2019-10-05 10:27:37 +02:00
<div class="block">Possible State changes:
CLOSED to PATCHING (Database init),
PATCHING to OPEN (Database initialized),
OPEN to CLOSING (Database closing),
CLOSING to CLOSED (Database closed),
PATCHING to CLOSED (Database closed prematurely)</div>
</div>
</div>
</section>
</li>
2019-08-05 11:13:19 +02:00
<!-- ========== 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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-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/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;?&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#executeTransaction(com.djrapitops.plan.storage.database.transactions.Transaction)" class="member-name-link">executeTransaction</a><wbr>(<a href="transactions/Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a>&nbsp;transaction)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
2019-08-05 11:13:19 +02:00
<div class="block">Execute an SQL Transaction.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="sql/building/Sql.html" title="class in com.djrapitops.plan.storage.database.sql.building">Sql</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getSql()" class="member-name-link">getSql</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Database.State.html" title="enum class in com.djrapitops.plan.storage.database">Database.State</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DBType.html" title="enum class in com.djrapitops.plan.storage.database">DBType</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getType()" class="member-name-link">getType</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
2019-08-05 11:13:19 +02:00
<div class="block">Used to get the <code>DBType</code> of the Database</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="#init()" class="member-name-link">init</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
2019-08-05 11:13:19 +02:00
<div class="block">Initializes the Database.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>&lt;T&gt;&nbsp;T</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#query(com.djrapitops.plan.storage.database.queries.Query)" class="member-name-link">query</a><wbr>(<a href="queries/Query.html" title="interface in com.djrapitops.plan.storage.database.queries">Query</a>&lt;T&gt;&nbsp;query)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
2019-08-05 11:13:19 +02:00
<div class="block">Execute an SQL Query statement to get a result.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default &lt;C extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;T&gt;,<wbr>
T&gt;<br>C</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#queryCollection(java.lang.String,com.djrapitops.plan.storage.database.queries.RowExtractor,java.util.function.Supplier,java.lang.Object...)" class="member-name-link">queryCollection</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>&nbsp;sql,
<a href="queries/RowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">RowExtractor</a>&lt;T&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;C&gt;&nbsp;collectionConstructor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default &lt;T&gt;&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;T&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#queryList(java.lang.String,com.djrapitops.plan.storage.database.queries.RowExtractor,java.lang.Object...)" class="member-name-link">queryList</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>&nbsp;sql,
<a href="queries/RowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">RowExtractor</a>&lt;T&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default &lt;K,<wbr>
V&gt;&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;K,<wbr>V&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#queryMap(java.lang.String,com.djrapitops.plan.storage.database.queries.MapRowExtractor,java.lang.Object...)" class="member-name-link">queryMap</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>&nbsp;sql,
<a href="queries/MapRowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">MapRowExtractor</a>&lt;K,<wbr>V&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default &lt;M extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;K,<wbr>
V&gt;,<wbr>
K,<wbr>
V&gt;<br>M</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#queryMap(java.lang.String,com.djrapitops.plan.storage.database.queries.MapRowExtractor,java.util.function.Supplier,java.lang.Object...)" class="member-name-link">queryMap</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>&nbsp;sql,
<a href="queries/MapRowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">MapRowExtractor</a>&lt;K,<wbr>V&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;M&gt;&nbsp;mapConstructor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default &lt;T&gt;&nbsp;<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>&lt;T&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#queryOptional(java.lang.String,com.djrapitops.plan.storage.database.queries.RowExtractor,java.lang.Object...)" class="member-name-link">queryOptional</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>&nbsp;sql,
<a href="queries/RowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">RowExtractor</a>&lt;T&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default &lt;T&gt;&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;T&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#querySet(java.lang.String,com.djrapitops.plan.storage.database.queries.RowExtractor,java.lang.Object...)" class="member-name-link">querySet</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>&nbsp;sql,
<a href="queries/RowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">RowExtractor</a>&lt;T&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
</div>
</div>
</div>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
2019-08-05 11:13:19 +02:00
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="init()">
<h3>init</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">init</span>()</div>
2019-08-05 11:13:19 +02:00
<div class="block">Initializes the Database.
<p>
Queries can be performed after this request has completed all required transactions for the database operations.</div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="../../exceptions/database/DBInitException.html" title="class in com.djrapitops.plan.exceptions.database">DBInitException</a></code> - if Database fails to initiate.</dd>
2019-08-05 11:13:19 +02:00
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="close()">
<h3>close</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()</div>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="query(com.djrapitops.plan.storage.database.queries.Query)">
<h3>query</h3>
<div class="member-signature"><span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type">T</span>&nbsp;<span class="element-name">query</span><wbr><span class="parameters">(<a href="queries/Query.html" title="interface in com.djrapitops.plan.storage.database.queries">Query</a>&lt;T&gt;&nbsp;query)</span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Execute an SQL Query statement to get a result.
<p>
This method should only be called from an asynchronous thread.</div>
<dl class="notes">
<dt>Type Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>T</code> - Type of the object to be returned.</dd>
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>query</code> - QueryStatement to execute.</dd>
<dt>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>Result of the query.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="queryOptional(java.lang.String,com.djrapitops.plan.storage.database.queries.RowExtractor,java.lang.Object...)">
<h3>queryOptional</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<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>&lt;T&gt;</span>&nbsp;<span class="element-name">queryOptional</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>&nbsp;sql,
<a href="queries/RowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">RowExtractor</a>&lt;T&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</span></div>
</section>
</li>
<li>
<section class="detail" id="queryList(java.lang.String,com.djrapitops.plan.storage.database.queries.RowExtractor,java.lang.Object...)">
<h3>queryList</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;T&gt;</span>&nbsp;<span class="element-name">queryList</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>&nbsp;sql,
<a href="queries/RowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">RowExtractor</a>&lt;T&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</span></div>
</section>
</li>
<li>
<section class="detail" id="querySet(java.lang.String,com.djrapitops.plan.storage.database.queries.RowExtractor,java.lang.Object...)">
<h3>querySet</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="type-parameters">&lt;T&gt;</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;T&gt;</span>&nbsp;<span class="element-name">querySet</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>&nbsp;sql,
<a href="queries/RowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">RowExtractor</a>&lt;T&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</span></div>
</section>
</li>
<li>
<section class="detail" id="queryCollection(java.lang.String,com.djrapitops.plan.storage.database.queries.RowExtractor,java.util.function.Supplier,java.lang.Object...)">
<h3>queryCollection</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="type-parameters">&lt;C extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;T&gt;,<wbr>
T&gt;</span>&nbsp;<span class="return-type">C</span>&nbsp;<span class="element-name">queryCollection</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>&nbsp;sql,
<a href="queries/RowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">RowExtractor</a>&lt;T&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;C&gt;&nbsp;collectionConstructor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</span></div>
</section>
</li>
<li>
<section class="detail" id="queryMap(java.lang.String,com.djrapitops.plan.storage.database.queries.MapRowExtractor,java.lang.Object...)">
<h3>queryMap</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="type-parameters">&lt;K,<wbr>
V&gt;</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;K,<wbr>V&gt;</span>&nbsp;<span class="element-name">queryMap</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>&nbsp;sql,
<a href="queries/MapRowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">MapRowExtractor</a>&lt;K,<wbr>V&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</span></div>
</section>
</li>
<li>
<section class="detail" id="queryMap(java.lang.String,com.djrapitops.plan.storage.database.queries.MapRowExtractor,java.util.function.Supplier,java.lang.Object...)">
<h3>queryMap</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="type-parameters">&lt;M extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;K,<wbr>
V&gt;,<wbr>
K,<wbr>
V&gt;</span>&nbsp;<span class="return-type">M</span>&nbsp;<span class="element-name">queryMap</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>&nbsp;sql,
<a href="queries/MapRowExtractor.html" title="interface in com.djrapitops.plan.storage.database.queries">MapRowExtractor</a>&lt;K,<wbr>V&gt;&nbsp;rowExtractor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;M&gt;&nbsp;mapConstructor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>...&nbsp;parameters)</span></div>
</section>
</li>
<li>
<section class="detail" id="executeTransaction(com.djrapitops.plan.storage.database.transactions.Transaction)">
<h3>executeTransaction</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/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a>&lt;?&gt;</span>&nbsp;<span class="element-name">executeTransaction</span><wbr><span class="parameters">(<a href="transactions/Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a>&nbsp;transaction)</span></div>
2019-08-05 11:13:19 +02:00
<div class="block">Execute an SQL Transaction.</div>
<dl class="notes">
<dt>Parameters:</dt>
2019-08-05 11:13:19 +02:00
<dd><code>transaction</code> - Transaction to execute.</dd>
<dt>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>Future that is finished when the transaction has been executed.</dd>
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="getType()">
<h3>getType</h3>
<div class="member-signature"><span class="return-type"><a href="DBType.html" title="enum class in com.djrapitops.plan.storage.database">DBType</a></span>&nbsp;<span class="element-name">getType</span>()</div>
2019-08-05 11:13:19 +02:00
<div class="block">Used to get the <code>DBType</code> of the Database</div>
<dl class="notes">
<dt>Returns:</dt>
2019-08-05 11:13:19 +02:00
<dd>the <code>DBType</code></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="DBType.html" title="enum class in com.djrapitops.plan.storage.database"><code>DBType</code></a></li>
</ul>
</dd>
2019-08-05 11:13:19 +02:00
</dl>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="getSql()">
<h3>getSql</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="sql/building/Sql.html" title="class in com.djrapitops.plan.storage.database.sql.building">Sql</a></span>&nbsp;<span class="element-name">getSql</span>()</div>
</section>
2019-08-05 11:13:19 +02:00
</li>
<li>
<section class="detail" id="getState()">
<h3>getState</h3>
<div class="member-signature"><span class="return-type"><a href="Database.State.html" title="enum class in com.djrapitops.plan.storage.database">Database.State</a></span>&nbsp;<span class="element-name">getState</span>()</div>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</section>
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
</main>
2019-08-05 11:13:19 +02:00
</div>
</div>
</body>
</html>