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.
97 lines
3.8 KiB
XML
97 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="_md_docs_2basic_2delete" xml:lang="en-US">
|
|
<title>delete</title>
|
|
<indexterm><primary>delete</primary></indexterm>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md0">
|
|
<title>autotoc_md0</title>
|
|
<para>title: ArmaRAMDb - Delete Key icon: mdi:file-text-outline </para>
|
|
</section>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md1">
|
|
<title>excerpt: Remove the specified key from RAMDb.</title></section>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md2">
|
|
<title>ramdb_db_fnc_delete</title><section xml:id="_md_docs_2basic_2delete_1autotoc_md3">
|
|
<title>Description</title>
|
|
<para>Removes the specified key from the database. This function deletes the key-value pair completely from storage.</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md4">
|
|
<title>Syntax</title>
|
|
<para><literallayout><computeroutput>[_key] call ramdb_db_fnc_delete
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md5">
|
|
<title>Parameters</title>
|
|
<para><informaltable frame="all">
|
|
<tgroup cols="3" align="left" colsep="1" rowsep="1">
|
|
<colspec colname='c1'/>
|
|
<colspec colname='c2'/>
|
|
<colspec colname='c3'/>
|
|
<thead>
|
|
<row class='markdownTableHead'>
|
|
<entry>
|
|
<para>Parameter </para>
|
|
</entry><entry>
|
|
<para>Type </para>
|
|
</entry><entry>
|
|
<para>Description </para>
|
|
</entry></row>
|
|
</thead><tbody>
|
|
<row class='markdownTableRowOdd'>
|
|
<entry>
|
|
<para><computeroutput>_key</computeroutput> </para>
|
|
</entry><entry>
|
|
<para>String </para>
|
|
</entry><entry>
|
|
<para>Name of the key to delete from the database </para>
|
|
</entry></row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md6">
|
|
<title>Return Value</title>
|
|
<para>None. The operation runs asynchronously.</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md7">
|
|
<title>Examples</title><section xml:id="_md_docs_2basic_2delete_1autotoc_md8">
|
|
<title>Delete a key in singleplayer or on the server:</title>
|
|
<para><literallayout><computeroutput>["playerData"] call ramdb_db_fnc_delete;
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md9">
|
|
<title>Delete a key on the server from a client:</title>
|
|
<para><literallayout><computeroutput>["playerData"] remoteExecCall ["ramdb_db_fnc_delete", 2, false];
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
</section>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md10">
|
|
<title>Notes</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para>This operation is permanent and cannot be undone</para>
|
|
</listitem><listitem>
|
|
<para>If the key doesn't exist, the operation will have no effect</para>
|
|
</listitem><listitem>
|
|
<para>This function only affects specific keys, not hash tables or lists</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md11">
|
|
<title>Related Functions</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><computeroutput>ramdb_db_fnc_get</computeroutput>: Retrieves a value by key</para>
|
|
</listitem><listitem>
|
|
<para><computeroutput>ramdb_db_fnc_set</computeroutput>: Stores a value by key</para>
|
|
</listitem><listitem>
|
|
<para><computeroutput>ramdb_db_fnc_scheduler</computeroutput>: Processes the callback response</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2basic_2delete_1autotoc_md12">
|
|
<title>Links</title>
|
|
<para><link linkend="_md_docs_2basic_2delete">Delete Key</link> | <link linkend="_md_docs_2basic_2get">Get Key</link> | <link linkend="_md_docs_2basic_2set">Set Key</link> </para>
|
|
</section>
|
|
</section>
|
|
</section>
|