HomeWiki
HomeWiki
  1. Variables
  • Back to home
  • 2. Connectivity
  • Introduction
  • Custom Script
  • Playground
  • Database Explorer
  • Log Stream
  • Direct Communication
  • Softone
    • Getting Started
  • Datapump
    • Getting Started
    • Crons
    • Legacy Windows Support
    • SDK
      • DB
        • _executeQuery
        • _executeStoreProcedure
        • _executeInsertQuery
        • _executeInsertQueriesInTransaction
      • Import
        • _productsImport
        • _categoriesImport
        • _brandsImport
        • _attributesImport
        • _attributeSetsImport
        • _unitsImport
        • _quantityImport
        • _customersImport
        • _contactsImport
        • _callsImport
        • _eventsImport
        • _tasksImport
        • _ordersImport
        • _usersImport
        • _customerSourceTagsImport
        • _productSourceTagsImport
      • Log
        • _logDebug
        • _logInfo
        • _logWarn
        • _logError
      • Web Requests
        • _httpGetJson
        • _httpPostJson
        • _httpPutJson
        • _httpDeleteJson
        • _httpPatchJson
      • Variables
        • _saveVariable
        • _getVariable
        • _deleteVariable
      • Blob
        • _blobConnect
        • _blobExists
        • _blobGet
        • _blobFind
      • Utils
        • _encodeBase64
        • _sleep
        • _getLastSyncDate
        • _updateLastSyncDate
        • _resetLastSyncDate
  1. Variables

_deleteVariable

Documentation: _deleteVariable Function#

The _deleteVariable function is designed to remove a stored value associated with a specific key from the storage system. This operation ensures that the data associated with the provided key is deleted and no longer accessible.

Function Signature:#

Parameters:#

key:
Description: The unique identifier for the data that needs to be removed from storage. This key should match the key used when storing the data.
Type: string
Example:

Return Value:#

Returns:
The function does not return any value. It performs a deletion operation and does not provide feedback directly.

Function Workflow:#

1.
Identify Data:
The function uses the provided key to locate the corresponding data in the storage system.
2.
Perform Deletion:
The function deletes the data associated with the specified key from the storage.
3.
Confirmation:
There is no direct confirmation or result returned by the function. Successful deletion is implied if no errors occur.
4.
Error Handling:
If the key does not exist or an error occurs during deletion, the function should handle the situation gracefully, possibly logging an error or exception.

Example Usage:#

Important Considerations:#

Key Existence:
Ensure that the provided key exists in the storage system. If the key is not found, no action is needed, but the function should handle such cases gracefully.
Error Handling:
The function should be designed to handle any potential errors during the deletion process, such as permission issues or data inconsistencies.
Data Recovery:
Once a variable is deleted, it cannot be recovered through this function. Ensure that deletion operations are performed with caution.
By using _deleteVariable, you can effectively remove data associated with a specific key, ensuring that the storage system remains clean and organized.
Previous
_getVariable
Next
_blobConnect
Built with