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.
77 lines
3.8 KiB
XML
77 lines
3.8 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_68588e5a097ce704ed28814d68b1b590" xml:lang="en-US">
|
|
<title>docs/hash Directory Reference</title>
|
|
<indexterm><primary>docs/hash Directory Reference</primary></indexterm>
|
|
<section>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>This section contains documentation for the hash operations of ArmaRAMDb that allow for working with hash tables (key-value pairs within a namespace).</para>
|
|
<section xml:id="_README.md_1autotoc_md344">
|
|
<title>Available Functions</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_delete">hashDelete</link> - Delete a hash</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_delete_id">hashDeleteId</link> - Delete a hash for a specific ID</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_get">hashGet</link> - Get a field from a hash</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_get_all">hashGetAll</link> - Get all fields from a hash</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_get_all_id">hashGetAllId</link> - Get all fields from a hash for a specific ID</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_get_id">hashGetId</link> - Get a field from a hash for a specific ID</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_remove">hashRemove</link> - Remove a field from a hash</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_remove_id">hashRemoveId</link> - Remove a field from a hash for a specific ID</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_set">hashSet</link> - Set a field in a hash</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_set_bulk">hashSetBulk</link> - Set multiple fields in a hash in one operation</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_set_id">hashSetId</link> - Set a field in a hash for a specific ID</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2hash_2hash_set_id_bulk">hashSetIdBulk</link> - Set multiple fields in a hash for a specific ID in one operation</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md345">
|
|
<title>Example Usage</title>
|
|
<para><literallayout><computeroutput>// Context mode examples
|
|
["myField", [myValue]] call ramdb_db_fnc_hashSet;
|
|
["myField", "myFunction"] call ramdb_db_fnc_hashGet;
|
|
["myFunction"] call ramdb_db_fnc_hashGetAll;
|
|
["myField"] call ramdb_db_fnc_hashRemove;
|
|
[] call ramdb_db_fnc_hashDelete;
|
|
|
|
// Set multiple hash fields in one operation
|
|
[[
|
|
    "loadout", [getUnitLoadout player],
|
|
    "position", [getPosASL player],
|
|
    "direction", [getDir player]
|
|
]] call ramdb_db_fnc_hashSetBulk;
|
|
|
|
// ID-specific examples
|
|
["myHash", "myField", [myValue]] call ramdb_db_fnc_hashSetId;
|
|
["myHash", "myField", "myFunction"] call ramdb_db_fnc_hashGetId;
|
|
["myHash"] call ramdb_db_fnc_hashGetAllId;
|
|
["myHash", "myField"] call ramdb_db_fnc_hashRemoveId;
|
|
["myHash"] call ramdb_db_fnc_hashDeleteId;
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md346">
|
|
<title>Related Categories</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para>Core Functions</para>
|
|
</listitem><listitem>
|
|
<para>Basic Data Operations</para>
|
|
</listitem><listitem>
|
|
<para>List Operations </para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</section>
|