Skip to content

Commit

Permalink
doc: Update references to include fetch functionality
Browse files Browse the repository at this point in the history
This commit adds references to the 'Fetch' functionality in the documentation.
- Updated links in the 'Usage' section to include 'Data Fetching'.
- Added links to 'Fetch' in the 'Reference' section.
- Included a new section 'Fetch' with detailed information on the function.
  • Loading branch information
AdaiasMagdiel committed Mar 14, 2024
1 parent a8f3569 commit 7467b39
Show file tree
Hide file tree
Showing 5 changed files with 253 additions and 15 deletions.
10 changes: 10 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -596,10 +596,19 @@ <h2 id="table-of-contents">Table of Contents</h2>
<li><a href="usage/#example-with-non-map-value-1">Example with Non-Map Value</a></li>
</ul>
</li>
<li><a href="usage/#using-the-fetch-function">Using the <code>fetch</code> Function</a><ul>
<li><a href="usage/#basic-usage-4">Basic Usage</a></li>
<li><a href="usage/#parameters">Parameters</a></li>
<li><a href="usage/#example-of-use">Example of Use</a></li>
<li><a href="usage/#return-value-and-exceptions-4">Return Value and Exceptions</a></li>
<li><a href="usage/#example-with-query-parameters">Example with Query Parameters</a></li>
</ul>
</li>
<li><a href="usage/#use-cases">Use Cases</a><ul>
<li><a href="usage/#data-insertion">Data Insertion</a></li>
<li><a href="usage/#data-retrieval">Data Retrieval</a></li>
<li><a href="usage/#data-removal">Data Removal</a></li>
<li><a href="usage/#data-fetching">Data Fetching</a></li>
</ul>
</li>
</ul>
Expand All @@ -610,6 +619,7 @@ <h2 id="table-of-contents">Table of Contents</h2>
<li><a href="reference/#get">Get</a></li>
<li><a href="reference/#delete">Delete</a></li>
<li><a href="reference/#insert">Insert</a></li>
<li><a href="reference/#fetch">Fetch</a></li>
</ul>
<p><a name="installation"></a></p>
<h2 id="installation">Installation</h2>
Expand Down
38 changes: 38 additions & 0 deletions docs/reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#fetch" class="md-nav__link">
<span class="md-ellipsis">
Fetch
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -416,6 +425,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#fetch" class="md-nav__link">
<span class="md-ellipsis">
Fetch
</span>
</a>

</li>

</ul>
Expand All @@ -441,6 +459,7 @@ <h2 id="table-of-contents">Table of Contents</h2>
<li><a href="#get">Get</a></li>
<li><a href="#delete">Delete</a></li>
<li><a href="#insert">Insert</a></li>
<li><a href="#fetch">Fetch</a></li>
</ul>
<p><a name="base"></a></p>
<h2 id="base">Base</h2>
Expand Down Expand Up @@ -484,6 +503,25 @@ <h2 id="insert">Insert</h2>
<li><strong>Return:</strong> Map containing the inserted data and the generated key (if not provided).</li>
<li><strong>Exceptions:</strong> Throws an <code>Exception</code> if the data type is not supported, or if <code>deta-key</code> is invalid or not provided, or if an item with the provided key already exists.</li>
</ul>
<p><a name="fetch"></a></p>
<h2 id="fetch">Fetch</h2>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="p">(</span><span class="nf">fetch</span><span class="w"> </span><span class="nv">db</span><span class="p">)</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="p">(</span><span class="nf">fetch</span><span class="w"> </span><span class="nv">db</span><span class="w"> </span><span class="nv">query</span><span class="p">)</span>
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="p">(</span><span class="nf">fetch</span><span class="w"> </span><span class="nv">db</span><span class="w"> </span><span class="nv">query</span><span class="w"> </span><span class="nv">parameters</span><span class="p">)</span>
</code></pre></div>
<ul>
<li>
<p><strong>Parameters:</strong></p>
<ul>
<li><code>db</code>: The database connection object.</li>
<li><code>query</code>: A string or list of strings representing the query to be executed.</li>
<li><code>parameters</code>: A map containing additional query parameters, including <code>limit</code>, <code>last</code>, and <code>desc</code>.</li>
</ul>
</li>
<li>
<p><strong>Return:</strong> A map containing the number of items found (<code>:count</code>), the last key queried (<code>:last</code>), and a list of the items found (<code>:items</code>). If the query fails, it returns a map with <code>:count</code> 0, <code>:last</code> <code>nil</code>, and <code>:items</code> an empty list.</p>
</li>
</ul>



Expand Down
2 changes: 1 addition & 1 deletion docs/search/search_index.json

Large diffs are not rendered by default.

Binary file modified docs/sitemap.xml.gz
Binary file not shown.
Loading

0 comments on commit 7467b39

Please sign in to comment.