ramdb/api/html/search/all_13.js
Jacob Schmidt ee1dd91b7f
All checks were successful
Build / Build (push) Successful in 40s
feat: Add documentation for fetch function
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.
2025-03-30 17:16:31 -05:00

61 lines
13 KiB
JavaScript

var searchData=
[
['table_0',['table',['../d9/dae/md_docs_2hash_2hash_remove_id.html#autotoc_md274',1,'excerpt: Remove a field from a specific hash table.'],['../d9/d12/md_docs_2hash_2hash_remove.html#autotoc_md261',1,'excerpt: Remove a field from the current client's hash table.']]],
['table_20from_20a_20client_3a_1',['Delete a hash table from a client:',['../dc/d95/md_docs_2hash_2hash_delete_id.html#autotoc_md200',1,'']]],
['table_20from_20database_2',['table from database',['../dc/d95/md_docs_2hash_2hash_delete_id.html#autotoc_md191',1,'excerpt: Remove a specific hash table from database.'],['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md178',1,'excerpt: Remove the current client's hash table from database.']]],
['table_20from_20the_20server_3a_3',['Delete a client's hash table from the server:',['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md186',1,'']]],
['table_20in_20ramdb_4',['table in RAMDb',['../dc/dae/md_docs_2hash_2hash_get.html#autotoc_md205',1,'excerpt: Get a field value from the current client's hash table in RAMDb.'],['../d8/d96/md_docs_2hash_2hash_get_all.html#autotoc_md219',1,'excerpt: Get all fields from the current client's hash table in RAMDb.'],['../d0/d68/md_docs_2hash_2hash_set.html#autotoc_md288',1,'excerpt: Set a field value in the current client's hash table in RAMDb.'],['../d9/dc1/md_docs_2hash_2hash_set_bulk.html#autotoc_md302',1,'excerpt: Set multiple fields in the current client's hash table in RAMDb.']]],
['table_20retrieval_20task_3a_5',['Add a hash table retrieval task:',['../d3/df8/md_docs_2core_2add_task.html#autotoc_md89',1,'']]],
['table_3a_6',['table:',['../dc/d95/md_docs_2hash_2hash_delete_id.html#autotoc_md198',1,'Delete a specific hash table:'],['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md185',1,'Delete the current client's hash table:']]],
['task_20that_20returns_20data_20to_20a_20specific_20client_3a_7',['Add a player-specific task that returns data to a specific client:',['../d3/df8/md_docs_2core_2add_task.html#autotoc_md90',1,'']]],
['task_20to_20queue_8',['excerpt: Add task to queue.',['../d3/df8/md_docs_2core_2add_task.html#autotoc_md82',1,'']]],
['task_3a_9',['task:',['../d3/df8/md_docs_2core_2add_task.html#autotoc_md89',1,'Add a hash table retrieval task:'],['../d3/df8/md_docs_2core_2add_task.html#autotoc_md91',1,'Add a list operation task:']]],
['tasks_20to_20be_20executed_10',['excerpt: Processes a queue of tasks to be executed.',['../de/dc8/md_docs_2core_2process_queue.html#autotoc_md134',1,'']]],
['test_11',['test',['../de/d91/md_docs_2core_2test.html',1,'']]],
['test_20database_20retrieval_20by_20specifying_20this_20as_20callback_20function_3a_12',['Test database retrieval by specifying this as callback function:',['../de/d91/md_docs_2core_2test.html#autotoc_md172',1,'']]],
['test_20from_20client_20to_20server_3a_13',['Test from client to server:',['../de/d91/md_docs_2core_2test.html#autotoc_md173',1,'']]],
['test_20function_14',['excerpt: Test Function.',['../de/d91/md_docs_2core_2test.html#autotoc_md164',1,'']]],
['test_20with_20a_20simple_20string_3a_15',['Test with a simple string:',['../de/d91/md_docs_2core_2test.html#autotoc_md171',1,'']]],
['that_20returns_20data_20to_20a_20specific_20client_3a_16',['Add a player-specific task that returns data to a specific client:',['../d3/df8/md_docs_2core_2add_task.html#autotoc_md90',1,'']]],
['the_20addon_20name_20in_20system_20chat_17',['excerpt: Displays the addon name in system chat.',['../d7/d81/md_docs_2core_2print_addon_name.html#autotoc_md121',1,'']]],
['the_20addon_20name_20message_3a_18',['Display the addon name message:',['../d7/d81/md_docs_2core_2print_addon_name.html#autotoc_md128',1,'']]],
['the_20current_20client_20s_20hash_20table_19',['excerpt: Remove a field from the current client's hash table.',['../d9/d12/md_docs_2hash_2hash_remove.html#autotoc_md261',1,'']]],
['the_20current_20client_20s_20hash_20table_20from_20database_20',['excerpt: Remove the current client's hash table from database.',['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md178',1,'']]],
['the_20current_20client_20s_20hash_20table_20in_20ramdb_21',['the current client s hash table in RAMDb',['../dc/dae/md_docs_2hash_2hash_get.html#autotoc_md205',1,'excerpt: Get a field value from the current client's hash table in RAMDb.'],['../d8/d96/md_docs_2hash_2hash_get_all.html#autotoc_md219',1,'excerpt: Get all fields from the current client's hash table in RAMDb.'],['../d0/d68/md_docs_2hash_2hash_set.html#autotoc_md288',1,'excerpt: Set a field value in the current client's hash table in RAMDb.'],['../d9/dc1/md_docs_2hash_2hash_set_bulk.html#autotoc_md302',1,'excerpt: Set multiple fields in the current client's hash table in RAMDb.']]],
['the_20current_20client_20s_20hash_20table_3a_22',['Delete the current client's hash table:',['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md185',1,'']]],
['the_20database_20and_20create_20a_20backup_3a_23',['Save the database and create a backup:',['../d8/d12/md_docs_2basic_2save.html#autotoc_md62',1,'']]],
['the_20database_20extension_20when_20data_20is_20too_20large_20to_20be_20returned_20in_20a_20single_20callback_24',['excerpt: Handles data chunks received from the database extension when data is too large to be returned in a single callback.',['../d8/d05/md_docs_2basic_2fetch.html#autotoc_md14',1,'']]],
['the_20database_20on_20the_20server_3a_25',['Load the database on the server:',['../da/d36/md_docs_2basic_2load.html#autotoc_md44',1,'']]],
['the_20database_20without_20creating_20a_20backup_3a_26',['Save the database without creating a backup:',['../d8/d12/md_docs_2basic_2save.html#autotoc_md61',1,'']]],
['the_20extension_3a_27',['Process a callback from the extension:',['../d8/df5/md_docs_2core_2scheduler.html#autotoc_md158',1,'']]],
['the_20hash_20stored_20at_20key_20from_20ramdb_28',['the hash stored at key from RAMDb',['../d3/d33/md_docs_2hash_2hash_get_all_id.html#autotoc_md233',1,'excerpt: Get all fields and values from the hash stored at key from RAMDb.'],['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md316',1,'excerpt: Set the specified field to the respective value in the hash stored at key from RAMDb.'],['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md330',1,'excerpt: Set the specified fields to their respective values in the hash stored at key from RAMDb.']]],
['the_20load_20function_20remotely_20from_20a_20client_3a_29',['Call the load function remotely from a client:',['../da/d36/md_docs_2basic_2load.html#autotoc_md45',1,'']]],
['the_20queue_20manually_3a_30',['Start processing the queue manually:',['../de/dc8/md_docs_2core_2process_queue.html#autotoc_md141',1,'']]],
['the_20respective_20value_20in_20the_20hash_20stored_20at_20key_20from_20ramdb_31',['excerpt: Set the specified field to the respective value in the hash stored at key from RAMDb.',['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md316',1,'']]],
['the_20save_20function_20remotely_20from_20a_20client_3a_32',['Call the save function remotely from a client:',['../d8/d12/md_docs_2basic_2save.html#autotoc_md63',1,'']]],
['the_20server_20and_20send_20to_20a_20specific_20client_3a_33',['Retrieve data on the server and send to a specific client:',['../d1/d9f/md_docs_2basic_2get.html#autotoc_md32',1,'']]],
['the_20server_20from_20a_20client_3a_34',['Delete a key on the server from a client:',['../d6/dff/md_docs_2basic_2delete.html#autotoc_md9',1,'']]],
['the_20server_3a_35',['the server:',['../d7/d91/md_docs_2hash_2hash_delete.html#autotoc_md186',1,'Delete a client's hash table from the server:'],['../d6/dff/md_docs_2basic_2delete.html#autotoc_md8',1,'Delete a key in singleplayer or on the server:'],['../d8/df5/md_docs_2core_2scheduler.html#autotoc_md159',1,'Forward a callback to the server:'],['../da/d36/md_docs_2basic_2load.html#autotoc_md44',1,'Load the database on the server:'],['../d1/d9f/md_docs_2basic_2get.html#autotoc_md31',1,'Retrieve data in singleplayer or on the server:']]],
['the_20set_20function_20remotely_20from_20a_20client_3a_36',['Call the set function remotely from a client:',['../dc/d24/md_docs_2basic_2set.html#autotoc_md77',1,'']]],
['the_20specified_20field_20to_20the_20respective_20value_20in_20the_20hash_20stored_20at_20key_20from_20ramdb_37',['excerpt: Set the specified field to the respective value in the hash stored at key from RAMDb.',['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md316',1,'']]],
['the_20specified_20fields_20to_20their_20respective_20values_20in_20the_20hash_20stored_20at_20key_20from_20ramdb_38',['excerpt: Set the specified fields to their respective values in the hash stored at key from RAMDb.',['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md330',1,'']]],
['the_20specified_20key_20from_20ramdb_39',['excerpt: Remove the specified key from RAMDb.',['../d6/dff/md_docs_2basic_2delete.html#autotoc_md1',1,'']]],
['the_20value_20associated_20with_20field_20in_20hash_20stored_20at_20key_20from_20ramdb_40',['excerpt: Get the value associated with field in hash stored at key from RAMDb.',['../d5/d27/md_docs_2hash_2hash_get_id.html#autotoc_md247',1,'']]],
['the_20value_20of_20stored_20key_20from_20ramdb_41',['the value of stored key from RAMDb',['../d1/d9f/md_docs_2basic_2get.html#autotoc_md24',1,'excerpt: Get the value of stored key from RAMDb.'],['../dc/d24/md_docs_2basic_2set.html#autotoc_md68',1,'excerpt: Set the value of stored key from RAMDb.']]],
['their_20respective_20values_20in_20the_20hash_20stored_20at_20key_20from_20ramdb_42',['excerpt: Set the specified fields to their respective values in the hash stored at key from RAMDb.',['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md330',1,'']]],
['their_20uid_3a_43',['their UID:',['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md323',1,'Store a player's loadout under their UID:'],['../dc/d24/md_docs_2basic_2set.html#autotoc_md76',1,'Store player data under their UID:']]],
['this_20as_20callback_20function_3a_44',['Test database retrieval by specifying this as callback function:',['../de/d91/md_docs_2core_2test.html#autotoc_md172',1,'']]],
['to_20a_20specific_20client_3a_45',['to a specific client:',['../d3/df8/md_docs_2core_2add_task.html#autotoc_md90',1,'Add a player-specific task that returns data to a specific client:'],['../dc/dae/md_docs_2hash_2hash_get.html#autotoc_md214',1,'Retrieve data and send it to a specific client:'],['../d8/d96/md_docs_2hash_2hash_get_all.html#autotoc_md228',1,'Retrieve data and send it to a specific client:'],['../d3/d33/md_docs_2hash_2hash_get_all_id.html#autotoc_md242',1,'Retrieve data and send it to a specific client:'],['../d5/d27/md_docs_2hash_2hash_get_id.html#autotoc_md256',1,'Retrieve data and send it to a specific client:'],['../d7/d58/md_docs_2list_2list_get.html#autotoc_md382',1,'Retrieve data and send it to a specific client:'],['../d1/d9f/md_docs_2basic_2get.html#autotoc_md32',1,'Retrieve data on the server and send to a specific client:'],['../df/d1b/md_docs_2core_2handler.html#autotoc_md104',1,'Send data to a specific client:']]],
['to_20be_20executed_46',['excerpt: Processes a queue of tasks to be executed.',['../de/dc8/md_docs_2core_2process_queue.html#autotoc_md134',1,'']]],
['to_20be_20returned_20in_20a_20single_20callback_47',['excerpt: Handles data chunks received from the database extension when data is too large to be returned in a single callback.',['../d8/d05/md_docs_2basic_2fetch.html#autotoc_md14',1,'']]],
['to_20disc_48',['excerpt: Save DB to disc.',['../d8/d12/md_docs_2basic_2save.html#autotoc_md54',1,'']]],
['to_20list_20stored_20at_20key_20from_20ramdb_49',['excerpt: Add element to list stored at key from RAMDb.',['../dd/dca/md_docs_2list_2list_add.html#autotoc_md348',1,'']]],
['to_20queue_50',['excerpt: Add task to queue.',['../d3/df8/md_docs_2core_2add_task.html#autotoc_md82',1,'']]],
['to_20server_3a_51',['Test from client to server:',['../de/d91/md_docs_2core_2test.html#autotoc_md173',1,'']]],
['to_20the_20respective_20value_20in_20the_20hash_20stored_20at_20key_20from_20ramdb_52',['excerpt: Set the specified field to the respective value in the hash stored at key from RAMDb.',['../dc/db9/md_docs_2hash_2hash_set_id.html#autotoc_md316',1,'']]],
['to_20the_20server_3a_53',['Forward a callback to the server:',['../d8/df5/md_docs_2core_2scheduler.html#autotoc_md159',1,'']]],
['to_20their_20respective_20values_20in_20the_20hash_20stored_20at_20key_20from_20ramdb_54',['excerpt: Set the specified fields to their respective values in the hash stored at key from RAMDb.',['../d2/d02/md_docs_2hash_2hash_set_id_bulk.html#autotoc_md330',1,'']]],
['too_20large_20to_20be_20returned_20in_20a_20single_20callback_55',['excerpt: Handles data chunks received from the database extension when data is too large to be returned in a single callback.',['../d8/d05/md_docs_2basic_2fetch.html#autotoc_md14',1,'']]],
['trigger_20queue_20processing_20from_20a_20client_3a_56',['Trigger queue processing from a client:',['../de/dc8/md_docs_2core_2process_queue.html#autotoc_md142',1,'']]]
];