wip: data federation

.gitignore

@@ -3,3 +3,9 @@
 _out
 gen
 node_modules
+csn.json
+datasphere.json
+default-env.json
+
+# added by cds
+.cdsrc-private.json

.plugins/datasphere/index.js

@@ -0,0 +1,102 @@
+const model = require('../../csn.json')
+
+// Remove includes as Data Sphere doesn't support them
+for (const name in model.definitions) {
+  const def = model.definitions[name]
+  const includes = def.includes
+  if (!includes) continue
+  for (const include of includes) {
+    const i = model.definitions[include]
+    def.elements = { ...def.elements, ...i.elements }
+  }
+  delete def.includes
+}
+
+// Inline custom types to simplify managed association removal
+for (const name in model.definitions) {
+  const def = model.definitions[name]
+  const elements = def.elements
+  if (!elements) continue
+  for (const col in elements) {
+    const element = elements[col]
+    const customType = model.definitions[element.type]
+    if (!customType) continue
+    elements[col] = { ...customType, kind: undefined }
+  }
+}
+
+// Remove managed association as Data Sphere doesn't support them
+for (const name in model.definitions) {
+  const def = model.definitions[name]
+  const elements = def.elements
+  if (!elements) continue
+  for (const col in elements) {
+    const element = elements[col]
+
+    // Data Sphere doesn't know that value.xpr is a thing that is supposed to be supported
+    if (element.value && element.value.xpr) {
+      element.xpr = element.value.xpr
+      delete element.value
+    }
+    if (!(element.type in { 'cds.Association': 1, 'cds.Composition': 1 })) continue
+    if (!element.keys) continue
+    const keys = element.keys
+    const on = []
+    let first = true
+    for (const k of keys) {
+      if (first) first = false
+      else on.push('and')
+      const foreignKey = `${col}_${k.ref[0]}`
+      on.push(
+        { ref: [col, k.ref[0]] },
+        '=',
+        { ref: [foreignKey] },
+      )
+      const target = model.definitions[element.target]
+      elements[foreignKey] = { ...target.elements[k.ref[0]], key: element.key }
+    }
+    delete element.keys
+    delete element.key
+    element.on = on
+  }
+}
+
+// Collect all @data.product service to convert to Data Sphere annotation
+const dataProductServices = []
+for (const name in model.definitions) {
+  const def = model.definitions[name]
+  if (def.kind !== 'service' || !def['@data.product']) continue
+  dataProductServices.push(name)
+}
+
+// Just keep entities as Data Sphere doesn't handle the other types
+for (const name in model.definitions) {
+  const def = model.definitions[name]
+  if (def.kind === 'entity') continue
+  delete model.definitions[name]
+}
+
+// Enhance all the entities with Data Sphere annotations for compatibility
+for (const name in model.definitions) {
+  const def = model.definitions[name]
+  if (def.kind !== 'entity') continue
+  delete def['@cds.autoexpose']
+  delete def['@cds.persistence.skip']
+  def['@DataWarehouse.consumption.external'] = dataProductServices.some(s => name.startsWith(s))
+  def['@ObjectModel.modelingPattern'] = { '#': 'DATA_STRUCTURE' }
+  def['@ObjectModel.supportedCapabilities'] = [{ '#': 'DATA_STRUCTURE' }]
+  if (def.projection) def['@DataWarehouse.sqlEditor.query'] = `SELECT * FROM "${def.projection.from.ref[0]}"`
+}
+
+
+
+const fs = require('node:fs')
+const path = require('node:path')
+
+const dataSphereString = JSON.stringify(model, null, 2)
+  .replace(/\.texts"/g, '_texts"')
+
+fs.writeFileSync(
+  path.resolve(path.dirname(require.resolve('../../csn.json')), 'datasphere.json'),
+  dataSphereString
+)

db/src/.hdiconfig

@@ -0,0 +1,7 @@
+{
+  "file_suffixes": {
+    "hdbrole": {
+      "plugin_name": "com.sap.hana.di.role"
+    }
+  }
+}

db/src/public.hdbrole

@@ -0,0 +1,98 @@
+{
+  "role": {
+    "name": "PUBLIC#",
+    "object_privileges": [
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_AIRLINES",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_AIRPORTS",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_COUNTRIES",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_COUNTRIES_TEXTS",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_CURRENCIES",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_CURRENCIES_TEXTS",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_FLIGHTS",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_LANGUAGES",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_LANGUAGES_TEXTS",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_SUPPLEMENTTYPES",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_SUPPLEMENTTYPES_TEXTS",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_SUPPLEMENTS",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      },
+      {
+        "name": "SAP_CAPIRE_FLIGHTS_DATA_SUPPLEMENTS_TEXTS",
+        "type": "VIEW",
+        "privileges_with_grant_option": [
+          "SELECT"
+        ]
+      }
+    ]
+  }
+}

index.cds

@@ -2,3 +2,6 @@
 using from './srv/data-products';
 using from './srv/srv-events';
 using from './srv/workarounds';
+
+// simulate cds export
+annotate sap.capire.flights.data with @cds.external;

package.json

@@ -2,13 +2,24 @@
   "name": "@capire/xflights",
   "version": "1.0.0",
   "description": "CAP sample for master data service",
+  "scripts": {
+    "datasphere": "cdsc toCsn ./index.cds -o . && node ./.plugins/datasphere/index.js"
+  },
   "dependencies": {
+    "@cap-js/hana": "^2.1.2",
     "@sap/cds": ">=9",
     "express": "^4"
   },
   "devDependencies": {
     "@cap-js/cds-test": "*",
     "@cap-js/sqlite": ">=2"
   },
-  "license": "Apache-2.0"
+  "license": "Apache-2.0",
+  "cds": {
+    "[hybrid]": {
+      "requires": {
+        "db": "hana"
+      }
+    }
+  }
 }

srv/data-products.cds

@@ -8,7 +8,7 @@ service sap.capire.flights.data {
     key flight.ID, flight.{*} excluding { ID },
     key date, // preserve the flight date as a key
     *, // include all other fields from my.Flights
-  } excluding { flight };
+  } excluding { flight, date, free_seats };
 
   // Serve Airlines, Airports, and Supplements data as is
   entity Airlines as projection on my.Airlines;

test/requests.http

@@ -1,7 +1,7 @@
 
-@odata = http://localhost:4004/odata/v4/flights
-@rest = http://localhost:4004/rest/flights
-@hcql = http://localhost:4004/hcql/flights
+@odata = http://localhost:4005/odata/v4/flights
+@rest = http://localhost:4005/rest/flights
+@hcql = http://localhost:4005/hcql/flights
 
 @cql = \n Content-Type: text/plain \n\n
 
@@ -15,6 +15,22 @@ GET {{odata}}/$metadata
 GET {{odata}}/Connections
 ###
 
+POST {{odata}}/Flights
+Authorization: Basic alice:
+Content-Type: application/json
+
+{
+  "aircraft": "A380-800",
+  "currency_code": "USD",
+  "date": "2024-06-06",
+  "flight_ID": "TEST001",
+  "free_seats": 29,
+  "maximum_seats": 475,
+  "occupied_seats": 446,
+  "price": "3781.0000"
+}
+###
+
 GET {{rest}}/Connections
 ###