ee1dd91b7f
All checks were successful
Build / Build (push) Successful in 40s
This commit adds documentation for the `ramdb_db_fnc_fetch` function. The documentation explains the function's purpose, which is to handle data chunks received from the database extension when data is too large to be returned in a single callback. The documentation includes a title, icon, and excerpt for better readability and understanding.
56 lines
2.2 KiB
XML
56 lines
2.2 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_dir_2d423acf5473bc48906ca316d2995d8f" xml:lang="en-US">
|
|
<title>docs/basic Directory Reference</title>
|
|
<indexterm><primary>docs/basic Directory Reference</primary></indexterm>
|
|
<section>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>This section contains documentation for the basic data operations of ArmaRAMDb that allow for simple key-value storage and retrieval.</para>
|
|
<section xml:id="_README.md_1autotoc_md50">
|
|
<title>Available Functions</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><link linkend="_md_docs_2basic_2delete">delete</link> - Delete a value from the database</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2basic_2fetch">fetch</link> - Fetch a value from the database</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2basic_2get">get</link> - Get a value from the database</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2basic_2load">load</link> - Load the database from disk</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2basic_2save">save</link> - Save the database to disk</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2basic_2set">set</link> - Set a value in the database</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md51">
|
|
<title>Example Usage</title>
|
|
<para><literallayout><computeroutput>// Set a value
|
|
["myKey", [myValue]] call ramdb_db_fnc_set;
|
|
|
|
// Get a value
|
|
["myKey", "myFunction"] call ramdb_db_fnc_get;
|
|
|
|
// Delete a key
|
|
["myKey"] call ramdb_db_fnc_delete;
|
|
|
|
// Save database to disk
|
|
[] call ramdb_db_fnc_save;
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md52">
|
|
<title>Related Categories</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para>Core Functions</para>
|
|
</listitem><listitem>
|
|
<para>Hash Operations</para>
|
|
</listitem><listitem>
|
|
<para>List Operations </para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</section>
|