Build / Build (push) Successful in 39s

Details

docs: Update README.md with detailed documentation

This commit significantly enhances the `README.md` file, providing comprehensive documentation for the ArmaDragonflyClient.

Key changes:

*   **Detailed Function Categories:** Categorized functions for better organization (Core, Basic Data Operations, Hash Operations, List Operations).
*   **Usage Examples:** Added clear and concise usage examples for basic operations, hash operations (context and ID-specific), and list operations.
*   **Function Documentation Structure:** Outlined the structure for individual function documentation.
*   **License Information:** Updated the license information.

2025-03-30 17:15:35 -05:00

1.0 KiB

Raw Permalink Blame History

title, icon, excerpt

title	icon	excerpt
ArmaDragonflyClient - Save DB	mdi:file-text-outline	Save DB to disc.

dragonfly_db_fnc_save

Description

Saves the entire database to disk storage. This function persists all data (key-value pairs, hash tables, and lists) to a file, allowing it to be retrieved later even after server restart.

Syntax

[] call dragonfly_db_fnc_save

Parameters

None. The function saves the database without any parameters.

Return Value

None. The operation runs synchronously and saves the database immediately.

Examples

Save the database without creating a backup:

[] call dragonfly_db_fnc_save;

Call the save function remotely from a client:

[] remoteExecCall ["dragonfly_db_fnc_save", 2, false];

Notes

This function should be called periodically to ensure data persistence
Saving is a resource-intensive operation, so it shouldn't be called too frequently
Consider saving before mission end or during low-activity periods

None.

Links