Merge pull request #20 from kuzudb/api-documentation-update-27cba5b91423c96a0a0507c92dfe0e1654f7f184

Update API documentations

Author: mewim

cpp/storage__version__info_8h_source.html

@@ -108,24 +108,25 @@
 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="structkuzu_1_1storage_1_1_storage_version_info.html">   14</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structkuzu_1_1storage_1_1_storage_version_info.html">StorageVersionInfo</a> {</div>
 <div class="foldopen" id="foldopen00015" data-start="{" data-end="}">
 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structkuzu_1_1storage_1_1_storage_version_info.html#a88db579f27de5d1a09bed5a21a8019cd">   15</a></span>    <span class="keyword">static</span> std::unordered_map&lt;std::string, storage_version_t&gt; <a class="code hl_function" href="structkuzu_1_1storage_1_1_storage_version_info.html#a88db579f27de5d1a09bed5a21a8019cd">getStorageVersionInfo</a>() {</div>
-<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span>        <span class="keywordflow">return</span> {{<span class="stringliteral">&quot;0.11.2&quot;</span>, 39}, {<span class="stringliteral">&quot;0.11.1&quot;</span>, 39}, {<span class="stringliteral">&quot;0.11.0&quot;</span>, 39}, {<span class="stringliteral">&quot;0.10.0&quot;</span>, 38}, {<span class="stringliteral">&quot;0.9.0&quot;</span>, 37},</div>
-<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span>            {<span class="stringliteral">&quot;0.8.0&quot;</span>, 36}, {<span class="stringliteral">&quot;0.7.1.1&quot;</span>, 35}, {<span class="stringliteral">&quot;0.7.0&quot;</span>, 34}, {<span class="stringliteral">&quot;0.6.0.6&quot;</span>, 33}, {<span class="stringliteral">&quot;0.6.0.5&quot;</span>, 32},</div>
-<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>            {<span class="stringliteral">&quot;0.6.0.2&quot;</span>, 31}, {<span class="stringliteral">&quot;0.6.0.1&quot;</span>, 31}, {<span class="stringliteral">&quot;0.6.0&quot;</span>, 28}, {<span class="stringliteral">&quot;0.5.0&quot;</span>, 28}, {<span class="stringliteral">&quot;0.4.2&quot;</span>, 27},</div>
-<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>            {<span class="stringliteral">&quot;0.4.1&quot;</span>, 27}, {<span class="stringliteral">&quot;0.4.0&quot;</span>, 27}, {<span class="stringliteral">&quot;0.3.2&quot;</span>, 26}, {<span class="stringliteral">&quot;0.3.1&quot;</span>, 26}, {<span class="stringliteral">&quot;0.3.0&quot;</span>, 26},</div>
-<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>            {<span class="stringliteral">&quot;0.2.1&quot;</span>, 25}, {<span class="stringliteral">&quot;0.2.0&quot;</span>, 25}, {<span class="stringliteral">&quot;0.1.0&quot;</span>, 24}, {<span class="stringliteral">&quot;0.0.12.3&quot;</span>, 24}, {<span class="stringliteral">&quot;0.0.12.2&quot;</span>, 24},</div>
-<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>            {<span class="stringliteral">&quot;0.0.12.1&quot;</span>, 24}, {<span class="stringliteral">&quot;0.0.12&quot;</span>, 23}, {<span class="stringliteral">&quot;0.0.11&quot;</span>, 23}, {<span class="stringliteral">&quot;0.0.10&quot;</span>, 23}, {<span class="stringliteral">&quot;0.0.9&quot;</span>, 23},</div>
-<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span>            {<span class="stringliteral">&quot;0.0.8&quot;</span>, 17}, {<span class="stringliteral">&quot;0.0.7&quot;</span>, 15}, {<span class="stringliteral">&quot;0.0.6&quot;</span>, 9}, {<span class="stringliteral">&quot;0.0.5&quot;</span>, 8}, {<span class="stringliteral">&quot;0.0.4&quot;</span>, 7}, {<span class="stringliteral">&quot;0.0.3&quot;</span>, 1}};</div>
-<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>    }</div>
+<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span>        <span class="keywordflow">return</span> {{<span class="stringliteral">&quot;0.11.3&quot;</span>, 39}, {<span class="stringliteral">&quot;0.11.2&quot;</span>, 39}, {<span class="stringliteral">&quot;0.11.1&quot;</span>, 39}, {<span class="stringliteral">&quot;0.11.0&quot;</span>, 39}, {<span class="stringliteral">&quot;0.10.0&quot;</span>, 38},</div>
+<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span>            {<span class="stringliteral">&quot;0.9.0&quot;</span>, 37}, {<span class="stringliteral">&quot;0.8.0&quot;</span>, 36}, {<span class="stringliteral">&quot;0.7.1.1&quot;</span>, 35}, {<span class="stringliteral">&quot;0.7.0&quot;</span>, 34}, {<span class="stringliteral">&quot;0.6.0.6&quot;</span>, 33},</div>
+<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>            {<span class="stringliteral">&quot;0.6.0.5&quot;</span>, 32}, {<span class="stringliteral">&quot;0.6.0.2&quot;</span>, 31}, {<span class="stringliteral">&quot;0.6.0.1&quot;</span>, 31}, {<span class="stringliteral">&quot;0.6.0&quot;</span>, 28}, {<span class="stringliteral">&quot;0.5.0&quot;</span>, 28},</div>
+<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>            {<span class="stringliteral">&quot;0.4.2&quot;</span>, 27}, {<span class="stringliteral">&quot;0.4.1&quot;</span>, 27}, {<span class="stringliteral">&quot;0.4.0&quot;</span>, 27}, {<span class="stringliteral">&quot;0.3.2&quot;</span>, 26}, {<span class="stringliteral">&quot;0.3.1&quot;</span>, 26},</div>
+<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>            {<span class="stringliteral">&quot;0.3.0&quot;</span>, 26}, {<span class="stringliteral">&quot;0.2.1&quot;</span>, 25}, {<span class="stringliteral">&quot;0.2.0&quot;</span>, 25}, {<span class="stringliteral">&quot;0.1.0&quot;</span>, 24}, {<span class="stringliteral">&quot;0.0.12.3&quot;</span>, 24},</div>
+<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>            {<span class="stringliteral">&quot;0.0.12.2&quot;</span>, 24}, {<span class="stringliteral">&quot;0.0.12.1&quot;</span>, 24}, {<span class="stringliteral">&quot;0.0.12&quot;</span>, 23}, {<span class="stringliteral">&quot;0.0.11&quot;</span>, 23}, {<span class="stringliteral">&quot;0.0.10&quot;</span>, 23},</div>
+<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span>            {<span class="stringliteral">&quot;0.0.9&quot;</span>, 23}, {<span class="stringliteral">&quot;0.0.8&quot;</span>, 17}, {<span class="stringliteral">&quot;0.0.7&quot;</span>, 15}, {<span class="stringliteral">&quot;0.0.6&quot;</span>, 9}, {<span class="stringliteral">&quot;0.0.5&quot;</span>, 8}, {<span class="stringliteral">&quot;0.0.4&quot;</span>, 7},</div>
+<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>            {<span class="stringliteral">&quot;0.0.3&quot;</span>, 1}};</div>
+<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>    }</div>
 </div>
-<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
-<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="structkuzu_1_1storage_1_1_storage_version_info.html#a74ac35b8d41b0973a9ebb03ec6220469">   25</a></span>    <span class="keyword">static</span> <a class="code hl_define" href="api_8h.html#ae723a6ac7b0cca48a22a501787397769">KUZU_API</a> <a class="code hl_typedef" href="namespacekuzu_1_1storage.html#ad0a1b58784395eb59e7af3bdc7f69d11">storage_version_t</a> <a class="code hl_function" href="structkuzu_1_1storage_1_1_storage_version_info.html#a74ac35b8d41b0973a9ebb03ec6220469">getStorageVersion</a>();</div>
-<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
-<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structkuzu_1_1storage_1_1_storage_version_info.html#acaa6229ce817b03654cb16000adf1b73">   27</a></span>    <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_variable" href="structkuzu_1_1storage_1_1_storage_version_info.html#acaa6229ce817b03654cb16000adf1b73">MAGIC_BYTES</a> = <span class="stringliteral">&quot;KUZU&quot;</span>;</div>
-<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>};</div>
+<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
+<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structkuzu_1_1storage_1_1_storage_version_info.html#a74ac35b8d41b0973a9ebb03ec6220469">   26</a></span>    <span class="keyword">static</span> <a class="code hl_define" href="api_8h.html#ae723a6ac7b0cca48a22a501787397769">KUZU_API</a> <a class="code hl_typedef" href="namespacekuzu_1_1storage.html#ad0a1b58784395eb59e7af3bdc7f69d11">storage_version_t</a> <a class="code hl_function" href="structkuzu_1_1storage_1_1_storage_version_info.html#a74ac35b8d41b0973a9ebb03ec6220469">getStorageVersion</a>();</div>
+<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
+<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="structkuzu_1_1storage_1_1_storage_version_info.html#acaa6229ce817b03654cb16000adf1b73">   28</a></span>    <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_variable" href="structkuzu_1_1storage_1_1_storage_version_info.html#acaa6229ce817b03654cb16000adf1b73">MAGIC_BYTES</a> = <span class="stringliteral">&quot;KUZU&quot;</span>;</div>
+<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>};</div>
 </div>
-<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
-<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>} <span class="comment">// namespace storage</span></div>
-<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>} <span class="comment">// namespace kuzu</span></div>
+<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
+<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>} <span class="comment">// namespace storage</span></div>
+<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>} <span class="comment">// namespace kuzu</span></div>
 <div class="ttc" id="aapi_8h_html"><div class="ttname"><a href="api_8h.html">api.h</a></div></div>
 <div class="ttc" id="aapi_8h_html_ae723a6ac7b0cca48a22a501787397769"><div class="ttname"><a href="api_8h.html#ae723a6ac7b0cca48a22a501787397769">KUZU_API</a></div><div class="ttdeci">#define KUZU_API</div><div class="ttdef"><b>Definition</b> api.h:25</div></div>
 <div class="ttc" id="anamespacekuzu_1_1storage_html"><div class="ttname"><a href="namespacekuzu_1_1storage.html">kuzu::storage</a></div><div class="ttdef"><b>Definition</b> copy_from_error.h:17</div></div>
@@ -134,7 +135,7 @@
 <div class="ttc" id="astructkuzu_1_1storage_1_1_storage_version_info_html"><div class="ttname"><a href="structkuzu_1_1storage_1_1_storage_version_info.html">kuzu::storage::StorageVersionInfo</a></div><div class="ttdef"><b>Definition</b> storage_version_info.h:14</div></div>
 <div class="ttc" id="astructkuzu_1_1storage_1_1_storage_version_info_html_a74ac35b8d41b0973a9ebb03ec6220469"><div class="ttname"><a href="structkuzu_1_1storage_1_1_storage_version_info.html#a74ac35b8d41b0973a9ebb03ec6220469">kuzu::storage::StorageVersionInfo::getStorageVersion</a></div><div class="ttdeci">static KUZU_API storage_version_t getStorageVersion()</div></div>
 <div class="ttc" id="astructkuzu_1_1storage_1_1_storage_version_info_html_a88db579f27de5d1a09bed5a21a8019cd"><div class="ttname"><a href="structkuzu_1_1storage_1_1_storage_version_info.html#a88db579f27de5d1a09bed5a21a8019cd">kuzu::storage::StorageVersionInfo::getStorageVersionInfo</a></div><div class="ttdeci">static std::unordered_map&lt; std::string, storage_version_t &gt; getStorageVersionInfo()</div><div class="ttdef"><b>Definition</b> storage_version_info.h:15</div></div>
-<div class="ttc" id="astructkuzu_1_1storage_1_1_storage_version_info_html_acaa6229ce817b03654cb16000adf1b73"><div class="ttname"><a href="structkuzu_1_1storage_1_1_storage_version_info.html#acaa6229ce817b03654cb16000adf1b73">kuzu::storage::StorageVersionInfo::MAGIC_BYTES</a></div><div class="ttdeci">static constexpr const char * MAGIC_BYTES</div><div class="ttdef"><b>Definition</b> storage_version_info.h:27</div></div>
+<div class="ttc" id="astructkuzu_1_1storage_1_1_storage_version_info_html_acaa6229ce817b03654cb16000adf1b73"><div class="ttname"><a href="structkuzu_1_1storage_1_1_storage_version_info.html#acaa6229ce817b03654cb16000adf1b73">kuzu::storage::StorageVersionInfo::MAGIC_BYTES</a></div><div class="ttdeci">static constexpr const char * MAGIC_BYTES</div><div class="ttdef"><b>Definition</b> storage_version_info.h:28</div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 </div><!-- container -->

java/allclasses-index.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (20) on Thu Aug 21 05:19:37 UTC 2025 -->
+<!-- Generated by javadoc (20) on Fri Oct 10 14:52:34 UTC 2025 -->
 <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="2025-08-21">
+<meta name="dc.created" content="2025-10-10">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

java/allpackages-index.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (20) on Thu Aug 21 05:19:37 UTC 2025 -->
+<!-- Generated by javadoc (20) on Fri Oct 10 14:52:34 UTC 2025 -->
 <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="2025-08-21">
+<meta name="dc.created" content="2025-10-10">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

java/com/kuzudb/Connection.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (20) on Thu Aug 21 05:19:37 UTC 2025 -->
+<!-- Generated by javadoc (20) on Fri Oct 10 14:52:34 UTC 2025 -->
 <title>Connection</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="2025-08-21">
+<meta name="dc.created" content="2025-10-10">
 <meta name="description" content="declaration: package: com.kuzudb, class: Connection">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

java/com/kuzudb/DataType.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (20) on Thu Aug 21 05:19:37 UTC 2025 -->
+<!-- Generated by javadoc (20) on Fri Oct 10 14:52:34 UTC 2025 -->
 <title>DataType</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="2025-08-21">
+<meta name="dc.created" content="2025-10-10">
 <meta name="description" content="declaration: package: com.kuzudb, class: DataType">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

java/com/kuzudb/DataTypeID.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (20) on Thu Aug 21 05:19:37 UTC 2025 -->
+<!-- Generated by javadoc (20) on Fri Oct 10 14:52:34 UTC 2025 -->
 <title>DataTypeID</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="2025-08-21">
+<meta name="dc.created" content="2025-10-10">
 <meta name="description" content="declaration: package: com.kuzudb, enum: DataTypeID">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

java/com/kuzudb/Database.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (20) on Thu Aug 21 05:19:37 UTC 2025 -->
+<!-- Generated by javadoc (20) on Fri Oct 10 14:52:34 UTC 2025 -->
 <title>Database</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="2025-08-21">
+<meta name="dc.created" content="2025-10-10">
 <meta name="description" content="declaration: package: com.kuzudb, class: Database">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

java/com/kuzudb/FlatTuple.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (20) on Thu Aug 21 05:19:37 UTC 2025 -->
+<!-- Generated by javadoc (20) on Fri Oct 10 14:52:34 UTC 2025 -->
 <title>FlatTuple</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="2025-08-21">
+<meta name="dc.created" content="2025-10-10">
 <meta name="description" content="declaration: package: com.kuzudb, class: FlatTuple">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

java/com/kuzudb/InternalID.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (20) on Thu Aug 21 05:19:37 UTC 2025 -->
+<!-- Generated by javadoc (20) on Fri Oct 10 14:52:34 UTC 2025 -->
 <title>InternalID</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="2025-08-21">
+<meta name="dc.created" content="2025-10-10">
 <meta name="description" content="declaration: package: com.kuzudb, class: InternalID">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

java/com/kuzudb/KuzuList.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (20) on Thu Aug 21 05:19:37 UTC 2025 -->
+<!-- Generated by javadoc (20) on Fri Oct 10 14:52:34 UTC 2025 -->
 <title>KuzuList</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="2025-08-21">
+<meta name="dc.created" content="2025-10-10">
 <meta name="description" content="declaration: package: com.kuzudb, class: KuzuList">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">