Documentation

EraseObject

EraseObject[object]⟹result

deletes the object from the database.

EraseObject[objects]⟹result

deletes the objects from the database.

Details

Makes destructive changes (replacements) to an object's fields.
This function prompts the user to confirm they want to go through with the deletion.
EraseObject is listable. Prompting is for the entire list of objects.

Input

Output

General Options

Messages

Error `1`

NotAllowed `1`

NotFound `1`

Examples

Basic Examples (1)

Deleting an Object removes it permanently from the database:

Additional Examples (2)

Deleting an Object is Listable:

Erasing object by Name works:

Options (3)

Force (2)

Force->True turns off the prompt to the user if they are sure they want to delete the object:

Force->True suppressed the confirmation dialog:

Verbose (1)

Verbose->False turns off progress/completion indicators:

Messages (4)

Error (1)

Returns $Failed and prints a message for unexpected errors:

NotAllowed (1)

Returns $Failed and prints a message if the user doesn't have permission to delete:

NotFound (1)

Returns $Failed and prints a message for non-existing objects:

NotLoggedIn (1)

Returns $Failed and throws a NotLoggedIn message if not logged in: