Merge pull request #3 from kuzudb/api-documentation-update-61b46151d82f6715ce438dc8880de955bd106037

Update API documentations

Author: mewim

cpp/annotated.html

@@ -113,8 +113,14 @@ var annotated_dup =
         [ "BinaryStringFunctionWrapper", "structkuzu_1_1function_1_1_binary_string_function_wrapper.html", null ],
         [ "BinaryUDFExecutor", "structkuzu_1_1function_1_1_binary_u_d_f_executor.html", null ],
         [ "BinaryUDFFunctionWrapper", "structkuzu_1_1function_1_1_binary_u_d_f_function_wrapper.html", null ],
+        [ "BMInfoFunction", "structkuzu_1_1function_1_1_b_m_info_function.html", null ],
         [ "CastFunctionBindData", "structkuzu_1_1function_1_1_cast_function_bind_data.html", "structkuzu_1_1function_1_1_cast_function_bind_data" ],
+        [ "ClearWarningsFunction", "structkuzu_1_1function_1_1_clear_warnings_function.html", null ],
         [ "ConstFunctionExecutor", "structkuzu_1_1function_1_1_const_function_executor.html", null ],
+        [ "CreateProjectGraphFunction", "structkuzu_1_1function_1_1_create_project_graph_function.html", null ],
+        [ "CurrentSettingFunction", "structkuzu_1_1function_1_1_current_setting_function.html", null ],
+        [ "DBVersionFunction", "structkuzu_1_1function_1_1_d_b_version_function.html", null ],
+        [ "DropProjectGraphFunction", "structkuzu_1_1function_1_1_drop_project_graph_function.html", null ],
         [ "ExtraScanTableFuncBindInput", "structkuzu_1_1function_1_1_extra_scan_table_func_bind_input.html", "structkuzu_1_1function_1_1_extra_scan_table_func_bind_input" ],
         [ "ExtraTableFuncBindInput", "structkuzu_1_1function_1_1_extra_table_func_bind_input.html", "structkuzu_1_1function_1_1_extra_table_func_bind_input" ],
         [ "Function", "structkuzu_1_1function_1_1_function.html", "structkuzu_1_1function_1_1_function" ],
@@ -125,13 +131,26 @@ var annotated_dup =
         [ "ScalarOrAggregateFunction", "structkuzu_1_1function_1_1_scalar_or_aggregate_function.html", "structkuzu_1_1function_1_1_scalar_or_aggregate_function" ],
         [ "ScanReplacement", "structkuzu_1_1function_1_1_scan_replacement.html", "structkuzu_1_1function_1_1_scan_replacement" ],
         [ "ScanReplacementData", "structkuzu_1_1function_1_1_scan_replacement_data.html", "structkuzu_1_1function_1_1_scan_replacement_data" ],
+        [ "ShowAttachedDatabasesFunction", "structkuzu_1_1function_1_1_show_attached_databases_function.html", null ],
+        [ "ShowConnectionFunction", "structkuzu_1_1function_1_1_show_connection_function.html", null ],
+        [ "ShowFunctionsFunction", "structkuzu_1_1function_1_1_show_functions_function.html", null ],
+        [ "ShowIndexesFunction", "structkuzu_1_1function_1_1_show_indexes_function.html", null ],
+        [ "ShowLoadedExtensionsFunction", "structkuzu_1_1function_1_1_show_loaded_extensions_function.html", null ],
+        [ "ShowOfficialExtensionsFunction", "structkuzu_1_1function_1_1_show_official_extensions_function.html", null ],
+        [ "ShowSequencesFunction", "structkuzu_1_1function_1_1_show_sequences_function.html", null ],
+        [ "ShowTablesFunction", "structkuzu_1_1function_1_1_show_tables_function.html", null ],
+        [ "ShowWarningsFunction", "structkuzu_1_1function_1_1_show_warnings_function.html", null ],
+        [ "StatsInfoFunction", "structkuzu_1_1function_1_1_stats_info_function.html", null ],
+        [ "StorageInfoFunction", "structkuzu_1_1function_1_1_storage_info_function.html", null ],
         [ "TableFuncBindInput", "structkuzu_1_1function_1_1_table_func_bind_input.html", "structkuzu_1_1function_1_1_table_func_bind_input" ],
         [ "TableFuncInput", "structkuzu_1_1function_1_1_table_func_input.html", "structkuzu_1_1function_1_1_table_func_input" ],
         [ "TableFuncLocalState", "structkuzu_1_1function_1_1_table_func_local_state.html", "structkuzu_1_1function_1_1_table_func_local_state" ],
+        [ "TableFuncMorsel", "structkuzu_1_1function_1_1_table_func_morsel.html", "structkuzu_1_1function_1_1_table_func_morsel" ],
         [ "TableFuncOutput", "structkuzu_1_1function_1_1_table_func_output.html", "structkuzu_1_1function_1_1_table_func_output" ],
         [ "TableFuncSharedState", "structkuzu_1_1function_1_1_table_func_shared_state.html", "structkuzu_1_1function_1_1_table_func_shared_state" ],
         [ "TableFunction", "structkuzu_1_1function_1_1_table_function.html", "structkuzu_1_1function_1_1_table_function" ],
         [ "TableFunctionInitInput", "structkuzu_1_1function_1_1_table_function_init_input.html", "structkuzu_1_1function_1_1_table_function_init_input" ],
+        [ "TableInfoFunction", "structkuzu_1_1function_1_1_table_info_function.html", null ],
         [ "TernaryFunctionExecutor", "structkuzu_1_1function_1_1_ternary_function_executor.html", null ],
         [ "TernaryFunctionWrapper", "structkuzu_1_1function_1_1_ternary_function_wrapper.html", null ],
         [ "TernaryListFunctionWrapper", "structkuzu_1_1function_1_1_ternary_list_function_wrapper.html", null ],
@@ -176,9 +195,16 @@ var annotated_dup =
       ] ],
       [ "processor", "namespacekuzu_1_1processor.html", [
         [ "CopyFromFileError", "structkuzu_1_1processor_1_1_copy_from_file_error.html", "structkuzu_1_1processor_1_1_copy_from_file_error" ],
+        [ "DataChunkDescriptor", "structkuzu_1_1processor_1_1_data_chunk_descriptor.html", "structkuzu_1_1processor_1_1_data_chunk_descriptor" ],
+        [ "DataPos", "structkuzu_1_1processor_1_1_data_pos.html", "structkuzu_1_1processor_1_1_data_pos" ],
         [ "FlatTuple", "classkuzu_1_1processor_1_1_flat_tuple.html", "classkuzu_1_1processor_1_1_flat_tuple" ],
         [ "LineContext", "structkuzu_1_1processor_1_1_line_context.html", "structkuzu_1_1processor_1_1_line_context" ],
+        [ "OperatorMetrics", "structkuzu_1_1processor_1_1_operator_metrics.html", "structkuzu_1_1processor_1_1_operator_metrics" ],
+        [ "PhysicalOperator", "classkuzu_1_1processor_1_1_physical_operator.html", "classkuzu_1_1processor_1_1_physical_operator" ],
+        [ "PhysicalOperatorUtils", "classkuzu_1_1processor_1_1_physical_operator_utils.html", null ],
         [ "PopulatedCopyFromError", "structkuzu_1_1processor_1_1_populated_copy_from_error.html", "structkuzu_1_1processor_1_1_populated_copy_from_error" ],
+        [ "ResultSet", "classkuzu_1_1processor_1_1_result_set.html", "classkuzu_1_1processor_1_1_result_set" ],
+        [ "ResultSetDescriptor", "structkuzu_1_1processor_1_1_result_set_descriptor.html", "structkuzu_1_1processor_1_1_result_set_descriptor" ],
         [ "WarningContext", "classkuzu_1_1processor_1_1_warning_context.html", "classkuzu_1_1processor_1_1_warning_context" ],
         [ "WarningInfo", "structkuzu_1_1processor_1_1_warning_info.html", "structkuzu_1_1processor_1_1_warning_info" ],
         [ "WarningSourceData", "structkuzu_1_1processor_1_1_warning_source_data.html", "structkuzu_1_1processor_1_1_warning_source_data" ]
@@ -189,7 +215,8 @@ var annotated_dup =
       [ "transaction", "namespacekuzu_1_1transaction.html", [
         [ "Transaction", "classkuzu_1_1transaction_1_1_transaction.html", "classkuzu_1_1transaction_1_1_transaction" ],
         [ "TransactionContext", "classkuzu_1_1transaction_1_1_transaction_context.html", "classkuzu_1_1transaction_1_1_transaction_context" ]
-      ] ]
+      ] ],
+      [ "OPPrintInfo", "structkuzu_1_1_o_p_print_info.html", "structkuzu_1_1_o_p_print_info" ]
     ] ],
     [ "std", null, [
       [ "hash< kuzu::common::int128_t >", "structstd_1_1hash_3_01kuzu_1_1common_1_1int128__t_01_4.html", "structstd_1_1hash_3_01kuzu_1_1common_1_1int128__t_01_4" ]

cpp/annotated_dup.js

@@ -271,7 +271,7 @@
 <div class="ttc" id="aclasskuzu_1_1common_1_1_struct_auxiliary_buffer_html_abdf8207dba8cf50fd9bcca1430085663"><div class="ttname"><a href="classkuzu_1_1common_1_1_struct_auxiliary_buffer.html#abdf8207dba8cf50fd9bcca1430085663">kuzu::common::StructAuxiliaryBuffer::StructAuxiliaryBuffer</a></div><div class="ttdeci">StructAuxiliaryBuffer(const LogicalType &amp;type, storage::MemoryManager *memoryManager)</div></div>
 <div class="ttc" id="aclasskuzu_1_1common_1_1_struct_auxiliary_buffer_html_ac019ce18aef6486e8a1e84bf0bdc5009"><div class="ttname"><a href="classkuzu_1_1common_1_1_struct_auxiliary_buffer.html#ac019ce18aef6486e8a1e84bf0bdc5009">kuzu::common::StructAuxiliaryBuffer::getFieldVectors</a></div><div class="ttdeci">const std::vector&lt; std::shared_ptr&lt; ValueVector &gt; &gt; &amp; getFieldVectors() const</div><div class="ttdef"><b>Definition</b> auxiliary_buffer.h:53</div></div>
 <div class="ttc" id="aclasskuzu_1_1common_1_1_struct_auxiliary_buffer_html_afcbcedd97b52dcac41f93f20ea45a8cf"><div class="ttname"><a href="classkuzu_1_1common_1_1_struct_auxiliary_buffer.html#afcbcedd97b52dcac41f93f20ea45a8cf">kuzu::common::StructAuxiliaryBuffer::getFieldVectorPtr</a></div><div class="ttdeci">ValueVector * getFieldVectorPtr(idx_t idx) const</div><div class="ttdef"><b>Definition</b> auxiliary_buffer.h:59</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html">kuzu::common::ValueVector</a></div><div class="ttdef"><b>Definition</b> value_vector.h:21</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html">kuzu::common::ValueVector</a></div><div class="ttdef"><b>Definition</b> value_vector.h:20</div></div>
 <div class="ttc" id="ain__mem__overflow__buffer_8h_html"><div class="ttname"><a href="in__mem__overflow__buffer_8h.html">in_mem_overflow_buffer.h</a></div></div>
 <div class="ttc" id="anamespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdef"><b>Definition</b> auxiliary_buffer.h:7</div></div>
 <div class="ttc" id="anamespacekuzu_1_1common_html_a205bbe18b53bc41f95e9fcd27055b56d"><div class="ttname"><a href="namespacekuzu_1_1common.html#a205bbe18b53bc41f95e9fcd27055b56d">kuzu::common::idx_t</a></div><div class="ttdeci">uint32_t idx_t</div><div class="ttdef"><b>Definition</b> types.h:45</div></div>

cpp/auxiliary__buffer_8h_source.html

@@ -581,18 +581,18 @@
 </div>
 <div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span>} <span class="comment">// namespace kuzu</span></div>
 <div class="ttc" id="aassert_8h_html_a15c7c828c306c4dbb80e0eb3ba333293"><div class="ttname"><a href="assert_8h.html#a15c7c828c306c4dbb80e0eb3ba333293">KU_ASSERT</a></div><div class="ttdeci">#define KU_ASSERT(condition)</div><div class="ttdef"><b>Definition</b> assert.h:19</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_selection_vector_html"><div class="ttname"><a href="classkuzu_1_1common_1_1_selection_vector.html">kuzu::common::SelectionVector</a></div><div class="ttdef"><b>Definition</b> sel_vector.h:14</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_selection_vector_html_ae3d02b1ed767b0d3d9606e7a9ab59a5a"><div class="ttname"><a href="classkuzu_1_1common_1_1_selection_vector.html#ae3d02b1ed767b0d3d9606e7a9ab59a5a">kuzu::common::SelectionVector::getMutableBuffer</a></div><div class="ttdeci">std::span&lt; sel_t &gt; getMutableBuffer() const</div><div class="ttdef"><b>Definition</b> sel_vector.h:78</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_selection_vector_html_af0f812a43604466a9c3114de526d7b43"><div class="ttname"><a href="classkuzu_1_1common_1_1_selection_vector.html#af0f812a43604466a9c3114de526d7b43">kuzu::common::SelectionVector::setSelSize</a></div><div class="ttdeci">void setSelSize(sel_t size)</div><div class="ttdef"><b>Definition</b> sel_vector.h:100</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html">kuzu::common::ValueVector</a></div><div class="ttdef"><b>Definition</b> value_vector.h:21</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_a1c1651c945f1a523ca72b7054a3c05a6"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#a1c1651c945f1a523ca72b7054a3c05a6">kuzu::common::ValueVector::getData</a></div><div class="ttdeci">uint8_t * getData() const</div><div class="ttdef"><b>Definition</b> value_vector.h:111</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_selection_vector_html"><div class="ttname"><a href="classkuzu_1_1common_1_1_selection_vector.html">kuzu::common::SelectionVector</a></div><div class="ttdef"><b>Definition</b> sel_vector.h:13</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_selection_vector_html_ae3d02b1ed767b0d3d9606e7a9ab59a5a"><div class="ttname"><a href="classkuzu_1_1common_1_1_selection_vector.html#ae3d02b1ed767b0d3d9606e7a9ab59a5a">kuzu::common::SelectionVector::getMutableBuffer</a></div><div class="ttdeci">std::span&lt; sel_t &gt; getMutableBuffer() const</div><div class="ttdef"><b>Definition</b> sel_vector.h:68</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_selection_vector_html_af0f812a43604466a9c3114de526d7b43"><div class="ttname"><a href="classkuzu_1_1common_1_1_selection_vector.html#af0f812a43604466a9c3114de526d7b43">kuzu::common::SelectionVector::setSelSize</a></div><div class="ttdeci">void setSelSize(sel_t size)</div><div class="ttdef"><b>Definition</b> sel_vector.h:90</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html">kuzu::common::ValueVector</a></div><div class="ttdef"><b>Definition</b> value_vector.h:20</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_a1c1651c945f1a523ca72b7054a3c05a6"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#a1c1651c945f1a523ca72b7054a3c05a6">kuzu::common::ValueVector::getData</a></div><div class="ttdeci">uint8_t * getData() const</div><div class="ttdef"><b>Definition</b> value_vector.h:99</div></div>
 <div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_a2836651b97f1805a06ba83b77aa900a6"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#a2836651b97f1805a06ba83b77aa900a6">kuzu::common::ValueVector::resetAuxiliaryBuffer</a></div><div class="ttdeci">void resetAuxiliaryBuffer()</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_a69814348344f25d60043a2663f55b2ca"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#a69814348344f25d60043a2663f55b2ca">kuzu::common::ValueVector::setAllNonNull</a></div><div class="ttdeci">void setAllNonNull()</div><div class="ttdef"><b>Definition</b> value_vector.h:68</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_a80662809ebd4a4e5e92f3aa89c812eae"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#a80662809ebd4a4e5e92f3aa89c812eae">kuzu::common::ValueVector::isNull</a></div><div class="ttdeci">uint8_t isNull(uint32_t pos) const</div><div class="ttdef"><b>Definition</b> value_vector.h:76</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_ab7739fee18ef97d03799caf39b30c5b2"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#ab7739fee18ef97d03799caf39b30c5b2">kuzu::common::ValueVector::hasNoNullsGuarantee</a></div><div class="ttdeci">bool hasNoNullsGuarantee() const</div><div class="ttdef"><b>Definition</b> value_vector.h:70</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_ab9d79923d14e4c321c682cf97c5da223"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#ab9d79923d14e4c321c682cf97c5da223">kuzu::common::ValueVector::setAllNull</a></div><div class="ttdeci">void setAllNull()</div><div class="ttdef"><b>Definition</b> value_vector.h:67</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_a69814348344f25d60043a2663f55b2ca"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#a69814348344f25d60043a2663f55b2ca">kuzu::common::ValueVector::setAllNonNull</a></div><div class="ttdeci">void setAllNonNull()</div><div class="ttdef"><b>Definition</b> value_vector.h:56</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_a80662809ebd4a4e5e92f3aa89c812eae"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#a80662809ebd4a4e5e92f3aa89c812eae">kuzu::common::ValueVector::isNull</a></div><div class="ttdeci">uint8_t isNull(uint32_t pos) const</div><div class="ttdef"><b>Definition</b> value_vector.h:64</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_ab7739fee18ef97d03799caf39b30c5b2"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#ab7739fee18ef97d03799caf39b30c5b2">kuzu::common::ValueVector::hasNoNullsGuarantee</a></div><div class="ttdeci">bool hasNoNullsGuarantee() const</div><div class="ttdef"><b>Definition</b> value_vector.h:58</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_ab9d79923d14e4c321c682cf97c5da223"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#ab9d79923d14e4c321c682cf97c5da223">kuzu::common::ValueVector::setAllNull</a></div><div class="ttdeci">void setAllNull()</div><div class="ttdef"><b>Definition</b> value_vector.h:55</div></div>
 <div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_adff0525b9a9d01f900b5b82424df2451"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#adff0525b9a9d01f900b5b82424df2451">kuzu::common::ValueVector::setNull</a></div><div class="ttdeci">void setNull(uint32_t pos, bool isNull)</div></div>
-<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_aed355978414b9b29385aed6497213f17"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#aed355978414b9b29385aed6497213f17">kuzu::common::ValueVector::state</a></div><div class="ttdeci">std::shared_ptr&lt; DataChunkState &gt; state</div><div class="ttdef"><b>Definition</b> value_vector.h:134</div></div>
+<div class="ttc" id="aclasskuzu_1_1common_1_1_value_vector_html_aed355978414b9b29385aed6497213f17"><div class="ttname"><a href="classkuzu_1_1common_1_1_value_vector.html#aed355978414b9b29385aed6497213f17">kuzu::common::ValueVector::state</a></div><div class="ttdeci">std::shared_ptr&lt; DataChunkState &gt; state</div><div class="ttdef"><b>Definition</b> value_vector.h:122</div></div>
 <div class="ttc" id="anamespacekuzu_1_1function_html"><div class="ttname"><a href="namespacekuzu_1_1function.html">kuzu::function</a></div><div class="ttdef"><b>Definition</b> binary_function_executor.h:6</div></div>
 <div class="ttc" id="anamespacekuzu_html"><div class="ttname"><a href="namespacekuzu.html">kuzu</a></div><div class="ttdef"><b>Definition</b> array_utils.h:7</div></div>
 <div class="ttc" id="astructkuzu_1_1function_1_1_binary_comparison_function_wrapper_html"><div class="ttname"><a href="structkuzu_1_1function_1_1_binary_comparison_function_wrapper.html">kuzu::function::BinaryComparisonFunctionWrapper</a></div><div class="ttdef"><b>Definition</b> binary_function_executor.h:60</div></div>