Common Annotations
Find here a reference and glossary of common annotations intrinsically supported by the CDS compiler and runtimes.
Content
General Purpose
| Annotation |
Description |
Alternatives |
@title |
|
Common.Label |
@description |
|
Core.Description |
Access Control
Services / APIs
| Annotation |
Description |
@path |
|
@impl |
|
@odata.etag |
|
@cds.autoexpose |
|
@cds.api.ignore |
|
@cds.query.limit |
|
@cds.localized |
see Localized Data |
@cds.valid.from/to |
see Temporal Data |
Persistence
| Annotation |
Description |
@cds.persistence.exists |
tells compile.to.sql this is created otherwise |
@cds.persistence.table |
tells compile.to.sql to create a table, not a view |
@cds.persistence.skip |
tells the compiler, this entity shall not exist in database at all |
@cds.persistence.mock |
false excludes this entity from automatic mocking |
@cds.persistence.name |
allows to choose a different database name |
@cds.on.insert |
see Generic Handlers |
@cds.on.update |
see Generic Handlers |
@cascade |
Allows to cascade insert, update, and delete operations over selected associations. |
OData
Learn more on OData Annotations in CDS
Shortcuts:
| Annotation |
Description |
@ValueList.entity |
|
@odata.Type |
|
@odata.MaxLength |
|
@odata.singleton |
Create an edmx:Singleton if evaluated as true. |
@odata.singleton.nullable |
Create an edmx:Singleton if @odata.singleton is null or undefined. |
Intrinsically supported OData Annotations:
