Database Collections

The domain namespace's Infrastructure tab provides information on the database collections used to persist Root Entities.

Database collections are used to persist root entities. Therefore, whenever you create a root entity, you have to specify a database collection for it.

Note:

Although you can persist multiple root entities into the same database collection, there must be at least one database collection set up for the current project if you want to model one or more root entities.

Create database collections

You can create database collections by using the Create database collection capability in the Database Collections section on the Infrastructure tab of a domain namespace's Overview page.

Database collections are defined using the following master data:

  • Local Identifier: This is the identifier (name) of the database collection. It is unique within a namespace. Please note that only the characters A-z (without special characters), digits and the special character "_" are permitted for naming database collections! Furthermore, identifiers may not begin with a digit and the first character must be lowercase (required)
  • Notes: This is a description of the database collection (optional)

Edit database collections

You can edit the master data of a database collection by clicking the Edit database collection details button in the Database Collection Details section on the database collection's instance page. Alternatively, you can use the Edit capability of each table row on the Infrastructure tab of a domain namespace's Overview page. The fields that can be edited are Local Identifier and Notes.

Delete database collections

You can delete a database collection by clicking the Delete database collection button in the upper right corner of the database collection instance page. Alternatively, you can use the Delete capability of each table row on the Infrastructure tab of a domain namespace's Overview page.

Warning:

You can only delete a database collection if it is not in use. You can check the usages of a database collection by using the Info capability and navigating to the Usages section. You will need to confirm the action before the selected database collection is permanently deleted.