ramdb/docs/basic/delete.md
Jacob Schmidt 8c0e8144e5 docs: Update documentation links and function references
This commit updates the documentation to reflect the current function names and link structure. Specifically, it addresses the following:

*   Corrected internal links within the documentation to point to the correct markdown files (e.g., `hashDelete.md` instead of `hashDelete`).
*   Updated related function references to reflect the current function names and include missing functions.
*   Removed outdated function references.
*   Added `ramdb_db_fnc_scheduler` to related functions where appropriate.
*   Updated the links section to use the correct markdown file names.
2025-03-22 16:53:30 -05:00

50 lines
1.2 KiB
Markdown

---
title: ArmaRAMDb - Delete Key
icon: mdi:file-text-outline
excerpt: Remove the specified key from RAMDb.
---
# ramdb_db_fnc_delete
## Description
Removes the specified key from the database. This function deletes the key-value pair completely from storage.
## Syntax
```sqf
[_key] call ramdb_db_fnc_delete
```
## Parameters
| Parameter | Type | Description |
|-----------|--------|-------------------------------------------|
| `_key` | String | Name of the key to delete from the database |
## Return Value
None. The operation runs asynchronously.
## Examples
### Delete a key in singleplayer or on the server:
```sqf
["playerData"] call ramdb_db_fnc_delete;
```
### Delete a key on the server from a client:
```sqf
["playerData"] remoteExecCall ["ramdb_db_fnc_delete", 2, false];
```
## Notes
- This operation is permanent and cannot be undone
- If the key doesn't exist, the operation will have no effect
- This function only affects specific keys, not hash tables or lists
## Related Functions
- `ramdb_db_fnc_get`: Retrieves a value by key
- `ramdb_db_fnc_set`: Stores a value by key
- `ramdb_db_fnc_scheduler`: Processes the callback response
## Links
[Delete Key](delete.md) |
[Get Key](get.md) |
[Set Key](set.md)