Skip to content

Commit d65644b

Browse files
authored
Merge pull request #13 from kuzudb/api-documentation-update-4a0e1078d3624d9764af4de0cabe646dbd8cf1f5
Update API documentations
2 parents 3c844a7 + 9c74d47 commit d65644b

File tree

139 files changed

+2017
-2183
lines changed

Some content is hidden

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

139 files changed

+2017
-2183
lines changed

c/doxygen_crawl.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
<a href="kuzu_8h.html#a2c7114f3d1d2f5edc07a01bd60dca6f0"/>
5555
<a href="kuzu_8h.html#a30633438adfe0b8dcde9f6a3831bfc47"/>
5656
<a href="kuzu_8h.html#a33226176d0291d381c06db65b2c5f990"/>
57+
<a href="kuzu_8h.html#a342feabe91a5fdc71da7c49be536da09"/>
5758
<a href="kuzu_8h.html#a3488703918c79dacf782b949db0427d9"/>
5859
<a href="kuzu_8h.html#a3627843732d3749fd3c0d71e46fe42d2"/>
5960
<a href="kuzu_8h.html#a3745aea6592cea166a6061db809e1227"/>

c/globals_func.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ <h3 class="doxsection"><a id="index_k" name="index_k"></a>- k -</h3><ul>
156156
<li>kuzu_query_summary_get_compiling_time()&#160;:&#160;<a class="el" href="kuzu_8h.html#a0e445abcd6a05080d9d3b7cc261555c1">kuzu.h</a></li>
157157
<li>kuzu_query_summary_get_execution_time()&#160;:&#160;<a class="el" href="kuzu_8h.html#a79b3be2fd6b18858d6e87b5c52cc1584">kuzu.h</a></li>
158158
<li>kuzu_rel_val_get_dst_id_val()&#160;:&#160;<a class="el" href="kuzu_8h.html#ad93fd4a51fb180223f52b7d71b9b7881">kuzu.h</a></li>
159+
<li>kuzu_rel_val_get_id_val()&#160;:&#160;<a class="el" href="kuzu_8h.html#a342feabe91a5fdc71da7c49be536da09">kuzu.h</a></li>
159160
<li>kuzu_rel_val_get_label_val()&#160;:&#160;<a class="el" href="kuzu_8h.html#a77e68ed24b19cf20e846e0bbba5c2632">kuzu.h</a></li>
160161
<li>kuzu_rel_val_get_property_name_at()&#160;:&#160;<a class="el" href="kuzu_8h.html#a763cd8c5d4c61b6eb3f6dcbf8da1e1d8">kuzu.h</a></li>
161162
<li>kuzu_rel_val_get_property_size()&#160;:&#160;<a class="el" href="kuzu_8h.html#a2a3e4a519b9da1d23c01eb2c2ecaf463">kuzu.h</a></li>

c/globals_k.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,7 @@ <h3 class="doxsection"><a id="index_k" name="index_k"></a>- k -</h3><ul>
186186
<li>KUZU_RECURSIVE_REL&#160;:&#160;<a class="el" href="kuzu_8h.html#a402bc5ef3e9b9a57ba391e317023f8aeab4082d1735d8ed2ffa77a036f37e648e">kuzu.h</a></li>
187187
<li>KUZU_REL&#160;:&#160;<a class="el" href="kuzu_8h.html#a402bc5ef3e9b9a57ba391e317023f8aea6cd5d8bef332b86efc89646136936013">kuzu.h</a></li>
188188
<li>kuzu_rel_val_get_dst_id_val()&#160;:&#160;<a class="el" href="kuzu_8h.html#ad93fd4a51fb180223f52b7d71b9b7881">kuzu.h</a></li>
189+
<li>kuzu_rel_val_get_id_val()&#160;:&#160;<a class="el" href="kuzu_8h.html#a342feabe91a5fdc71da7c49be536da09">kuzu.h</a></li>
189190
<li>kuzu_rel_val_get_label_val()&#160;:&#160;<a class="el" href="kuzu_8h.html#a77e68ed24b19cf20e846e0bbba5c2632">kuzu.h</a></li>
190191
<li>kuzu_rel_val_get_property_name_at()&#160;:&#160;<a class="el" href="kuzu_8h.html#a763cd8c5d4c61b6eb3f6dcbf8da1e1d8">kuzu.h</a></li>
191192
<li>kuzu_rel_val_get_property_size()&#160;:&#160;<a class="el" href="kuzu_8h.html#a2a3e4a519b9da1d23c01eb2c2ecaf463">kuzu.h</a></li>

c/kuzu_8h.html

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,8 @@
466466
<tr class="memdesc:a7bb21065315fc4464d74ffe1fd6ec294"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the property value of the given node value at the given index. <br /></td></tr>
467467
<tr class="memitem:a74e14da912136aa40efb60f2cdb67403" id="r_a74e14da912136aa40efb60f2cdb67403"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a4c6ca4127ef18db01d41608c5e59aa3b">KUZU_C_API</a> <a class="el" href="#a5d32b0237a5f85124a55c496d2fdf92a">kuzu_state</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a74e14da912136aa40efb60f2cdb67403">kuzu_node_val_to_string</a> (<a class="el" href="structkuzu__value.html">kuzu_value</a> *node_val, char **out_result)</td></tr>
468468
<tr class="memdesc:a74e14da912136aa40efb60f2cdb67403"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the given node value to string. <br /></td></tr>
469+
<tr class="memitem:a342feabe91a5fdc71da7c49be536da09" id="r_a342feabe91a5fdc71da7c49be536da09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a4c6ca4127ef18db01d41608c5e59aa3b">KUZU_C_API</a> <a class="el" href="#a5d32b0237a5f85124a55c496d2fdf92a">kuzu_state</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a342feabe91a5fdc71da7c49be536da09">kuzu_rel_val_get_id_val</a> (<a class="el" href="structkuzu__value.html">kuzu_value</a> *rel_val, <a class="el" href="structkuzu__value.html">kuzu_value</a> *out_value)</td></tr>
470+
<tr class="memdesc:a342feabe91a5fdc71da7c49be536da09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the internal id value of the rel value as a kuzu value. <br /></td></tr>
469471
<tr class="memitem:a240039baef75d57f3fbfeb3cedbccd1d" id="r_a240039baef75d57f3fbfeb3cedbccd1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a4c6ca4127ef18db01d41608c5e59aa3b">KUZU_C_API</a> <a class="el" href="#a5d32b0237a5f85124a55c496d2fdf92a">kuzu_state</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a240039baef75d57f3fbfeb3cedbccd1d">kuzu_rel_val_get_src_id_val</a> (<a class="el" href="structkuzu__value.html">kuzu_value</a> *rel_val, <a class="el" href="structkuzu__value.html">kuzu_value</a> *out_value)</td></tr>
470472
<tr class="memdesc:a240039baef75d57f3fbfeb3cedbccd1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the internal id value of the source node of the given rel value as a kuzu value. <br /></td></tr>
471473
<tr class="memitem:ad93fd4a51fb180223f52b7d71b9b7881" id="r_ad93fd4a51fb180223f52b7d71b9b7881"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a4c6ca4127ef18db01d41608c5e59aa3b">KUZU_C_API</a> <a class="el" href="#a5d32b0237a5f85124a55c496d2fdf92a">kuzu_state</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad93fd4a51fb180223f52b7d71b9b7881">kuzu_rel_val_get_dst_id_val</a> (<a class="el" href="structkuzu__value.html">kuzu_value</a> *rel_val, <a class="el" href="structkuzu__value.html">kuzu_value</a> *out_value)</td></tr>
@@ -3317,6 +3319,37 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad93fd4a51fb180223f52b7d7
33173319
</dl>
33183320
<dl class="section return"><dt>Returns</dt><dd>The state indicating the success or failure of the operation. </dd></dl>
33193321

3322+
</div>
3323+
</div>
3324+
<a id="a342feabe91a5fdc71da7c49be536da09" name="a342feabe91a5fdc71da7c49be536da09"></a>
3325+
<h2 class="memtitle"><span class="permalink"><a href="#a342feabe91a5fdc71da7c49be536da09">&#9670;&#160;</a></span>kuzu_rel_val_get_id_val()</h2>
3326+
3327+
<div class="memitem">
3328+
<div class="memproto">
3329+
<table class="memname">
3330+
<tr>
3331+
<td class="memname"><a class="el" href="#a4c6ca4127ef18db01d41608c5e59aa3b">KUZU_C_API</a> <a class="el" href="#a5d32b0237a5f85124a55c496d2fdf92a">kuzu_state</a> kuzu_rel_val_get_id_val </td>
3332+
<td>(</td>
3333+
<td class="paramtype"><a class="el" href="structkuzu__value.html">kuzu_value</a> *</td> <td class="paramname"><span class="paramname"><em>rel_val</em></span>, </td>
3334+
</tr>
3335+
<tr>
3336+
<td class="paramkey"></td>
3337+
<td></td>
3338+
<td class="paramtype"><a class="el" href="structkuzu__value.html">kuzu_value</a> *</td> <td class="paramname"><span class="paramname"><em>out_value</em></span>&#160;)</td>
3339+
</tr>
3340+
</table>
3341+
</div><div class="memdoc">
3342+
3343+
<p>Returns the internal id value of the rel value as a kuzu value. </p>
3344+
<dl class="params"><dt>Parameters</dt><dd>
3345+
<table class="params">
3346+
<tr><td class="paramdir"></td><td class="paramname">rel_val</td><td>The rel value to return. </td></tr>
3347+
<tr><td class="paramdir">[out]</td><td class="paramname">out_value</td><td>The output parameter that will hold the internal id value. </td></tr>
3348+
</table>
3349+
</dd>
3350+
</dl>
3351+
<dl class="section return"><dt>Returns</dt><dd>The state indicating the success or failure of the operation. </dd></dl>
3352+
33203353
</div>
33213354
</div>
33223355
<a id="a77e68ed24b19cf20e846e0bbba5c2632" name="a77e68ed24b19cf20e846e0bbba5c2632"></a>

0 commit comments

Comments
 (0)