{"ref":"artifact:cap-js-cds-federation-synonyms","page":"/artifacts/cap-js-cds-federation-synonyms","json":"/artifacts/cap-js-cds-federation-synonyms.json","generated":"2026-10-26","drafted_with_ai":true,"entity":{"id":"cap-js-cds-federation-synonyms","name":"cds-federation-synonyms","artifact_type":"cds-plugin","ecosystem":"cap","flavors":[{"key":"node","source":{"url":"https://github.com/cap-js/cds-federation-synonyms","title":"cap-js/cds-federation-synonyms — README","checked":"2026-09-13","quote":"npm install git+https://github.com/cap-js/cds-federation-synonyms.git"}}],"domain":"data-and-persistence","origin_ring":"sap-official","description":{"one_line":"An experimental CAP plugin for CAP-to-CAP data federation over SAP HANA synonyms, so one project reads another's tables without the rows being copied.","short":"CAP-to-CAP data federation over SAP HANA synonyms","when_not_to_use":"When your adoption policy excludes experimental dependencies: the [maintainer’s README](https://github.com/cap-js/cds-federation-synonyms#about-this-project) explicitly labels this plugin experimental."},"links":{"repo":"https://github.com/cap-js/cds-federation-synonyms"},"type_properties":{"distribution":{"value":["npm"],"sources":[{"url":"https://github.com/cap-js/cds-federation-synonyms","title":"cds-federation-synonyms — README","checked":"2026-10-18","quote":"npm install git+https://github.com/cap-js/cds-federation-synonyms.git"}]}},"provides":[{"capability":"capability:replication","what_it_does":"Represents another CAP application's exported entities as SAP HANA synonyms in the consuming application's schema, so a consumption view reads the provider's tables in place and no row is copied; access to the provider is read-only.","sources":[{"url":"https://github.com/cap-js/cds-federation-synonyms#readme","title":"cds-federation-synonyms — README","checked":"2026-09-27","quote":"For CAP applications using SAP HANA as database, this plugin enables CAP-to-CAP data federation by integration on the database layer via synonyms."}],"facets":[{"key":"strategy","value":["federate"],"source":{"url":"https://github.com/cap-js/cds-federation-synonyms#readme","title":"cds-federation-synonyms — README","checked":"2026-09-27","quote":"For CAP applications using SAP HANA as database, this plugin enables CAP-to-CAP data federation by integration on the database layer via synonyms."}},{"key":"refresh","value":["on read"],"source":{"url":"https://github.com/cap-js/cds-federation-synonyms#readme","title":"cds-federation-synonyms — README","checked":"2026-09-27","quote":"the imported entities are represented as synonyms that point to the respective tables or views in the database schema of the application that provides the data"}},{"key":"writes_through","value":false,"source":{"url":"https://github.com/cap-js/cds-federation-synonyms#readme","title":"cds-federation-synonyms — README","checked":"2026-09-27","quote":"Acess to the producer is read-only."}},{"key":"source_kind","value":["CAP service","SAP HANA schema"],"source":{"url":"https://github.com/cap-js/cds-federation-synonyms#readme","title":"cds-federation-synonyms — README","checked":"2026-09-27","quote":"Both \"provider\" and \"consumer\" are CAP apps, using SAP HANA as database."}},{"key":"target_kind","value":["SAP HANA synonym"],"source":{"url":"https://github.com/cap-js/cds-federation-synonyms#readme","title":"cds-federation-synonyms — README","checked":"2026-09-27","quote":"In the consumer app, the imported entity `datasrv.books` is represented by a synonym."}}]},{"capability":"capability:hana-native-artifacts","what_it_does":"Generates the SAP HANA synonyms and the role that let one CAP application's schema read another's tables and views in place, for the CAP-to-CAP case, with the synonyms switchable between connected and local mock tables.","sources":[{"url":"https://github.com/cap-js/cds-federation-synonyms#readme","title":"cds-federation-synonyms — README","checked":"2026-09-27","quote":"In the database schema of the application that consumes the data (\"consumer\"), the imported entities are represented as synonyms that point to the respective tables or views in the database schema of the application that provides the data (\"provider\")."},{"url":"https://github.com/cap-js/cds-federation-synonyms#readme","title":"cds-federation-synonyms — README","checked":"2026-09-27","quote":"For access control, a HANA role `datasrv` is generated that grants `SELECT` privileges to all entities in the service."}]}],"provenance":{"discovered_via":[{"source":"source:npm"},{"source":"source:discover"}],"first_seen":"2026-08-30"},"maintainers":["actor:cap-js"],"contributors":["actor:stewsk"],"history":[{"date":"2026-09-08","field":"description.one_line","from":"CDS plugin for CAP-to-CAP Data Federation based on SAP HANA synonyms.","to":"CAP-to-CAP data federation over SAP HANA synonyms, so one project reads another's tables without the rows being copied.","reason":"Placement copied the package's own npm description. Replaced with a line written for this graph — what it does and where it sits — because an unattributed sentence is an unattributed claim."},{"date":"2026-09-17","field":"description.when_not_to_use","from":"","to":"When your adoption policy excludes experimental dependencies: the [maintainer’s README](https://github.com/cap-js/cds-federation-synonyms#about-this-project) explicitly labels this plugin experimental.","reason":"Retrieved the maintainer README on 2026-09-17: “This plugin is still experimental.” Record its declared status as conditional adoption guidance without inferring a production prohibition."}],"drafted_with_ai":true,"requires":[{"ref":"artifact:btp-hana-cloud","requirement":"required","for":"Both applications must run on SAP HANA in the same instance, because the federation is a database synonym from one schema to another.","sources":[{"url":"https://github.com/cap-js/cds-federation-synonyms#readme","title":"cds-federation-synonyms — README","checked":"2026-09-27","quote":"Both \"provider\" and \"consumer\" run in the same SAP HANA instance, and, if Native Multitenancy in SAP HANA Cloud is switched on, live in the same tenant."}]},{"ref":"artifact:sap-xssec","requirement":"required","for":"A component the plugin uses, under SAP's proprietary licence, which the README asks the consumer to review and accept.","sources":[{"url":"https://github.com/cap-js/cds-federation-synonyms#readme","title":"cds-federation-synonyms — README","checked":"2026-09-27","quote":"The plugin uses two components which are under SAP properity licesenses. You need to review and accept them if you consume the plugin"}]}]},"effective_normative_relations":[{"instrument":"instrument:sap-developer-license-3-2-cap","relation":"use-constrained-by","sections":["1","2","3"],"applies_when":"A cds-plugin is used with SAP CAP materials, or an artifact is explicitly identified as a CAP plugin or application.","note":"This is inherited applicability, not a licence verdict about the artifact itself. Review the agreement for the actual materials and use; an explicit artifact relationship to another revision takes precedence.","scope":{"kind":"artifact"},"sources":[{"url":"https://cap.cloud.sap/resources/license/developer-license-3_2_CAP.txt","title":"SAP Developer License Agreement 3.2 CAP","checked":"2026-09-16","quote":"documentation, plug-ins, templates, scripts and sample code, libraries, software development kits"}],"inherited_from":"cap-plugins-and-applications","relevant_capabilities":["agent-systems-access","async-processing","data-import-export","database-connectors","deployment","destinations","llm-integration","mcp-servers","plugin-authoring","replication","retrieval-augmented-generation","rfc-connectivity"]}],"readings":{"liveness":[{"label":"Maintenance","tier":"unknown","evidence":"no release data"},{"label":"Continuity","tier":"good","evidence":"4 contributors, org-owned"},{"label":"Repository","tier":"good","evidence":"pushed 2026-10, not archived"}],"compatibility":[{"label":"Declared for","tier":"fair","evidence":"nothing declared"},{"label":"Survived majors","tier":"unknown","evidence":"no release dates"},{"label":"Maintainer's CI","tier":"good","evidence":"CI green, 2026-10-23"}],"practice":[{"label":"Tests","tier":"good","evidence":"88 test files"},{"label":"Docs","tier":"good","evidence":"docs/ with 3 pages, README 5 KB"},{"label":"Changelog","tier":"good","evidence":"CHANGELOG in the repo"}],"reach":[{"value":null,"unit":"installs/week"},{"value":4,"unit":"watching"}]},"signals":{"crawled_at":"2026-10-26","npm":"not published under this name","stars":4,"forks":0,"open_issues":0,"archived":false,"pushed_at":"2026-10-23","license_spdx":"Apache-2.0","org_owned":true,"default_branch":"main","contributors":4,"tree_truncated":false,"test_files":88,"workflows":1,"other_ci":false,"readme_bytes":5426,"docs_files":3,"changelog":true,"license_file":true,"dts_files":0,"ci_status":"success","ci_run_at":"2026-10-23","ci_workflow":"CI","ci_event":"push","readme_path":"README.md","readme_sha":"b09bd170dfe8b5567f2c533b8f121743940065a7","first_commit":"2026-06-30","last_commit":"2026-10-23","commits":22,"created_at":"2026-06-30T13:16:30Z","open_prs":0,"repo_read":"2026-10-26"},"release_notes":{"license":"Apache-2.0","quotable":true,"source":{"kind":"repo","path":"CHANGELOG.md","ref":"main","url":"https://github.com/cap-js/cds-federation-synonyms/blob/main/CHANGELOG.md"},"format":"keep-a-changelog","releases":[{"version":"1.0.0","heading":"Version 1.0.0 - TBD","url":"https://github.com/cap-js/cds-federation-synonyms/blob/main/CHANGELOG.md#version-100---tbd","sections":[{"kind":"feature","heading":"Added","items":0},{"kind":"change","heading":"Changed","items":0},{"kind":"fix","heading":"Fixed","items":0},{"kind":"removal","heading":"Removed","items":0}],"hash":"d2003bc219f4307d"}],"crawled_at":"2026-10-25"},"edges":{"maintainers":[{"ref":"actor:cap-js","name":"SAP Cloud Application Programming Model","json":"/actors/cap-js.json"}],"contributors":[{"ref":"actor:stewsk","name":"Steffen Weinstock","json":"/actors/stewsk.json"}],"explained_by":[{"ref":"content:devtoberfest-2026-cap-level-data-federation","name":"CAP-level Data Federation","json":"/content/devtoberfest-2026-cap-level-data-federation.json"}],"alternative_to_this":[],"needed_by":[],"available_via":[],"parts":[],"add_ons":[],"answered_through_parts":[]}}