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.
79 lines
4.9 KiB
XML
79 lines
4.9 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="_md_docs_2hash_2hash_delete" xml:lang="en-US">
|
|
<title>hashDelete</title>
|
|
<indexterm><primary>hashDelete</primary></indexterm>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md177">
|
|
<title>autotoc_md177</title>
|
|
<para>title: ArmaRAMDb - Hash Delete icon: mdi:file-text-outline </para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md178">
|
|
<title>excerpt: Remove the current client's hash table from database.</title></section>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md179">
|
|
<title>ramdb_db_fnc_hashDelete</title><section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md180">
|
|
<title>Description</title>
|
|
<para>Removes the hash table associated with the current client/player from the database. Unlike <computeroutput>hashDeleteId</computeroutput>, this function automatically retrieves the appropriate hash ID based on the caller's identity, making it more convenient for removing the current client's hash data. This is useful for cleanup operations when a player disconnects or when resetting a client's stored data.</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md181">
|
|
<title>Syntax</title>
|
|
<para><literallayout><computeroutput>[] call ramdb_db_fnc_hashDelete
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md182">
|
|
<title>Parameters</title>
|
|
<para>None. This function automatically determines the hash ID based on the calling client.</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md183">
|
|
<title>Return Value</title>
|
|
<para>None. The operation runs synchronously to delete the hash table for the current client.</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md184">
|
|
<title>Examples</title><section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md185">
|
|
<title>Delete the current client's hash table:</title>
|
|
<para><literallayout><computeroutput>[] call ramdb_db_fnc_hashDelete;
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md186">
|
|
<title>Delete a client's hash table from the server:</title>
|
|
<para><literallayout><computeroutput>[] remoteExecCall ["ramdb_db_fnc_hashDelete", 2, false];
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md187">
|
|
<title>Notes</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para>This function only removes the hash table for the current client/player, not all hash tables</para>
|
|
</listitem><listitem>
|
|
<para>It's similar to <computeroutput>hashDeleteId</computeroutput> but automatically determines the appropriate ID</para>
|
|
</listitem><listitem>
|
|
<para>Cannot be undone unless you have a backup</para>
|
|
</listitem><listitem>
|
|
<para>Should be used during player disconnection or when resetting a player's data</para>
|
|
</listitem><listitem>
|
|
<para>Useful for cleanup operations to prevent data buildup from disconnected players</para>
|
|
</listitem><listitem>
|
|
<para>More convenient than <computeroutput>hashDeleteId</computeroutput> when you want to remove the calling client's data</para>
|
|
</listitem><listitem>
|
|
<para>All operations are logged for debugging purposes</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md188">
|
|
<title>Related Functions</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><computeroutput>ramdb_db_fnc_hashDeleteId</computeroutput>: Removes a specific hash ID (when you need to specify the ID)</para>
|
|
</listitem><listitem>
|
|
<para><computeroutput>ramdb_db_fnc_hashSet</computeroutput>: Sets a value in the hash table</para>
|
|
</listitem><listitem>
|
|
<para><computeroutput>ramdb_db_fnc_hashGet</computeroutput>: Retrieves a value from the hash table</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_delete_1autotoc_md189">
|
|
<title>Links</title>
|
|
<para><link linkend="_md_docs_2hash_2hash_delete">Hash Delete</link> | <link linkend="_md_docs_2hash_2hash_delete_id">Hash Delete ID</link> | <link linkend="_md_docs_2hash_2hash_get">Hash Get</link> | <link linkend="_md_docs_2hash_2hash_get_all">Hash Get All</link> | <link linkend="_md_docs_2hash_2hash_get_all_id">Hash Get All ID</link> | <link linkend="_md_docs_2hash_2hash_get_id">Hash Get ID</link> | <link linkend="_md_docs_2hash_2hash_remove">Hash Remove</link> | <link linkend="_md_docs_2hash_2hash_remove_id">Hash Remove ID</link> | <link linkend="_md_docs_2hash_2hash_set">Hash Set</link> | <link linkend="_md_docs_2hash_2hash_set_bulk">Hash Set Bulk</link> | <link linkend="_md_docs_2hash_2hash_set_id">Hash Set ID</link> | <link linkend="_md_docs_2hash_2hash_set_id_bulk">Hash Set ID Bulk</link> </para>
|
|
</section>
|
|
</section>
|
|
</section>
|