Deleting Entities and Entity Fields: Data Removal in the ComUnity Developer Toolkit

In the ComUnity Developer Toolkit, efficient data management includes the ability to delete entities and entity fields when they are no longer needed in your data model. This section focuses on the functionality provided by the toolkit to remove entities and their associated fields.

Deleting entities and entity fields is a crucial aspect of data maintenance, allowing you to maintain data integrity and optimise your data model over time. Whether you need to remove an entire entity or just specific fields within an entity, the toolkit provides a straightforward process to accomplish these tasks.

In the upcoming section, we will explore how to delete entities and entity fields in the ComUnity Developer Toolkit. You will learn the step-by-step process to remove entities and understand the implications of data removal. Additionally, we will discuss best practices for data deletion to ensure a smooth and efficient data management workflow.

By familiarising yourself with the deletion functionality in the toolkit, you can effectively manage your data model by removing unnecessary entities and fields, keeping your data clean and organised.

Delete an entity

To delete an entity, follow these steps:

  1. Select the entity you want to delete by clicking on its header section with a grey background colour. An active entity can be identified by its blue border, and none of its entity fields will be active (active entity fields have a blue background colour). This action will open a properties dialog that displays the global properties specific to the entity.

  2. Alternatively, if you are in a List view, simply click on the entity you wish to delete. An active entity will be distinguished by a distinctive blue background colour.

  3. Once the entity is selected, you will notice a trash can icon located in the header section. Clicking on this icon will trigger a modal window titled Delete an Entity.

  4. Finally, click the "Delete Entity" button to permanently remove the selected entity from your data model.

It's important to note that deleting an entity will also remove all associated fields and any data stored within them. Exercise caution when performing entity deletions and ensure that you have appropriate backups or data migration strategies in place.

Delete an entity field

To delete an entity field, follow these steps:

  1. Select the entity field you wish to delete. If you are working in a Diagram view, click on the field directly. Alternatively, if you are viewing the entities in a List view, right-click on the entity field to reveal a context menu.

  2. In the context menu, select the Delete this field option. This action will initiate a confirmation modal titled Delete Field Entity.

  3. Review the details presented in the modal, ensuring that you have selected the correct field for deletion.

  4. Finally, click the Delete Field button to permanently remove the selected entity field from your data model.

Please note that deleting an entity field will result in the loss of any data associated with that field. Therefore, exercise caution when deleting fields and ensure that you have appropriate data backup or migration strategies in place.