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.
41 lines
3.4 KiB
TeX
41 lines
3.4 KiB
TeX
\chapter{load}
|
|
\hypertarget{md_docs_2basic_2load}{}\label{md_docs_2basic_2load}\index{load@{load}}
|
|
\hypertarget{md_docs_2basic_2load_autotoc_md36}{}\doxysubsection{\texorpdfstring{autotoc\+\_\+md36}{autotoc\+\_\+md36}}\label{md_docs_2basic_2load_autotoc_md36}
|
|
title\+: Arma\+RAMDb -\/ Load DB icon\+: mdi\+:file-\/text-\/outline \hypertarget{md_docs_2basic_2load_autotoc_md37}{}\doxysubsection{\texorpdfstring{excerpt\+: Load DB from disc.}{excerpt\+: Load DB from disc.}}\label{md_docs_2basic_2load_autotoc_md37}
|
|
\hypertarget{md_docs_2basic_2load_autotoc_md38}{}\doxysection{\texorpdfstring{ramdb\+\_\+db\+\_\+fnc\+\_\+load}{ramdb\+\_\+db\+\_\+fnc\+\_\+load}}\label{md_docs_2basic_2load_autotoc_md38}
|
|
\hypertarget{md_docs_2basic_2load_autotoc_md39}{}\doxysubsection{\texorpdfstring{Description}{Description}}\label{md_docs_2basic_2load_autotoc_md39}
|
|
Loads the database from disk storage. This function restores all data (key-\/value pairs, hash tables, and lists) from the previously saved database file.\hypertarget{md_docs_2basic_2load_autotoc_md40}{}\doxysubsection{\texorpdfstring{Syntax}{Syntax}}\label{md_docs_2basic_2load_autotoc_md40}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{[]\ call\ ramdb\_db\_fnc\_load}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2basic_2load_autotoc_md41}{}\doxysubsection{\texorpdfstring{Parameters}{Parameters}}\label{md_docs_2basic_2load_autotoc_md41}
|
|
None. This function does not require any parameters.\hypertarget{md_docs_2basic_2load_autotoc_md42}{}\doxysubsection{\texorpdfstring{Return Value}{Return Value}}\label{md_docs_2basic_2load_autotoc_md42}
|
|
None. The operation runs synchronously and loads the database immediately.\hypertarget{md_docs_2basic_2load_autotoc_md43}{}\doxysubsection{\texorpdfstring{Examples}{Examples}}\label{md_docs_2basic_2load_autotoc_md43}
|
|
\hypertarget{md_docs_2basic_2load_autotoc_md44}{}\doxysubsubsection{\texorpdfstring{Load the database on the server\+:}{Load the database on the server\+:}}\label{md_docs_2basic_2load_autotoc_md44}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{[]\ call\ ramdb\_db\_fnc\_load;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2basic_2load_autotoc_md45}{}\doxysubsubsection{\texorpdfstring{Call the load function remotely from a client\+:}{Call the load function remotely from a client\+:}}\label{md_docs_2basic_2load_autotoc_md45}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{[]\ remoteExecCall\ ["{}ramdb\_db\_fnc\_load"{},\ 2,\ false];}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2basic_2load_autotoc_md46}{}\doxysubsection{\texorpdfstring{Notes}{Notes}}\label{md_docs_2basic_2load_autotoc_md46}
|
|
|
|
\begin{DoxyItemize}
|
|
\item This function should typically be called during server initialization
|
|
\item Any existing data in memory will be overwritten with the data from disk
|
|
\item If no database file exists, nothing will happen
|
|
\item Loading does not affect ongoing operations, but might replace values in memory
|
|
\item For safety, it\textquotesingle{}s recommended to call this function only when necessary
|
|
\end{DoxyItemize}\hypertarget{md_docs_2basic_2load_autotoc_md47}{}\doxysubsection{\texorpdfstring{Related Functions}{Related Functions}}\label{md_docs_2basic_2load_autotoc_md47}
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+save}\+: Saves the database to disk
|
|
\end{DoxyItemize}\hypertarget{md_docs_2basic_2load_autotoc_md48}{}\doxysubsection{\texorpdfstring{Links}{Links}}\label{md_docs_2basic_2load_autotoc_md48}
|
|
\doxysectlink{md_docs_2basic_2save}{Save DB}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2basic_2load}{Load DB}{0} |