Delete from Data Store: <DataStoreName>
Description
Removes the entry stored under a key in a Data Store and frees the storage it used. Deleting a key that does not exist is not an error; the Existed output tells you whether there was anything to delete.
When to use
Use Delete from Data Store to remove entries a pipeline no longer needs: a finished job’s state, an item that has been processed, a cache entry that is stale. The delete is idempotent, so a pipeline can clean up without reading first, and running it twice does no harm.
Deleting always works, on every plan, including after a downgrade, so an organization that is over its storage limit can free space. Note that this removes one key at a time; to empty a whole Data Store, use the Data Stores page.
It works in pipelines only, not in functions.
Pins
Input pins
| Pin | Type | Default | Notes |
|---|---|---|---|
| Key | string | — | The key of the entry to delete, 1 to 512 characters. |
Output pins
| Pin | Type | Notes |
|---|---|---|
| Existed | boolean | True when an entry was deleted, false when the key was not there. |
Execution pins
| Pin | Direction |
|---|---|
| In | Input |
| Out | Output |
Example
A pipeline processes each file from an SFTP folder. After a file has been handled it runs Delete from Data Store: Pending files with the file name as the key, and wires Existed into a Branch to log a warning if the file was never in the pending list to begin with.