c8d81ba3bb
All checks were successful
Build / Build (push) Successful in 39s
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.
43 lines
1.0 KiB
Markdown
43 lines
1.0 KiB
Markdown
---
|
|
title: ArmaDragonflyClient - Save DB
|
|
icon: mdi:file-text-outline
|
|
excerpt: 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
|
|
```sqf
|
|
[] 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:
|
|
```sqf
|
|
[] call dragonfly_db_fnc_save;
|
|
```
|
|
|
|
### Call the save function remotely from a client:
|
|
```sqf
|
|
[] 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
|
|
|
|
## Related Functions
|
|
None.
|
|
|
|
## Links
|
|
None. |