Skip to content
Search

    Definition Language (CDL)

    Find here a reference of all CDS concepts and features in the form of compact examples. The examples are given in CDL, a human-readable syntax for defining models, and CQL, an extension of SQL to write queries.


    Refer also to The Nature of Models and the CSN specification to complete your understanding of CDS.


    Entity and Type Definitions

    Entity Definitions — define entity

    Entities are structured types with named and typed elements, representing sets of (persisted) data that can be read and manipulated using usual CRUD operations. They usually contain one or more designated primary key elements:

    define entity Employees {
  key ID : Integer;
  name : String;
  jobTitle : String;
}

    The define keyword is optional, that means define entity Foo is equal to entity Foo.

    Type Definitions — define type

    You can declare custom types to reuse later on, for example, for elements in entity definitions. Custom-defined types can be simple, that is derived from one of the predefined types, structure types or Associations.

    define type User : String(111);
define type Amount {
  value : Decimal(10,3);
  currency : Currency;
}
define type Currency : Association to Currencies;

    The define keyword is optional, that means define type Foo is equal to type Foo.

    Learn more about Definitions of Named Aspects.

    Predefined Types

    See list of Built-in Types

    Structured Types

    You can declare and use custom struct types as follows:

    type Amount {
  value : Decimal(10,3);
  currency : Currency;
}
entity Books {
  price : Amount;
}

    Elements can also be specified with anonymous inline struct types. For example, the following is equivalent to the definition of Books above:

    entity Books {
  price : {
    value : Decimal(10,3);
    currency : Currency;
  };
}

    Arrayed Types

    Prefix a type specification with array of or many to signify array types.

    entity Foo { emails: many String; }
entity Bar { emails: many { kind:String; address:String; }; }
entity Car { emails: many EmailAddress; }
entity Car { emails: EmailAddresses; }
type EmailAddresses : many { kind:String; address:String; }
type EmailAddress : { kind:String; address:String; }

    Keywords many and array of are mere syntax variants with identical semantics and implementations.

    When deployed to SQL databases, such fields are mapped to LargeString columns and the data is stored denormalized as JSON array. With OData V4, arrayed types are rendered as Collection in the EDM(X).

    Filter expressions, instance-based authorization and search are not supported on arrayed elements.

    Null Values

    For arrayed types the null and not null constraints apply to the members of the collections. The default is not null indicating that the collections can’t hold null values.

    An empty collection is represented by an empty JSON array. A null value is invalid for an element with arrayed type.

    In the following example the collection emails may hold members that are null. It may also hold a member where the element kind is null. The collection email must not be null!

    entity Bar {
    emails      : many {
        kind    : String null;
        address : String not null;
    } null;
}

    Virtual Elements

    An element definition can be prefixed with modifier keyword virtual. This keyword indicates that this element isn’t added to persistent artifacts, that is, tables or views in SQL databases. Virtual elements are part of OData metadata.

    By default virtual elements are annotated with @Core.Computed: true, not writable for the client and will be silently ignored. This means also, that they are not accessible in custom event handlers. If you want to make virtual elements writable for the client, you explicitly need to annotate these elements with @Core.Computed: false. Still those elements are not persisted and therefore, for example, not sortable or filterable.

    entity Employees {
  ...
  virtual something : String(11);
}

    Literals

    Using literals in CDS models is commonly used, for example, to set default values. The literals in the following table show you how to define these values in your CDS source.

    Kind Example
    Null null
    Boolean true, false
    Numbers 11, 2.4, or 1.34e10
    Strings 'foo' or `foo` or ```foo```
    Dates date'2016-11-24'
    Times time'16:11:32'
    Timestamp timestamp'2016-11-24 16:11:32.4209753'
    DateTime '2016-11-24T16:11'
    Records {"foo":<literal>, ...}
    Arrays [<literal>, ...]

    Learn more about literals and their representation in CSN.

    Multiline String Literals

    String literals enclosed in single ticks, for example 'string', are limited to a single line.

    Use string literals enclosed in single or triple backticks for multiline strings. Within those strings, escape sequences from JavaScript, such as \t or \u0020, are supported. Line endings are normalized. If you don’t want a line ending at that position, end a line with a backslash (\). Only for string literals inside triple backticks, indentation is stripped and tagging is possible.

    Examples:

    @documentation: ```
    This is a CDS multiline string.
    - The indentation is stripped.
    - \u{0055}nicode escape sequences are possible,
      just like common escapes from JavaScript such as
      \r \t \n and more!
    ```

@data: ```xml
    <main>
      The tag is ignored by the core-compiler but may be
      used for syntax highlighting, similar to markdown.
    </main>
    ```
@escaped: `OK Emoji: \u{1f197}`
entity DocumentedEntity {
  // ...
}

    Delimited Identifiers

    Delimited identifiers allow you to use any identifier, even containing special characters or using a keyword.

    Special characters in identifiers or keywords as identifiers should be avoided for best interoperability.

    entity ![Entity] {
  bar           : ![Keyword];
  ![with space] : Integer;
}

    You can escape ] by ]], for example ![L[C]]R] which will be parsed as L[C]R.

    Calculated Elements (beta)

    This is a beta feature. Beta features aren’t part of the officially delivered scope that SAP guarantees for future releases. For more information, see Important Disclaimers and Legal Information.

    Elements of entities and aspects can be specified with a calculation expression, in which you can refer to other elements of the same entity/aspect.

    Today CAP CDS only supports calculated elements with a value expression with “on-read” semantics.

    On-read (beta)

    entity Employees {
  firstName : String;
  lastName : String;
  name : String = firstName || ' ' || lastName;
  name_upper = upper(name);
  addresses : Association to many Addresses;
  city = addresses[kind='home'].city;
}

    For a calculated element with “on-read” semantics, the calculation expression is evaluated when reading an entry from the entity. The calculated element is read-only, no value must be provided for it in a WRITE operation. Using such a calculated element in a query or view definition is equivalent to writing the expression directly into the query, both with respect to semantics and to performance. In CAP, it is implemented by replacing each occurrence of a calculated element in a query by the respective expression.

    Entity using calculated elements:

    entity EmployeeView as select from Employees {
  name,
  city
};

    Equivalent entity:

    entity EmployeeView as select from Employees {
  firstName || ' ' || lastName as name : String,
  addresses[kind='home'].city as city
};

    Calculated elements “on-read” are a pure convenience feature. Instead of having to write the same expression several times in queries, you can define a calculated element once and then simply refer to it.

    In the definition of a calculated element “on-read”, you can use almost all expressions that are allowed in queries. Some restrictions apply:

    • Subqueries are not allowed.
    • Nested projections (inline/expand) are not allowed.
    • A calculated element can’t be key.

    A calculated element can be used in every location where an expression can occur, with these exceptions:

    • A calculated element can’t be used in the ON condition of an unmanaged association.
    • A calculated element can’t be used as the foreign key of a managed association.

    There are some temporary restrictions:

    • Currently, a calculated element must always be accessed using a view/projection. An OData request or custom code can’t access the calculated element in the entity where it is defined.
    • A calculated element can’t be used in a query together with nested projections (inline/expand).

    On-write

    Calculated elements “on-write” are defined by adding the keyword stored. They are also referred to as “stored” calculated elements. A type specification is mandatory, and the expression must be enclosed in parentheses.

    entity Employees {
  firstName : String;
  lastName : String;
  name : String = (firstName || ' ' || lastName) stored;
}

    For a calculated element “on-write”, the expression is already evaluated when an entry is written into the entity (the calculated element itself is read-only, so no value must be provided for it). The resulting value is then stored/persisted like for a regular field. When reading from the entity, the calculated element behaves like a regular field. Using a stored calculated element can improve performance, in particular when it is used for ordering or filtering. This is paid for by higher memory consumption.

    While calculated elements “on-read” are handled in the CAP layer, the “on-write” variant is implemented by using the corresponding database feature for tables. The entity definition above results in the following table definition:

    -- SAP HANA syntax --
CREATE TABLE Employees (
  firstName NVARCHAR,
  lastName NVARCHAR,
  name NVARCHAR ALWAYS GENERATED AS (firstName || ' ' || lastName)
)

    There are restrictions on such calculated fields, which depend on the particular database used. But all databases currently supported by CAP have a common restriction: the calculation expression may only refer to fields of the same table row. Thus such an expression must not contain subqueries, aggregate functions, or paths with associations.

    Association-like calculated elements

    A calculated element can also define a refined association, like in this example:

    entity Employees {
  addresses : Association to many Addresses;
  homeAddress = addresses [kind='home'];
}

    Default Values

    As in SQL you can specify default values to fill in upon INSERTs if no value is specified for a given element.

    entity Foo {
  bar : String default 'bar';
  boo : Integer default 1;
}

    Default values can also be specified in custom type definitions:

    type CreatedAt : Timestamp default $now;
type Complex {
  real : Decimal default 0.0;
  imag : Decimal default 0.0;
}

    Type References

    If you want to base an element’s type on another element of the same structure, you can use the type of operator.

    entity Author {
  firstname : String(100);
   lastname : type of firstname; // has type "String(100)"
}

    For referencing elements of other artifacts, you can use the element access through :. Element references with : don’t require type of in front of them.

    entity Employees {
  firstname: Author:firstname;
  lastname: Author:lastname;
}

    Constraints

    Element definitions can be augmented with constraint not null as known from SQL.

    entity Employees {
  name : String(111) not null;
}

    Enums

    You can specify enumeration values for a type as a semicolon-delimited list of symbols. For string types, declaration of actual values is optional; if omitted, the actual values are the string counterparts of the symbols.

    type Gender : String enum { male; female; non_binary = 'non-binary'; }
entity Order {
  status : Integer enum {
    submitted =  1;
    fulfilled =  2;
    shipped   =  3;
    canceled  = -1;
  };
}

    To enforce your enum values during runtime, use the @assert.range annotation. For localization of enum values, model them as code list.


    Views and Projections

    Use as select from or as projection on to derive new entities from existing ones by projections, very much like views in SQL. When mapped to relational databases, such entities are in fact translated to SQL views but they’re frequently also used to declare projections without any SQL views involved.

    The entity signature is inferred from the projection.

    The as select from Variant

    Use the as select from variant to use all possible features an underlying relational database would support using any valid CQL query including all query clauses.

    entity Foo1 as SELECT from Bar; //> implicit {*}
entity Foo2 as SELECT from Employees { * };
entity Foo3 as SELECT from Employees LEFT JOIN Bar on Employees.ID=Bar.ID {
  foo, bar as car, sum(boo) as moo
} where exists (
  SELECT 1 as anyXY from SomeOtherEntity as soe where soe.x = y
)
group by foo, bar
order by moo asc;

    The as projection on Variant

    Use the as projection on variant instead of as select from to indicate that you don’t use the full power of SQL in your query. For example, having a restricted query in an entity allows us to serve such an entity from external OData services.

    entity Foo as projection on Bar {...}

    Currently the restrictions of as projection on compared to as select from are:

    • no explicit, manual JOINs
    • no explicit, manual UNIONs
    • no sub selects in from clauses

    Over time, we can add additional checks depending on specific outbound protocols.

    Views with Inferred Signatures

    By default views inherit all properties and annotations from their primary underlying base entity. Their elements signature is inferred from the projection on base elements. Each element inherits all properties from the respective base element, except the key property. The key property is only inherited if all of the following applies:

    • No explicit key is set in the query.
    • All key elements of the primary base entity are selected (for example, by using *).
    • No union, join or similar query construct is used.

    For example, the following definition:

    entity SomeView as SELECT from Employees {
  ID,
  name,
  job.title as jobTitle
};

    Might result in this inferred signature:

    entity SomeView {
  key ID: Integer;
  name: String;
  jobTitle: String;
};

    Use a CDL cast to set an element’s type, if one of the following conditions apply:

    • You don’t want to use the inferred type.
    • The query column is an expression (no inferred type is computed).
    entity SomeView as SELECT from Employees {
  ID : Integer64,
  name : LargeString,
  'SAP SE' as company : String
};

    By using a cast, annotations and other properties are inherited from the provided type and not the base element, see Annotation Propagation

    Views with Declared Signatures

    You can optionally declare the expected signature explicitly. This declaration overrides the inferred signature. The implementation can check the inferred signature against the declared one.

    entity SomeView {
  ID: Integer; name: String; jobTitle: String;
} as SELECT from Employees {
  ID, name, job.title as jobTitle
};

    Views with Nested Projections

    Use CQLs nested expands to declare projections on document structures and/or entity graphs. This results in structured document signatures.

    entity MyOrders as select from Orders {
  ID, buyer {
    ID, name
  },
  Items {
    pos, quantity, product {
      ID, title
    }
  }
};

    This projection would result in an inferred signature like that:

    entity MyOrders {
  ID : UUID;
  buyer : {
    ID : UUID;
    name : String;
  };
  Items : array of {
    pos : Integer;
    quantity : Integer;
    product : {
      ID : UUID;
      title : String;
    }
  }
};

    Views with Parameters

    You can equip views with parameters that are passed in whenever that view is queried. Default values can be specified. Refer to these parameters in the view’s query using the prefix :.

    entity SomeView ( foo: Integer, bar: Boolean )
as SELECT * from Employees where ID=:foo;

    Learn more about how to expose views with parameters in Services - Exposed Entities. Learn more about views with parameters for existing HANA artifacts in Native SAP HANA Artifacts.

    Associations & Compositions

    Associations capture relationships between entities. They are like forward-declared joins added to a table definition in SQL.

    Unmanaged Associations

    Unmanaged associations specify arbitrary join conditions in their on clause, which refer to available foreign key elements. The association’s name (address in the following example) is used as the alias for the to-be-joined target entity.

    entity Employees {
  address : Association to Addresses on address.ID = address_ID;
  address_ID : Integer;  //> foreign key
}

    entity Addresses {
  key ID : Integer;
}

    Managed (To-One) Associations

    For to-one associations, CDS can automatically resolve and add requisite foreign key elements from the target’s primary keys and implicitly add respective join conditions.

    entity Employees {
  address : Association to Addresses;
}

    This example is equivalent to the unmanaged example above, with the foreign key element address_ID being added automatically upon activation to a SQL database.

    For adding foreign key constraints on database level, see Database Constraints..

    To-many Associations

    For to-many associations specify an on condition following the canonical expression pattern <assoc>.<backlink> = $self as in this example:

    entity Employees {
  key ID : Integer;
  addresses : Association to many Addresses
    on addresses.owner = $self;
}

    entity Addresses {
  owner : Association to Employees;  //> the backlink
}

    The backlink can be any managed to-one association on the many side pointing back to the one side.

    Many-to-many Associations

    For many-to-many association, follow the common practice of resolving logical many-to-many relationships into two one-to-many associations using a link entity to connect both. For example:

    entity Employees { ...
  addresses : Association to many Emp2Addr on addresses.emp = $self;
}
entity Emp2Addr {
  key emp : Association to Employees;
  key adr : Association to Addresses;
}

    Learn more about Managed Compositions for Many-to-many Relationships.

    Managed many-to-many Associations

    With Managed Many-to-many Associations, CDS can generate requisite link tables automatically. You can use the via parameter clause to add elements to link table reflecting attributed relationships or to use a predefined link table instead.

    entity Employees {
  addresses1 : Association to many Addresses;
  addresses2 : Association to many Addresses via {
    kind: String(11);
  };
  addresses3 : Association to many Addresses via Emp2Addr;
}

    For the first case, cds.compile automatically adds a link table. For the second case, it automatically adds a link table with an additional element kind (→ an attributed relationship). For the third case, cds.compile uses the predefined entity Emp2Addr that is defined like that (names for source/target can be freely chosen):

    entity Emp2Addr {
  key emp : Association to Employees;
  key adr : Association to Addresses;
}

    Associations with Default Filters

    For to-many associations, you can optionally specify a default filter. That filter automatically applies to any usage of that association in queries, unless another filter is specified explicitly.

    entity Products {
  localized : Association to many Product$Texts
    with default filter lang=$env.user.lang;
}

    entity Product$Texts {
  key product : Association to Products;
  key lang : String(3);
  title : String(44);
  descr : String(444);
}

    Associations to Parameterized Views

    If the target is a parameterized view, you can specify corresponding arguments in an Association definition as follows:

    entity Products {
  assoc : Association to SomeParameterizedView (
    param1: 4711,
    param2: foo
  );
  foo : String;
}

    The argument values for parameters are literals or expressions in which references are resolved within the current entity’s elements.


    Compositions

    Compositions constitute document structures through ‘contained-in’ relationships. They frequently show up in to-many header-child scenarios.

    entity Orders {
  key ID: Integer; //...
  Items : Composition of many Orders.Items on Items.parent = $self;
}
entity Orders.Items {
  key pos : Integer;
  key parent : Association to Orders;
  product : Association to Products;
  quantity : Integer;
}

    Essentially, Compositions are the same as associations, just with the additional information that this association represents a contained-in relationship so the same syntax and rules apply in their base form.

    Managed Compositions of Aspects

    Use the managed compositions variant to nicely reflect document structures in your domain models, without the need for separate entities, reverse associations, and unmanaged on conditions.

    With Inline Targets

    entity Orders {
  key ID: Integer; //...
  Items : Composition of many {
    key pos : Integer;
    product : Association to Products;
    quantity : Integer;
  }
}

    Managed Compositions are mostly syntactical sugar: Behind the scenes, they are unfolded to the unmanaged equivalent as shown above by automatically adding a new entity, the name of which being constructed as a scoped name from the name of parent entity, followed by the name of the composition element, that is Orders.Items in the previous example. You can safely use this name at other places, for example to define an association to the generated child entity:

      specialItem : Association to Orders.Items;

    With Named Targets

    Instead of anonymous target aspects you can also specify named aspects, which are unfolded the same way as anonymous inner types, as shown in the previous example:

    entity Orders {
  key ID: Integer; //...
  Items : Composition of many OrderItems;
}
aspect OrderItems {
  key pos : Integer;
  product : Association to Products;
  quantity : Integer;
}

    Default Target Cardinality

    If not otherwise specified, a managed composition of an aspect has the default target cardinality to many.

    For Many-to-many Relationships

    Managed Compositions are handy for many-to-many relationships, where a link table usually is private to one side.

    entity Teams { ...
  members : Composition of many { key user: Association to Users; }
}
entity Users { ...
  teams: Association to many Teams.members on teams.user = $self;
}

    And here’s an example of an attributed many-to-many relationship:

    entity Teams { ...
  members : Composition of many {
    key user : Association to Users;
    role : String enum { Lead; Member; Collaborator; }
  }
}
entity Users { ... }

    To navigate between Teams and Users, you have to follow two associations: members.user or teams.up_. In OData, use a query like:

    GET /Teams?$expand=members($expand=user)

    to get all users of all teams.

    Annotations

    This section describes how to add Annotations to model definitions written in CDL, focused on the common syntax options, and fundamental concepts. Find additional information in the OData Annotations guide.

    Annotation Syntax

    Annotations in CDL are prefixed with an @ character and can be placed before a definition, after the defined name or at the end of simple definitions.

    @before entity Foo @inner {
  @before simpleElement @inner : String @after;
  @before structElement @inner { /* elements */ }
}

    Multiple annotations can be placed in each spot separated by whitespaces or enclosed in @(...) and separated by comma - like the following are equivalent:

    entity Foo @(
  my.annotation: foo,
  another.one: 4711
) { /* elements */ }

    @my.annotation:foo
@another.one: 4711
entity Foo { /* elements */ }

    For an @inner annotation, only the syntax @(...) is available.

    Annotation Targets

    You can basically annotate any named thing in a CDS model, such as:

    Contexts and services:

    @before [define] (context|service) Foo @inner { ... }

    Definitions and elements with simple types:

    @before [define] type Foo @inner : String @after;
@before [key] anElement @inner : String @after;

    Entities, aspects, and other struct types and elements thereof:

    @before [define] (entity|type|aspect|annotation) Foo @inner {
  @before simple @inner : String @after;
  @before struct @inner { ...elements... };
}

    Enums:

    ... status : String @inner enum {
  fulfilled @after;
}

    Columns in a view definition’s query:

    ... as SELECT from Foo {
  @before expr as alias @inner : String,
  ...
}

    Parameters in view definitions:

    ... with parameters (
  @before param @inner : String @after
) ...

    Actions/functions including their parameters and result elements:

    @before action doSomething @inner (
  @before param @inner : String @after
) returns {
  @before result @inner : String @after;
};

    Annotation Values

    Values can be literals or references. If no value is given, the default value is true as for @aFlag in the following example:

    @aFlag //= true, if no value is given
@aBoolean: false
@aString: 'foo'
@anInteger: 11
@aDecimal: 11.1
@aSymbol: #foo
@aReference: foo.bar
@anArray: [ /* can contain any kind of value */ ]

    As described in the CSN spec, the previously mentioned annotations would compile to CSN as follows:

    {
  "@aFlag": true,
  "@aBoolean": false,
  "@aString": "foo",
  "@anInteger": 11,
  "@aDecimal": 11.1,
  "@aSymbol": {"#":"foo"},
  "@aReference": {"=":"foo.bar"},
  "@anArray": [ ... ]
}

    References (and expressions in general) aren’t checked or resolved by CDS parsers or linkers. They’re interpreted and evaluated only on consumption-specific modules. For example, for SAP Fiori models, it’s the 4odata and 2edm(x) processors.

    Records as Syntax Shortcuts

    Annotations in CDS are flat lists of key-value pairs assigned to a target. The record syntax - that is, {key:<value>, ...} - is a shortcut notation that applies a common prefix to nested annotations. For example, the following are equivalent:

    @Common.foo.bar
@Common.foo.car: 'wheels'

    @Common: { foo.bar, foo.car: 'wheels' }

    @Common.foo: { bar }
@Common.foo.car: 'wheels'

    @Common.foo: { bar, car: 'wheels'  }

    and they would show up as follows in a parsed model (→ see CSN):

    {
  "@Common.foo.bar": true,
  "@Common.foo.car": "wheels",
}

    Annotation Propagation

    Annotations are inherited from types and base types to derived types, entities, and elements as well as from elements of underlying entities in case of views.

    For examples, given this view definition:

    using Books from './bookshop-model';
entity BooksList as SELECT from Books {
  ID, genre : Genre, title,
  author.name as author
};
    • BooksList would inherit annotations from Books
    • BooksList.ID would inherit from Books.ID
    • BooksList.author would inherit from Books.author.name
    • BooksList.genre would inherit from type Genre

    The rules are:

    1. Entity-level properties and annotations are inherited from the primary underlying source entity — here Books.

    2. Each element that can unambiguously be traced back to a single source element, inherits that element’s properties.

    3. An explicit cast in the select clause cuts off the inheritance, for example, as for genre in our previous example.

    The annotate Directive

    The annotate directive allows to annotate already existing definitions that may have been imported from other files or projects.

    annotate Foo with @title:'Foo' {
  nestedStructField {
    existingField @title:'Nested Field';
  }
}
annotate Bar with @title:'Bar';

    You can also directly annotate a single element:

    annotate Foo:nestedStructField.existingField @title:'Nested Field';

    Actions and functions and even their parameters can be annotated:

    service SomeService {
  entity SomeEntity { key id: Integer } actions
  {
    action boundAction(P: Integer);
  };
  action unboundAction(P: Integer);
};

annotate SomeService.unboundAction with @label: 'Action Label' (@label: 'First Parameter' P);
annotate SomeService.SomeEntity with actions {
     @label: 'Action label'
     boundAction(@label: 'firstParameter' P);
}

    The annotate directive is a variant of the extend directive. Actually, annotate is just a shortcut with the default mode being switched to extending existing fields instead of adding new ones.

    Extend Array Annotations

    Usually, the annotation value provided in an annotate directive overwrites an already existing annotation value.

    If the existing value is an array, the ellipsis syntax allows to insert new values before or after the existing entries, instead of overwriting the complete array. The ellipsis represents the already existing array entries. Of course, this works with any kind of array entries.

    This is a sample of an existing array:

    @anArray: [3, 4] entity Foo { /* elements */ }

    This shows how to extend the array:

    annotate Foo with @anArray: [1, 2, ...];  //> prepend new values: [1, 2, 3, 4]
annotate Foo with @anArray: [..., 5, 6];  //> append new values: [3, 4, 5, 6]
annotate Foo with @anArray: [1, 2, ..., 5, 6]; //> prepend and append

    It’s also possible to insert new entries at arbitrary positions. For this, use ... up to with a comparator value that identifies the insertion point.

    [... up to <comparator>, newEntry, ...]

    ... up to represents the existing entries of the array from the current position up to and including the first entry that matches the comparator. New entries are then inserted behind the matched entry. If there’s no match, new entries are appended at the end of the existing array.

    This is a sample of an existing array:

    @anArray: [1, 2, 3, 4, 5, 6] entity Bar { /* elements */ }

    This shows how to insert values after 2 and 4:

    annotate Bar with @anArray: [
  ... up to 2,  // existing entries 1, 2
   2.1, 2.2,    // insert new entries 2.1, 2.2
  ... up to 4,  // existing entries 3, 4
  4.1, 4.2,     // insert new entries 4.1, 4.2
  ...           // remaining existing entries 5, 6
];

    The resulting array is:

    [1, 2, 2.1, 2.2, 3, 4, 4.1, 4.2, 5, 6]

    If your array entries are objects, you have to provide a comparator object. It matches an existing entry, if all attributes provided in the comparator match the corresponding attributes in an existing entry. The comparator object doesn’t have to contain all attributes that the existing array entries have, simply choose those attributes that sufficiently characterize the array entry after which you want to insert. Only simple values are allowed for the comparator attributes.

    Example: Insert a new entry after BeginDate.

    @UI.LineItem: [
    { $Type: 'UI.DataFieldForAction', Action: 'TravelService.acceptTravel',  Label: '{i18n>AcceptTravel}'   },
    { Value: TravelID,  Label: 'ID'    },
    { Value: BeginDate, Label: 'Begin' },
    { Value: EndDate,   Label: 'End'   }
  ]
entity TravelService.Travel { /* elements */ }

    For this, you provide a comparator object with the attribute Value:

    annotate TravelService.Travel with @UI.LineItem: [
  ... up to { Value: BeginDate },  // ... up to with comparator object
  { Value: BeginWeekday, Label: 'Day of week' }, // new entry
  ... // remaining array entries
];


    Aspects

    CDS’s aspects allow to flexibly extend definitions by new elements as well as overriding properties and annotations. They’re based on a mixin approach as known from Aspect-oriented Programming methods.

    The extend Directive

    Use extend to add extension fields or to add/override metadata to existing definitions, for example, annotations, as follows:

    extend Foo with @title:'Foo' {
  newField : String;
  extend nestedStructField {
    newField : String;
    extend existingField @title:'Nested Field';
  }
}
extend Bar with @title:'Bar'; // nothing for elements

    Make sure that you prepend the extend keyword to nested elements, otherwise this would mean that you want to add a new field with that name:

    Learn more about the annotate Directive.

    You can also directly extend a single element:

    extend Foo:nestedStructField with { newField : String; }

    With extend you can enlarge the length of a String or precision and scale of a Decimal:

    extend User with (length:120);
extend Books:price.value with (precision:12,scale:3);

    The extended type or element directly must have the respective property.

    Named Aspects — define aspect

    You can use extend or annotate with predefined aspects, to apply the same extensions to multiple targets:

    extend Foo with ManagedObject;
extend Bar with ManagedObject;

    aspect ManagedObject {
  created { at: Timestamp; _by: User; }
}

    The define keyword is optional, that means define aspect Foo is equal to aspect Foo.

    If you use extend, all nested fields in the named aspect are interpreted as being extension fields. If you use annotate, the nested fields are interpreted as existing fields and the annotations are copied to the corresponding target elements.

    The named extension can be anything, for example, including other types or entities. Use keyword aspect as shown in the example to declare definitions that are only meant to be used in such extensions, not as types for elements.

    Includes – : as Shortcut Syntax

    You can use an inheritance-like syntax option to extend a definition with one or more named aspects as follows:

    define entity Foo : ManagedObject, AnotherAspect {
  key ID : Integer;
  name : String;
  ...
}

    This is syntactical sugar and equivalent to using a sequence of extends as follows:

    define entity Foo {}
extend Foo with ManagedObject;
extend Foo with AnotherAspect;
extend Foo with {
  key ID : Integer;
  name : String;
  ...
}

    You can apply this to any definition of an entity or a structured type.

    Looks Like Inheritance

    The :-based syntax option described before looks very much like (multiple) inheritance and in fact has very much the same effects. Yet, as mentioned in the beginning of this section, it isn’t based on inheritance but on mixins, which are more powerful and also avoid common problems like the infamous diamond shapes in type derivations.

    When combined with persistence mapping there are a few things to note, that goes down to which strategy to choose to map inheritance to, for example, relational models. See Aspects vs Inheritance for more details.

    Extending Views and Projections

    Use the extend <entity> with columns variant to extend the select list of a projection or view entity and do the following:

    • Include more elements existing in the underlying entity.
    • Add new calculated fields.
    • Add new unmanaged associations.
    extend Foo with @title:'Foo' columns {
  foo as moo @woo,
  1 + 1 as two,
  bar : Association to Bar on bar.ID = moo
}

    Enhancing nested structs isn’t supported. Note also that you can use the common annotate syntax, to just add/override annotations of a view’s elements.


    Services

    Service Definitions

    CDS allows to define service interfaces as collections of exposed entities enclosed in a service block, which essentially is and acts the same as context:

    service SomeService {
  entity SomeExposedEntity { ... };
  entity AnotherExposedEntity { ... };
}

    The endpoint of the exposed service is constructed by its name, following some conventions (the string service is dropped and kebab-case is enforced). If you want to overwrite the path, you can add the @path annotation as follows:

    @path: 'myCustomServicePath'
service SomeService { ... }

    Exposed Entities

    The entities exposed by a service are most frequently projections on entities from underlying data models. Standard view definitions, using as SELECT from or as projection on, can be used for exposing entities.

    service CatalogService {
  entity Product as projection on data.Products {
    *, created.at as since
  } excluding { created };
}
service MyOrders {
  //> $user only implemented for SAP HANA
  entity Order as select from data.Orders { * } where buyer=$user.id;
  entity Product as projection on CatalogService.Product;
}

    You can optionally add annotations such as @readonly or @insertonly to exposed entities, which, will be enforced by the CAP runtimes in Java and Node.js.

    Entities can be also exposed as views with parameters:

    service MyOrders {
  entity OrderWithParameter( foo: Integer ) as select from data.Orders where id=:foo;
}

    A view with parameter modeled in the previous example, can be exposed as follows:

    service SomeService {
  entity ViewInService( p1: Integer, p2: Boolean ) as select from data.SomeView(foo: :p1, bar: :p2) {*};
}

    Then the OData request for views with parameters should look like this:

    GET: /OrderWithParameter(foo=5)/Set or GET: /OrderWithParameter(5)/Set
GET: /ViewInService(p1=5, p2=true)/Set

    (Auto-) Redirected Associations

    When exposing related entities, associations are automatically redirected. This ensures that clients can navigate between projected entities as expected. For example:

    service AdminService {
  entity Books as projection on my.Books;
  entity Authors as projection on my.Authors;
  //> AdminService.Authors.books refers to AdminService.Books
}

    Resolving Ambiguities

    Auto-redirection fails if a target can’t be resolved unambiguously, that is, when there is more than one projection with the same minimal ‘distance’ to the source. For example, compiling the following model with two projections on my.Books would produce this error:

    Target “Books” is exposed in service “AdminService” by multiple projections “AdminService.ListOfBooks”, “AdminService.Books” - no implicit redirection.

    service AdminService {
  entity ListOfBooks as projection on my.Books;
  entity Books as projection on my.Books;
  entity Authors as projection on my.Authors;
  //> which one should AdminService.Authors.books refers to?
}

    Using redirected to with Projected Associations

    You can use redirected to to resolve the ambiguity as follows:

    service AdminService {
  ...
  entity Authors as projection on my.Authors { *,
    books : redirected to Books //> resolved ambiguity
  };
}

    Using @cds.redirection.target Annotations

    Alternatively, you can use the boolean annotation @cds.redirection.target with value true to make an entity a preferred redirection target, or with value false to exclude an entity as target for auto-redirection.

    service AdminService {
  @cds.redirection.target: true
  entity ListOfBooks as projection on my.Books;
  ...
}

    Auto-Exposed Entities

    Annotate entities with @cds.autoexpose to automatically expose them in services containing entities with associations referring to them.

    For example, given the following entity definitions:

    // schema.cds
namespace schema;
entity Bar @cds.autoexpose { key id: Integer; }

using { sap.common.CodeList } from '@sap/cds/common';
entity Car : CodeList { key code: Integer; }
//> inherits  @cds.autoexpose from  sap.common.CodeList

    … a service definition like this:

    using { schema as my } from './schema.cds';
service Zoo {
  entity Foo { //...
    bar : Association to my.Bar;
    car : Association to my.Car;
  }
}

    … would result in the service being automatically extended like this:

    extend service Zoo with { // auto-exposed entities:
   @readonly entity Foo_bar as projection on Bar;
   @readonly entity Foo_car as projection on Car;
}

    You can still expose such entities explicitly, for example, to make them read-write:

    service Sue {
  entity Foo { /*...*/ }
  entity Bar as projection on my.Bar;
}

    Composition targets are auto-exposed in service interfaces.

    Learn more about Compositions. Learn more about CodeLists in @sap/cds/common.

    Custom Actions and Functions

    Within service definitions, you can additionally specify actions and functions. Use a comma-separated list of named and typed inbound parameters (optional) and a response type (optional for actions), which can be either a:

    service MyOrders {
  entity Order { /*...*/ };
  // unbound actions / functions
  type cancelOrderRet {
    acknowledge: String enum { succeeded; failed; };
    message: String;
  }
  action cancelOrder ( orderID:Integer, reason:String ) returns cancelOrderRet;
  function countOrders() returns Integer;
  function getOpenOrders() returns array of Order;
}

    The notion of actions and functions in CDS adopts that of OData; actions and functions on service-level are unbound ones.

    Bound Actions and Functions

    Actions and functions can also be bound to individual entities of a service, enclosed in an additional actions block as the last clause in an entity/view definition.

    service CatalogService {
  entity Products as projection on data.Products { ... }
    actions {
      // bound actions/functions
      action addRating (stars: Integer);
      function getViewsCount() returns Integer;
    }
}

    Bound actions and functions have a binding parameter that is usually implicit. It can also be modeled explicitly: the first parameter of a bound action or function is treated as binding parameter, if it’s typed by [many] $self. Use Explicit Binding to control the naming of the binding parameter. Use the keyword many to indicate that the action or function is bound to a collection of instances rather than to a single one.

    service CatalogService {
  entity Products as projection on data.Products { ... }
    actions {
      // bound actions/functions with explicit binding parameter
      action A1 (prod: $self, stars: Integer);
      action A2 (in: many $self);  // bound to collection of Products
    }
}

    Explicitly modelled binding parameters are ignored for OData V2.

    Custom-Defined Events

    Similar to Actions and Functions you can declare events, which a service emits via messaging channels. Essentially, an event declaration looks very much like a type definition, specifying the event’s name and the type structure of the event messages’ payload.

    service MyOrders { ...
  event OrderCanceled {
    orderID: Integer;
    reason: String;
  }
}

    Extending Services

    You can extend services with additional entities and actions much as you would add new entities to a context:

    extend service CatalogService with {
  entity Foo {};
  function getRatings() returns Integer;
}

    Similarly, you can extend entities with additional actions as you would add new elements:

    extend entity CatalogService.Products with actions {
  function getRatings() returns Integer;
}

    Derived Services

    Define abstract services and inherit from it in other service definitions as in this example:

    abstract service ShoppingService {
  abstract entity Articles {...}
  entity Suppliers {...}
  entity ShoppingCart {} actions {
    action submitOrder();
  }
}

    service Bookshop : ShoppingService {
  entity Books : ShoppingService.Articles {
    author : Association to Authors;
  }
  entity Authors {...}
}


    Namespaces

    The namespace Directive

    To prefix the names of all subsequent definitions, place a namespace directive at the top of a model. This is comparable to other languages, like Java.

    namespaces.cds

    namespace foo.bar;
entity Foo {}           //> foo.bar.Foo 
entity Bar : Foo {}     //> foo.bar.Bar

    The context Directive

    Use contexts for nested namespace sections.

    contexts.cds

    namespace foo.bar;
entity Foo {}           //> foo.bar.Foo
context scoped {
  entity Bar : Foo {}   //> foo.bar.scoped.Bar
  context nested {
    entity Zoo {}       //> foo.bar.scoped.nested.Zoo
  }
}

    Scoped Definitions

    You can define types and entities with other definitions’ names as prefixes:

    namespace foo.bar;
entity Foo {}           //> foo.bar.Foo
entity Foo.Bar {}       //> foo.bar.Foo.Bar
type Foo.Bar.Car {}     //> foo.bar.Foo.Bar.Car

    Fully Qualified Names

    A model ultimately is a collection of definitions with unique, fully qualified names. For example, the second model above would compile to this CSN:

    contexts.json

    {"definitions":{
  "foo.bar.Foo": { "kind": "entity" },
  "foo.bar.scoped": { "kind": "context" },
  "foo.bar.scoped.Bar": { "kind": "entity",
    "includes": [ "foo.bar.Foo" ]
  },
  "foo.bar.scoped.nested": { "kind": "context" },
  "foo.bar.scoped.nested.Zoo": { "kind": "entity" }
}}


    Import Directives

    The using Directive

    Using directives allows to import definitions from other CDS models. As shown in line three below you can specify aliases to be used subsequently. You can import single definitions as well as several ones with a common namespace prefix. Optional: Choose a local alias.

    using-from.cds

    using foo.bar.scoped.Bar from './contexts';
using foo.bar.scoped.nested from './contexts';
using foo.bar.scoped.nested as specified from './contexts';

entity Car : Bar {}            //> : foo.bar.scoped.Bar 
entity Moo : nested.Zoo {}     //> : foo.bar.scoped.nested.Zoo
entity Zoo : specified.Zoo {}  //> : foo.bar.scoped.nested.Zoo

    Multiple named imports through ES6-like deconstructors:

    using { Foo as Moo, sub.Bar } from './base-model';
entity Boo : Moo { /*...*/ }
entity Car : Bar { /*...*/ }

    Also in the deconstructor variant of using shown in the previous example, specify fully qualified names.

    The import Directive

    The import directive extends the using directive to fully support syntax and semantics of import statements in ES6.

    Imported names can omit the target’s namespace prefix:

    import {Foo} from './base-model';

    Multiple named imports through ES6-like deconstructors:

    import { Foo as Moo, scoped.Bar } from './base-model';
entity Boo : Moo;
entity Car : Bar;

    Imports with locally chosen prefixes (independent from target namespaces):

    import base from './base-model';
entity Foo : base.Foo;
entity Bar : base.scoped.Bar;

    Model Resolution

    Imports in cds work very much like require in node and imports in ES6. In fact, we reuse Node’s module loading mechanisms. Hence, the same rules apply:

    • Relative path resolution Names starting with ./ or ../ are resolved relative to the current model.
    • Resolving absolute references They’re fetched for in node_modules folders:
      • Files having .cds, .csn, or .json as suffixes, appended in order
      • Folders, from either the file set in cds.main in the folder’s package.json or index.<cds|csn|json> file.

    To allow for loading from precompiled .json files it’s recommended to omit .cds suffixes in import statements, as shown in the provided examples.

    Comments

    Single-Line Comments — //

    Any text between // and the end of the line is ignored:

    entity Employees {
  key ID : Integer;  // a single-line comment
  name : String;
}

    Multi-Line Comments — /* */

    Any text between /* and */ is ignored:

    entity Employees {
  key ID : Integer;
/*
  a multi-line comment
*/
  name : String;
}

    unless it is a doc comment.

    Doc Comments — /** */

    A multi-line comment of the form /** */ at an annotation position is considered a doc comment:

    /**
 * I am the description for "Employee"
 */
entity Employees {
  key ID : Integer;
  /**
   * I am the description for "name"
   */
  name : String;
}

    The text of a doc comment is stored in CSN in the property doc. When generating OData EDM(X), it appears as value for the annotation @Core.Description.

    When generating output for deployment to SAP HANA, the first paragraph of a doc comment is translated to the HANA COMMENT feature for tables, table columns, and for views (but not for view columns):

    CREATE TABLE Employees (
  ID INTEGER,
  name NVARCHAR(...) COMMENT 'I am the description for "name"'
) COMMENT 'I am the description for "Employee"'

    Doc comments need to be switched on when calling the compiler:

    # in CLI:
cds compile foo.cds --docs

    // in JavaScript:
cds.compile(..., { docs: true })
    ✉