Skip to content

core-data-services-cds-language-reference-documentation-855e00b.md

Latest commit

 

History

History
35 lines (17 loc) · 2.87 KB

core-data-services-cds-language-reference-documentation-855e00b.md

File metadata and controls

35 lines (17 loc) · 2.87 KB

Core Data Services (CDS) Language Reference Documentation

CDS is the backbone of the SAP Cloud Application Programming Model (CAP). It provides the means to declaratively capture service definitions and data models, queries, and expressions in plain (JavaScript) object notations. CDS features to parse from a variety of source languages and to compile them into various target languages.

CDS models are plain JavaScript objects complying to the Core Schema Notation (CSN), an open specification derived from JSON Schema. You can easily create or interpret these models, which foster extensions by 3rd-party contributions. Models are processed dynamically at runtime and can also be created dynamically.

For further information, please refer to the following sections:

  • Upgrade to Compiler v2 - CDS compiler version 2 (cv2) brings numerous improvements, which allow us to significantly streamline model processing going forward.

  • Definition Language (CDL) - A reference and overview of all CDS concepts and features in the form of compact examples.

  • Schema Notation (CSN) - Specification of CSN, CDS’ canonical format for representing CDS models as plain JavaScript objects, similar to JSON Schema.

  • Query Language (CQL) - Documents the CDS Query Language (aka CQL) which is an extension of the standard SQL SELECT statement.

  • Query Notation (CQN) - Specification of the Core Query Notation (CQN) format that is used to capture queries as plain JavaScript objects.

  • Expression Notation (CXN) - Specification of the Core Expression Notation (CXN) used to capture expressions as plain JavaScript objects.

  • Built-in Types - List of provided built-in types.

  • Common Types & Aspects - Introduces @sap/cds/common a prebuilt CDS model shipped with @sap/cds that provides common types and aspects.

  • Common Annotations - A reference and glossary of common annotations intrinsically supported by the CDS compiler and runtimes.

  • Compiler Messages - This page lists selected error messages and explanations on how to fix them.

  • The Nature of Models - Introduces the fundamental principles of CDS models.

  • Node.js API - The CDS compiler is implemented in Node.js. Find here the reference documentation for the respective APIs which can be used in CLI tools as well at runtime in CDS service implementations.