When you create a metaproperty, or metaproperty option, a database name is automatically generated from the name.
It is important to note that once a metaproperty or option is created, the database name becomes permanent and cannot be altered. However, the name can still be updated if needed.
Guidelines for Metaproperty Database Name
- Use only alphanumeric characters (A-Z, a-z, 0-9), hyphens (-), underscores (_).
- Any unsupported character will automatically be replaced with an underscore (_).
- Hyphens (-) cannot be the final character in a database name; if they are, they will be converted to an underscore (_).
- The database name must be unique. If a duplicate database name is found (e.g., from another metaproperty or option), a numeric suffix (_1, _2, etc.) is added to ensure uniqueness.
- The database name is fixed at the time of creation. Future updates to the name in the taxonomy will not affect the database name.
Recommendation for Integrations
- Avoid relying on the database name for integrations due to its restrictions and immutability.
- Use the externalReference field instead. This field supports customer-specific logic, has no character restrictions, and can be updated to align with integration requirements.
FAQ
Where can I find the database name?
The database name is visible only to those who have managed metaproperty permission. It appears in the metaproperty details under the metaproperty management section.
Can I change the database name?
No, after creating your metaproperty or metaproperty option, the database name becomes permanent and cannot be altered. However, you can change the name.
For example, if you created the meta property "city" but wanted to change it to display "the city", you can edit the name; however, the database name will not reflect the updated name.
Can I add a special characters to a name?
Yes, special characters are allowed in the name.