Skip to content

Commit

Permalink
Update javadocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@broneill
broneill committed Nov 12, 2024
1 parent 2993aec commit 780d15d
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 35 deletions.
5 changes: 5 additions & 0 deletions docs/javadoc/index-files/index-18.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,11 @@ <h2 class="title" id="I:R">R</h2>
<dd>&nbsp;</dd>
<dt><a href="../org.cojen.tupl/org/cojen/tupl/io/StripedPageArray.html#readPage(long,long,int,int)" class="member-name-link">readPage(long, long, int, int)</a> - Method in class org.cojen.tupl.io.<a href="../org.cojen.tupl/org/cojen/tupl/io/StripedPageArray.html" title="class in org.cojen.tupl.io">StripedPageArray</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../org.cojen.tupl/org/cojen/tupl/Database.html#rebuild(org.cojen.tupl.DatabaseConfig,org.cojen.tupl.DatabaseConfig,int)" class="member-name-link">rebuild(DatabaseConfig, DatabaseConfig, int)</a> - Static method in interface org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/Database.html" title="interface in org.cojen.tupl">Database</a></dt>
<dd>
<div class="block">Open an existing database and copy all the data into a new database, which can have a
different configuration.</div>
</dd>
<dt><a href="../org.cojen.tupl/org/cojen/tupl/repl/SnapshotSender.html#receiverAddress()" class="member-name-link">receiverAddress()</a> - Method in interface org.cojen.tupl.repl.<a href="../org.cojen.tupl/org/cojen/tupl/repl/SnapshotSender.html" title="interface in org.cojen.tupl.repl">SnapshotSender</a></dt>
<dd>
<div class="block">Member address which is receiving the snapshot.</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/javadoc/member-search-index.js
View file

Large diffs are not rendered by default.

92 changes: 62 additions & 30 deletions docs/javadoc/org.cojen.tupl/org/cojen/tupl/Database.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
<li><a href="#open(org.cojen.tupl.DatabaseConfig)" tabindex="0">open(DatabaseConfig)</a></li>
<li><a href="#destroy(org.cojen.tupl.DatabaseConfig)" tabindex="0">destroy(DatabaseConfig)</a></li>
<li><a href="#connect(java.net.SocketAddress,javax.net.ssl.SSLContext,long...)" tabindex="0">connect(SocketAddress, SSLContext, long...)</a></li>
<li><a href="#rebuild(org.cojen.tupl.DatabaseConfig,org.cojen.tupl.DatabaseConfig,int)" tabindex="0">rebuild(DatabaseConfig, DatabaseConfig, int)</a></li>
<li><a href="#openIndex(byte%5B%5D)" tabindex="0">openIndex(byte[])</a></li>
<li><a href="#openIndex(java.lang.String)" tabindex="0">openIndex(String)</a></li>
<li><a href="#findIndex(byte%5B%5D)" tabindex="0">findIndex(byte[])</a></li>
Expand Down Expand Up @@ -400,61 +401,69 @@ <h2>Method Summary</h2>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns a handler instance suitable for preparing transactions.</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="#renameIndex(org.cojen.tupl.Index,byte%5B%5D)" class="member-name-link">renameIndex</a><wbr>(<a href="Index.html" title="interface in org.cojen.tupl">Index</a>&nbsp;index,
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="Database.html" title="interface in org.cojen.tupl">Database</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#rebuild(org.cojen.tupl.DatabaseConfig,org.cojen.tupl.DatabaseConfig,int)" class="member-name-link">rebuild</a><wbr>(<a href="DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a>&nbsp;oldConfig,
<a href="DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a>&nbsp;newConfig,
int&nbsp;numThreads)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
<div class="block">Open an existing database and copy all the data into a new database, which can have a
different configuration.</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="#renameIndex(org.cojen.tupl.Index,byte%5B%5D)" class="member-name-link">renameIndex</a><wbr>(<a href="Index.html" title="interface in org.cojen.tupl">Index</a>&nbsp;index,
byte[]&nbsp;newName)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Renames the given index to the one given.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#renameIndex(org.cojen.tupl.Index,java.lang.String)" class="member-name-link">renameIndex</a><wbr>(<a href="Index.html" title="interface in org.cojen.tupl">Index</a>&nbsp;index,
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#renameIndex(org.cojen.tupl.Index,java.lang.String)" class="member-name-link">renameIndex</a><wbr>(<a href="Index.html" title="interface in org.cojen.tupl">Index</a>&nbsp;index,
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;newName)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Renames the given index to the one given.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="Database.html" title="interface in org.cojen.tupl">Database</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#restoreFromSnapshot(org.cojen.tupl.DatabaseConfig,java.io.InputStream)" class="member-name-link">restoreFromSnapshot</a><wbr>(<a href="DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a>&nbsp;config,
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="Database.html" title="interface in org.cojen.tupl">Database</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#restoreFromSnapshot(org.cojen.tupl.DatabaseConfig,java.io.InputStream)" class="member-name-link">restoreFromSnapshot</a><wbr>(<a href="DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a>&nbsp;config,
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;in)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
<div class="block">Restore from a <a href="#beginSnapshot()">snapshot</a>, into the data files defined by the
given configuration.</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="#resumeCheckpoints()" class="member-name-link">resumeCheckpoints</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Resume automatic checkpoints after having been temporarily <a href="#suspendCheckpoints()"><code>suspended</code></a>.</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="#shutdown()" class="member-name-link">shutdown</a>()</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#resumeCheckpoints()" class="member-name-link">resumeCheckpoints</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Cleanly closes the database, ensuring durability of all modifications.</div>
<div class="block">Resume automatic checkpoints after having been temporarily <a href="#suspendCheckpoints()"><code>suspended</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="diag/DatabaseStats.html" title="class in org.cojen.tupl.diag">DatabaseStats</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#stats()" class="member-name-link">stats</a>()</code></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="#shutdown()" class="member-name-link">shutdown</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns a collection of database statistics.</div>
<div class="block">Cleanly closes the database, ensuring durability of all modifications.</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="#suspendCheckpoints()" class="member-name-link">suspendCheckpoints</a>()</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="diag/DatabaseStats.html" title="class in org.cojen.tupl.diag">DatabaseStats</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#stats()" class="member-name-link">stats</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Temporarily suspend automatic checkpoints and wait for any in-progress checkpoint to
complete.</div>
<div class="block">Returns a collection of database statistics.</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="#sync()" class="member-name-link">sync</a>()</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#suspendCheckpoints()" class="member-name-link">suspendCheckpoints</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Durably flushes all committed transactions.</div>
<div class="block">Temporarily suspend automatic checkpoints and wait for any in-progress checkpoint to
complete.</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="#uponLeader(java.lang.Runnable,java.lang.Runnable)" class="member-name-link">uponLeader</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>&nbsp;acquired,
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>&nbsp;lost)</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#sync()" class="member-name-link">sync</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Durably flushes all committed transactions.</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="#uponLeader(java.lang.Runnable,java.lang.Runnable)" class="member-name-link">uponLeader</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>&nbsp;acquired,
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>&nbsp;lost)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Registers the given task to start in a separate thread when the database instance has
become the leader.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#verify(org.cojen.tupl.diag.VerificationObserver)" class="member-name-link">verify</a><wbr>(<a href="diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#verify(org.cojen.tupl.diag.VerificationObserver)" class="member-name-link">verify</a><wbr>(<a href="diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Verifies the integrity of the database and all indexes.</div>
</div>
</div>
Expand Down Expand Up @@ -521,6 +530,29 @@ <h3>connect</h3>
</section>
</li>
<li>
<section class="detail" id="rebuild(org.cojen.tupl.DatabaseConfig,org.cojen.tupl.DatabaseConfig,int)">
<h3>rebuild</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="Database.html" title="interface in org.cojen.tupl">Database</a></span>&nbsp;<span class="element-name">rebuild</span><wbr><span class="parameters">(<a href="DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a>&nbsp;oldConfig,
<a href="DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a>&nbsp;newConfig,
int&nbsp;numThreads)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Open an existing database and copy all the data into a new database, which can have a
different configuration.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>numThreads</code> - pass 0 for default, or if negative, the actual number will be <code>
(-numThreads * availableProcessors)</code>.</dd>
<dt>Returns:</dt>
<dd>the newly built database</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the new database already exists</dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="openIndex(byte[])">
<h3>openIndex</h3>
<div class="horizontal-scroll">
Expand Down
12 changes: 10 additions & 2 deletions docs/javadoc/org.cojen.tupl/org/cojen/tupl/class-use/Database.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,17 @@ <h2>Uses of <a href="../Database.html" title="interface in org.cojen.tupl">Datab
<div class="block">Open a database, creating it if necessary.</div>
</div>
<div class="col-first odd-row-color"><code>static <a href="../Database.html" title="interface in org.cojen.tupl">Database</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Database.</span><code><a href="../Database.html#restoreFromSnapshot(org.cojen.tupl.DatabaseConfig,java.io.InputStream)" class="member-name-link">restoreFromSnapshot</a><wbr>(<a href="../DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a>&nbsp;config,
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;in)</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Database.</span><code><a href="../Database.html#rebuild(org.cojen.tupl.DatabaseConfig,org.cojen.tupl.DatabaseConfig,int)" class="member-name-link">rebuild</a><wbr>(<a href="../DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a>&nbsp;oldConfig,
<a href="../DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a>&nbsp;newConfig,
int&nbsp;numThreads)</code></div>
<div class="col-last odd-row-color">
<div class="block">Open an existing database and copy all the data into a new database, which can have a
different configuration.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="../Database.html" title="interface in org.cojen.tupl">Database</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Database.</span><code><a href="../Database.html#restoreFromSnapshot(org.cojen.tupl.DatabaseConfig,java.io.InputStream)" class="member-name-link">restoreFromSnapshot</a><wbr>(<a href="../DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a>&nbsp;config,
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;in)</code></div>
<div class="col-last even-row-color">
<div class="block">Restore from a <a href="../Database.html#beginSnapshot()">snapshot</a>, into the data files defined by the
given configuration.</div>
</div>
Expand Down
Loading

0 comments on commit 780d15d

Please sign in to comment.