CAP CDS Quick Reference

Comprehensive CDS (Core Data Services) syntax reference for SAP Cloud Application Programming Model.

Entities

Basic Entity

entity Books {
  key ID : UUID;
  title  : String(100);
  price  : Decimal(10,2);
  stock  : Integer;
}

Entity with Aspects

using { cuid, managed } from '@sap/cds/common';

entity Books : cuid, managed {
  title  : String(100);
  price  : Decimal(10,2);
}
// cuid adds: ID : UUID
// managed adds: createdAt, createdBy, modifiedAt, modifiedBy

Associations

entity Books {
  key ID     : UUID;
  title      : String(100);
  author     : Association to Authors;  // to-one
  reviews    : Composition of many Reviews on reviews.book = $self;  // to-many
}

Services

Basic Service

service CatalogService {
  entity Books as projection on my.Books;
  entity Authors as projection on my.Authors;
}

Service with Actions

service OrdersService {
  entity Orders as projection on my.Orders actions {
    action cancel() returns String;
  };
}

Annotations

Basic Annotations

entity Books {
  title  : String(100) @title: 'Book Title';
  price  : Decimal(10,2) @title: 'Price';
  stock  : Integer @assert.range: [0, 9999];
}

UI Annotations (Fiori)

annotate CatalogService.Books with @(
  UI.LineItem: [
    { Value: title, Label: 'Title' },
    { Value: author.name, Label: 'Author' }
  ]
);

CQL Queries

SELECT

const books = await SELECT.from(Books);
const book = await SELECT.one.from(Books).where({ ID: bookID });

INSERT

await INSERT.into(Books).entries({ title: 'CAP Guide', price: 29.99 });

UPDATE

await UPDATE(Books).set({ stock: stock + 10 }).where({ ID: bookID });

DELETE

await DELETE.from(Books).where({ ID: bookID });

Complete Reference

For comprehensive documentation, see:

• CDL Syntax Reference
• Annotations Reference
• CQL Queries Reference