ramdb/docs/hash/hashDeleteId.md
Jacob Schmidt 5b9f3402b6
All checks were successful
Build / Build (push) Successful in 30s
docs: add comprehensive documentation and usage examples for ramdb
2025-03-22 16:31:59 -05:00

2.2 KiB

title, icon, excerpt
title icon excerpt
ArmaRAMDb - Hash Delete ID mdi:file-text-outline Remove a specific hash table from database.

ramdb_db_fnc_hashDeleteId

Description

Removes a specific hash table from the database using its unique identifier. This function deletes all fields and values associated with the specified hash ID. Unlike the global hashDelete function, this operation only affects a single hash table entry.

Syntax

[_key] call ramdb_db_fnc_hashDeleteId

Parameters

Parameter Type Description Default
_key String Identifier of the hash to be deleted ""

Return Value

None. The operation runs synchronously to delete the specified hash table.

Examples

Delete a specific hash table:

["playerStats"] call ramdb_db_fnc_hashDeleteId;

Delete a player's hash data:

[getPlayerUID player] call ramdb_db_fnc_hashDeleteId;

Delete a hash table from a client:

["vehicleData"] remoteExecCall ["ramdb_db_fnc_hashDeleteId", 2, false];

Notes

  • This operation only removes a single hash table identified by _key
  • Cannot be undone unless you have a backup
  • Validates that the key is not empty before proceeding
  • All fields associated with the hash ID are removed
  • Useful for clearing player-specific data or resetting entity data
  • Executes immediately without confirmation
  • Logs the operation for debugging purposes
  • ramdb_db_fnc_hashDelete: Removes all hash tables
  • ramdb_db_fnc_hashDeleteField: Removes a specific field from a hash
  • ramdb_db_fnc_hashSetId: Sets a value in a specific hash table
  • ramdb_db_fnc_hashGetId: Retrieves a value from a specific hash table
  • ramdb_db_fnc_hashGetAllId: Retrieves all fields from a specific hash table

Hash Delete | Hash Delete Field | Hash Delete ID | Hash Get | Hash Get All | Hash Get All ID | Hash Get ID | Hash Set | Hash Set Bulk | Hash Set ID | Hash Set ID Bulk