Skip to content
This repository was archived by the owner on Oct 10, 2025. It is now read-only.

Commit c77f7fb

Browse files
author
CI User
committed
Update API documentations
1 parent c3ad5f8 commit c77f7fb

File tree

208 files changed

+5948
-4327
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

208 files changed

+5948
-4327
lines changed

cpp/annotated.html

Lines changed: 18 additions & 16 deletions
Large diffs are not rendered by default.

cpp/annotated_dup.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,8 @@ var annotated_dup =
161161
] ],
162162
[ "main", "namespacekuzu_1_1main.html", [
163163
[ "ActiveQuery", "structkuzu_1_1main_1_1_active_query.html", "structkuzu_1_1main_1_1_active_query" ],
164+
[ "CachedPreparedStatement", "structkuzu_1_1main_1_1_cached_prepared_statement.html", "structkuzu_1_1main_1_1_cached_prepared_statement" ],
165+
[ "CachedPreparedStatementManager", "classkuzu_1_1main_1_1_cached_prepared_statement_manager.html", "classkuzu_1_1main_1_1_cached_prepared_statement_manager" ],
164166
[ "ClientConfig", "structkuzu_1_1main_1_1_client_config.html", "structkuzu_1_1main_1_1_client_config" ],
165167
[ "ClientConfigDefault", "structkuzu_1_1main_1_1_client_config_default.html", null ],
166168
[ "ClientContext", "classkuzu_1_1main_1_1_client_context.html", "classkuzu_1_1main_1_1_client_context" ],

cpp/bind__input_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@
171171
<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>
172172
<div class="ttc" id="acase__insensitive__map_8h_html"><div class="ttname"><a href="case__insensitive__map_8h.html">case_insensitive_map.h</a></div></div>
173173
<div class="ttc" id="aclasskuzu_1_1common_1_1_value_html"><div class="ttname"><a href="classkuzu_1_1common_1_1_value.html">kuzu::common::Value</a></div><div class="ttdef"><b>Definition</b> value.h:26</div></div>
174-
<div class="ttc" id="aclasskuzu_1_1main_1_1_client_context_html"><div class="ttname"><a href="classkuzu_1_1main_1_1_client_context.html">kuzu::main::ClientContext</a></div><div class="ttdoc">Contain client side configuration. We make profiler associated per query, so the profiler is not main...</div><div class="ttdef"><b>Definition</b> client_context.h:68</div></div>
174+
<div class="ttc" id="aclasskuzu_1_1main_1_1_client_context_html"><div class="ttname"><a href="classkuzu_1_1main_1_1_client_context.html">kuzu::main::ClientContext</a></div><div class="ttdoc">Contain client side configuration. We make profiler associated per query, so the profiler is not main...</div><div class="ttdef"><b>Definition</b> client_context.h:69</div></div>
175175
<div class="ttc" id="aexpression_8h_html"><div class="ttname"><a href="expression_8h.html">expression.h</a></div></div>
176176
<div class="ttc" id="afile__scan__info_8h_html"><div class="ttname"><a href="file__scan__info_8h.html">file_scan_info.h</a></div></div>
177177
<div class="ttc" id="anamespacekuzu_1_1binder_html"><div class="ttname"><a href="namespacekuzu_1_1binder.html">kuzu::binder</a></div><div class="ttdef"><b>Definition</b> bind_input.h:12</div></div>

cpp/cast__function__bind__data_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
110110
<div class="foldopen" id="foldopen00016" data-start="{" data-end="}">
111111
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="structkuzu_1_1function_1_1_cast_function_bind_data.html#a821acbe1abc6dae82195abd59cb5c991"> 16</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="structkuzu_1_1function_1_1_cast_function_bind_data.html#a821acbe1abc6dae82195abd59cb5c991">CastFunctionBindData</a>(<a class="code hl_class" href="classkuzu_1_1common_1_1_logical_type.html">common::LogicalType</a> dataType)</div>
112-
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> : <a class="code hl_function" href="structkuzu_1_1function_1_1_function_bind_data.html#ab1080c68dcec4a5b96abce74f3cab854">FunctionBindData</a>{std::move(dataType)}, <a class="code hl_variable" href="structkuzu_1_1function_1_1_cast_function_bind_data.html#ade4a7d4811d969c15ba7ab406b49d60f">numOfEntries</a>(0) {}</div>
112+
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> : <a class="code hl_function" href="structkuzu_1_1function_1_1_function_bind_data.html#ab1080c68dcec4a5b96abce74f3cab854">FunctionBindData</a>{std::move(dataType)}, <a class="code hl_variable" href="structkuzu_1_1function_1_1_cast_function_bind_data.html#ade4a7d4811d969c15ba7ab406b49d60f">numOfEntries</a>{0} {}</div>
113113
</div>
114114
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
115115
<div class="foldopen" id="foldopen00019" data-start="{" data-end="}">

cpp/classes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
<dd><a class="el" href="structkuzu_1_1function_1_1_binary_comparison_function_wrapper.html">BinaryComparisonFunctionWrapper</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_function_executor_1_1_binary_comparison_select_wrapper.html">BinaryFunctionExecutor::BinaryComparisonSelectWrapper</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_function_executor.html">BinaryFunctionExecutor</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_function_wrapper.html">BinaryFunctionWrapper</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_list_extract_function_wrapper.html">BinaryListExtractFunctionWrapper</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_list_struct_function_wrapper.html">BinaryListStructFunctionWrapper</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_map_creation_function_wrapper.html">BinaryMapCreationFunctionWrapper</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_select_with_bind_data_wrapper.html">BinarySelectWithBindDataWrapper</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_function_executor_1_1_binary_select_wrapper.html">BinaryFunctionExecutor::BinarySelectWrapper</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_string_function_wrapper.html">BinaryStringFunctionWrapper</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_u_d_f_executor.html">BinaryUDFExecutor</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_binary_u_d_f_function_wrapper.html">BinaryUDFFunctionWrapper</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="classkuzu_1_1common_1_1_binder_exception.html">BinderException</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_blob.html">Blob</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1blob__t.html">blob_t</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_blob_vector.html">BlobVector</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_buffer_block.html">BufferBlock</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_buffer_pool_constants.html">BufferPoolConstants</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd></dl>
102102
<dl class="classindex even">
103103
<dt class="alphachar"><a id="letter_C" name="letter_C">C</a></dt>
104-
<dd><a class="el" href="structkuzu_1_1common_1_1_case_insensitive_string_equality.html">CaseInsensitiveStringEquality</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_case_insensitive_string_hash_function.html">CaseInsensitiveStringHashFunction</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_cast_function_bind_data.html">CastFunctionBindData</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="classkuzu_1_1common_1_1_catalog_exception.html">CatalogException</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1main_1_1_client_config.html">ClientConfig</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="structkuzu_1_1main_1_1_client_config_default.html">ClientConfigDefault</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="classkuzu_1_1main_1_1_client_context.html">ClientContext</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="structkuzu_1_1main_1_1_configuration_option.html">ConfigurationOption</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="classkuzu_1_1main_1_1_connection.html">Connection</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_const_function_executor.html">ConstFunctionExecutor</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_copy_constants.html">CopyConstants</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1processor_1_1_copy_from_file_error.html">CopyFromFileError</a> (<a class="el" href="namespacekuzu_1_1processor.html">kuzu::processor</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_c_s_v_option.html">CSVOption</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_c_s_v_reader_config.html">CSVReaderConfig</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd></dl>
104+
<dd><a class="el" href="structkuzu_1_1main_1_1_cached_prepared_statement.html">CachedPreparedStatement</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="classkuzu_1_1main_1_1_cached_prepared_statement_manager.html">CachedPreparedStatementManager</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_case_insensitive_string_equality.html">CaseInsensitiveStringEquality</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_case_insensitive_string_hash_function.html">CaseInsensitiveStringHashFunction</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_cast_function_bind_data.html">CastFunctionBindData</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="classkuzu_1_1common_1_1_catalog_exception.html">CatalogException</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1main_1_1_client_config.html">ClientConfig</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="structkuzu_1_1main_1_1_client_config_default.html">ClientConfigDefault</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="classkuzu_1_1main_1_1_client_context.html">ClientContext</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="structkuzu_1_1main_1_1_configuration_option.html">ConfigurationOption</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="classkuzu_1_1main_1_1_connection.html">Connection</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="structkuzu_1_1function_1_1_const_function_executor.html">ConstFunctionExecutor</a> (<a class="el" href="namespacekuzu_1_1function.html">kuzu::function</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_copy_constants.html">CopyConstants</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1processor_1_1_copy_from_file_error.html">CopyFromFileError</a> (<a class="el" href="namespacekuzu_1_1processor.html">kuzu::processor</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_c_s_v_option.html">CSVOption</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_c_s_v_reader_config.html">CSVReaderConfig</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd></dl>
105105
<dl class="classindex odd">
106106
<dt class="alphachar"><a id="letter_D" name="letter_D">D</a></dt>
107107
<dd><a class="el" href="classkuzu_1_1main_1_1_database.html">Database</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_database_life_cycle_manager.html">DatabaseLifeCycleManager</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="classkuzu_1_1common_1_1_data_chunk.html">DataChunk</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1processor_1_1_data_chunk_descriptor.html">DataChunkDescriptor</a> (<a class="el" href="namespacekuzu_1_1processor.html">kuzu::processor</a>)</dd><dd><a class="el" href="classkuzu_1_1common_1_1_data_chunk_state.html">DataChunkState</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1processor_1_1_data_pos.html">DataPos</a> (<a class="el" href="namespacekuzu_1_1processor.html">kuzu::processor</a>)</dd><dd><a class="el" href="classkuzu_1_1common_1_1_date.html">Date</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1date__t.html">date_t</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1main_1_1_d_b_config.html">DBConfig</a> (<a class="el" href="namespacekuzu_1_1main.html">kuzu::main</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1_decimal_type.html">DecimalType</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="classkuzu_1_1common_1_1_decimal_type_info.html">DecimalTypeInfo</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd><dd><a class="el" href="structkuzu_1_1common_1_1dtime__t.html">dtime_t</a> (<a class="el" href="namespacekuzu_1_1common.html">kuzu::common</a>)</dd></dl>

cpp/classkuzu_1_1common_1_1_union_vector-members.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,11 @@
9494

9595
<p>This is the complete list of members for <a class="el" href="classkuzu_1_1common_1_1_union_vector.html">kuzu::common::UnionVector</a>, including all inherited members.</p>
9696
<table class="directory">
97-
<tr class="even"><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html#acd5779ca302d1ac33c37add4f6cf7f6c">getTagVector</a>(const ValueVector *vector)</td><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html">kuzu::common::UnionVector</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
98-
<tr class="odd"><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html#ab637c4ffe6a051415027b0d8038b9963">getValVector</a>(const ValueVector *vector, union_field_idx_t fieldIdx)</td><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html">kuzu::common::UnionVector</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
99-
<tr class="even"><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html#ab5aabb6dbe889224c73b95985fc9ca17">referenceVector</a>(ValueVector *vector, union_field_idx_t fieldIdx, std::shared_ptr&lt; ValueVector &gt; vectorToReference)</td><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html">kuzu::common::UnionVector</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
100-
<tr class="odd"><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html#aadbd57ce2dbe880eebaabe2df6b312e3">setTagField</a>(ValueVector &amp;vector, SelectionVector &amp;sel, union_field_idx_t tag)</td><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html">kuzu::common::UnionVector</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
97+
<tr class="even"><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html#aab76ff1a4122da2986209769528b1dc4">getSharedValVector</a>(const ValueVector *vector, union_field_idx_t fieldIdx)</td><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html">kuzu::common::UnionVector</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
98+
<tr class="odd"><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html#acd5779ca302d1ac33c37add4f6cf7f6c">getTagVector</a>(const ValueVector *vector)</td><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html">kuzu::common::UnionVector</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
99+
<tr class="even"><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html#ab637c4ffe6a051415027b0d8038b9963">getValVector</a>(const ValueVector *vector, union_field_idx_t fieldIdx)</td><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html">kuzu::common::UnionVector</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
100+
<tr class="odd"><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html#ab5aabb6dbe889224c73b95985fc9ca17">referenceVector</a>(ValueVector *vector, union_field_idx_t fieldIdx, std::shared_ptr&lt; ValueVector &gt; vectorToReference)</td><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html">kuzu::common::UnionVector</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
101+
<tr class="even"><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html#aadbd57ce2dbe880eebaabe2df6b312e3">setTagField</a>(ValueVector &amp;vector, SelectionVector &amp;sel, union_field_idx_t tag)</td><td class="entry"><a class="el" href="classkuzu_1_1common_1_1_union_vector.html">kuzu::common::UnionVector</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
101102
</table></div><!-- contents -->
102103
</div><!-- doc-content -->
103104
</div><!-- container -->

0 commit comments

Comments
 (0)