Skip to content

Commit

Permalink
Update API documentations (#173)
Browse files Browse the repository at this point in the history
Co-authored-by: CI User <[email protected]>
  • Loading branch information
mewim and CI User authored Sep 18, 2024
1 parent fe7ca5b commit d29728f
Show file tree
Hide file tree
Showing 41 changed files with 1,312 additions and 1,281 deletions.
76 changes: 38 additions & 38 deletions api-docs/java/allclasses-index.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (20) on Fri Aug 16 20:43:36 UTC 2024 -->
<!-- Generated by javadoc (20) on Wed Sep 18 23:22:08 UTC 2024 -->
<title>All Classes and Interfaces</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-08-16">
<meta name="dc.created" content="2024-09-18">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down Expand Up @@ -55,82 +55,82 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuConnection.html" title="class in com.kuzudb">KuzuConnection</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/Connection.html" title="class in com.kuzudb">Connection</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">KuzuConnection is used to interact with a KuzuDatabase instance.</div>
<div class="block">Connection is used to interact with a Database instance.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuDatabase.html" title="class in com.kuzudb">KuzuDatabase</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/Database.html" title="class in com.kuzudb">Database</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">The KuzuDatabase class is the main class of KuzuDB.</div>
<div class="block">The Database class is the main class of KuzuDB.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuDataType.html" title="class in com.kuzudb">KuzuDataType</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/DataType.html" title="class in com.kuzudb">DataType</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">KuzuDataType is the kuzu internal representation of data types.</div>
<div class="block">DataType is the kuzu internal representation of data types.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com/kuzudb/KuzuDataTypeID.html" title="enum class in com.kuzudb">KuzuDataTypeID</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com/kuzudb/DataTypeID.html" title="enum class in com.kuzudb">DataTypeID</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">Kuzu data type ID.</div>
<div class="block">data type ID.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuFlatTuple.html" title="class in com.kuzudb">KuzuFlatTuple</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/FlatTuple.html" title="class in com.kuzudb">FlatTuple</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">FlatTuple stores a vector of values.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuInternalID.html" title="class in com.kuzudb">KuzuInternalID</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/InternalID.html" title="class in com.kuzudb">InternalID</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">KuzuInternalID type which stores the table_id and offset of a node/rel.</div>
<div class="block">InternalID type which stores the table_id and offset of a node/rel.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuNative.html" title="class in com.kuzudb">KuzuNative</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/Native.html" title="class in com.kuzudb">Native</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">KuzuNative is a wrapper class for the native library.</div>
<div class="block">Native is a wrapper class for the native library.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="com/kuzudb/KuzuObjectRefDestroyedException.html" title="class in com.kuzudb">KuzuObjectRefDestroyedException</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="com/kuzudb/ObjectRefDestroyedException.html" title="class in com.kuzudb">ObjectRefDestroyedException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="block">KuzuObjectRefDestroyedException is thrown when a destroyed object is accessed
<div class="block">ObjectRefDestroyedException is thrown when a destroyed object is accessed
or destroyed again.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuPreparedStatement.html" title="class in com.kuzudb">KuzuPreparedStatement</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/PreparedStatement.html" title="class in com.kuzudb">PreparedStatement</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">KuzuPreparedStatement is a parameterized query which can avoid planning the same query for repeated execution.</div>
<div class="block">PreparedStatement is a parameterized query which can avoid planning the same query for repeated execution.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuQueryResult.html" title="class in com.kuzudb">KuzuQueryResult</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/QueryResult.html" title="class in com.kuzudb">QueryResult</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">KuzuQueryResult stores the result of a query execution.</div>
<div class="block">QueryResult stores the result of a query execution.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuQuerySummary.html" title="class in com.kuzudb">KuzuQuerySummary</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/QuerySummary.html" title="class in com.kuzudb">QuerySummary</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">QuerySummary stores the execution time, plan, compiling time and query options of a query.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuValue.html" title="class in com.kuzudb">KuzuValue</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/Value.html" title="class in com.kuzudb">Value</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">KuzuValue can hold data of different types.</div>
<div class="block">Value can hold data of different types.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuValueListUtil.html" title="class in com.kuzudb">KuzuValueListUtil</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/ValueListUtil.html" title="class in com.kuzudb">ValueListUtil</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Utility functions for KuzuValue of list type.</div>
<div class="block">Utility functions for Value of list type.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuValueNodeUtil.html" title="class in com.kuzudb">KuzuValueNodeUtil</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/ValueNodeUtil.html" title="class in com.kuzudb">ValueNodeUtil</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Utility functions for KuzuValue of node type.</div>
<div class="block">Utility functions for Value of node type.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuValueRdfVariantUtil.html" title="class in com.kuzudb">KuzuValueRdfVariantUtil</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/ValueRdfVariantUtil.html" title="class in com.kuzudb">ValueRdfVariantUtil</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Utility functions for KuzuValue of RDF_VARIANT type.</div>
<div class="block">Utility functions for Value of RDF_VARIANT type.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuValueRecursiveRelUtil.html" title="class in com.kuzudb">KuzuValueRecursiveRelUtil</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/ValueRecursiveRelUtil.html" title="class in com.kuzudb">ValueRecursiveRelUtil</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Utility functions for KuzuValue of recursive_rel type.</div>
<div class="block">Utility functions for Value of recursive_rel type.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuValueRelUtil.html" title="class in com.kuzudb">KuzuValueRelUtil</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/ValueRelUtil.html" title="class in com.kuzudb">ValueRelUtil</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Utility functions for KuzuValue of rel type.</div>
<div class="block">Utility functions for Value of rel type.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuValueStructUtil.html" title="class in com.kuzudb">KuzuValueStructUtil</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/ValueStructUtil.html" title="class in com.kuzudb">ValueStructUtil</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Utility functions for KuzuValue of struct type.</div>
<div class="block">Utility functions for Value of struct type.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/KuzuVersion.html" title="class in com.kuzudb">KuzuVersion</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/kuzudb/Version.html" title="class in com.kuzudb">Version</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">KuzuVersion is a class to get the version of the Kùzu.</div>
<div class="block">Version is a class to get the version of the Kùzu.</div>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions api-docs/java/allpackages-index.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (20) on Fri Aug 16 20:43:36 UTC 2024 -->
<!-- Generated by javadoc (20) on Wed Sep 18 23:22:08 UTC 2024 -->
<title>All Packages</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-08-16">
<meta name="dc.created" content="2024-09-18">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
Loading

0 comments on commit d29728f

Please sign in to comment.