Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Influence DB Store mapping by using annotations"
(New page: This feature is implemented in current CVS Head for the CDO 3.0 release.<br> <br> When using the DB Store the mapping of the EMF/CDO model to the database backend can be influenced by seve...) |
|||
| Line 3: | Line 3: | ||
When using the DB Store the mapping of the EMF/CDO model to the database backend can be influenced by several annotations. Just add the below EAnnotation's to the appropriate classes/features.<br> | When using the DB Store the mapping of the EMF/CDO model to the database backend can be influenced by several annotations. Just add the below EAnnotation's to the appropriate classes/features.<br> | ||
| + | = Class Annotations = | ||
| + | The following annotations are meaningful in the context of EClasses. | ||
| + | <code source="xml"> | ||
| + | <eStructuralFeatures xsi:type="ecore:EAttribute" ...> | ||
| + | <eAnnotations source="http://www.eclipse.org/CDO/DBStore"> | ||
| + | ... | ||
| + | </eAnnotations> | ||
| + | </eStructuralFeatures> | ||
| + | <code> | ||
| + | |||
| + | == TableName == | ||
| + | A class annotation for naming it's table. | ||
| + | <pre> | ||
| + | <eAnnotations source="http://www.eclipse.org/CDO/DBStore"> | ||
| + | <details key="tableName" value="MY_TABLE_NAME"/> | ||
| + | </eAnnotations> | ||
| + | </pre> | ||
| + | |||
| + | == TableMapping == | ||
| + | Exclude a class from persistence.<br> | ||
| + | Sometimes you may have classes in your model that are not intended to be persisted. Without the below annotation CDO would create an empty table also for those classes, but with that annotation those classes are simply ignored. | ||
| + | <pre> | ||
| + | <eAnnotations source="http://www.eclipse.org/CDO/DBStore"> | ||
| + | <details key="tableMapping" value="NONE"/> | ||
| + | </eAnnotations> | ||
| + | </pre> | ||
| + | |||
| + | = Feature Annotations = | ||
| + | The following annotations are meaningful in the context of EStructuralFeatures | ||
== ColumnLength == | == ColumnLength == | ||
The length of the data.<br> | The length of the data.<br> | ||
| Line 26: | Line 55: | ||
<eAnnotations source="http://www.eclipse.org/CDO/DBStore"> | <eAnnotations source="http://www.eclipse.org/CDO/DBStore"> | ||
<details key="columnType" value="CLOB"/> | <details key="columnType" value="CLOB"/> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</eAnnotations> | </eAnnotations> | ||
</pre> | </pre> | ||
Revision as of 01:23, 14 August 2009
This feature is implemented in current CVS Head for the CDO 3.0 release.
When using the DB Store the mapping of the EMF/CDO model to the database backend can be influenced by several annotations. Just add the below EAnnotation's to the appropriate classes/features.
Contents
Class Annotations
The following annotations are meaningful in the context of EClasses.
<eStructuralFeatures xsi:type="ecore:EAttribute" ...>
<eAnnotations source="http://www.eclipse.org/CDO/DBStore"> ... </eAnnotations>
</eStructuralFeatures> <code>
TableName
A class annotation for naming it's table.
<eAnnotations source="http://www.eclipse.org/CDO/DBStore">
<details key="tableName" value="MY_TABLE_NAME"/>
</eAnnotations>
TableMapping
Exclude a class from persistence.
Sometimes you may have classes in your model that are not intended to be persisted. Without the below annotation CDO would create an empty table also for those classes, but with that annotation those classes are simply ignored.
<eAnnotations source="http://www.eclipse.org/CDO/DBStore">
<details key="tableMapping" value="NONE"/>
</eAnnotations>
Feature Annotations
The following annotations are meaningful in the context of EStructuralFeatures
ColumnLength
The length of the data.
Can be used for example to provide the length for a VARCHAR that was mapped from an EString feature.
<eAnnotations source="http://www.eclipse.org/CDO/DBStore">
<details key="columnLength" value="256"/>
</eAnnotations>
ColumnName
The feature annotation for naming it's column.
<eAnnotations source="http://www.eclipse.org/CDO/DBStore">
<details key="columnName" value="MY_COLUMN_NAME"/>
</eAnnotations>
ColumnType
The type to be used for storing the feature in the database.
This can be used for example to store a feature of type EString in a Clob column.
<eAnnotations source="http://www.eclipse.org/CDO/DBStore">
<details key="columnType" value="CLOB"/>
</eAnnotations>