CapabilityData & PersistenceNode.js, read from its artifacts

Data federation

Reading data that lives in another system as if it were local — by federating the query, by copying the rows, or by caching what was read. Three different answers to one question, and the choice is about how stale you can afford to be.

Showing artifacts, examples and content with confirmed Node.js applicability. View All CAP

Overview

SAP SHIPS
cds-federation-synonyms

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.

Sourcecds-federation-synonyms — READMEchecked
@sap/cds

Shows service-level replication as application code in the Data Federation guide: about forty lines in the xtravels sample that turn each @federated entity into a table, schedule a replicate handler with the runtime's scheduling API and upsert the rows newer than the local maximum of modifiedAt. The runtime supplies the annotation, the scheduling and the remote query; the loop is the application's own.

SourceCAP-level Data Federation — capirechecked

A Node.js coverage assessment has not been written. View all flavors

THE COMMUNITY ADDS
@cap-js-community/common

Replicates a service into a tenant-aware SQLite database, kept per tenant.

cds-data-federation

Declares on a consumption view whether a remote entity is delegated to at query time, replicated into a local table on a schedule through cds-data-pipeline, or cached; the handlers and the query translation are registered at boot from the annotation.

Sourcecds-data-federation — READMEchecked
cds-data-pipeline

Runs a scheduled READ, MAP, WRITE pipeline that copies an entity from an OData, REST or CAP source into a local table or a remote OData target, with delta modes, retry and a management API.

Sourcecds-data-pipeline — READMEchecked

A Node.js coverage assessment has not been written. View all flavors

Licence1

LicenceSAP Developer License Agreement 3.2 CAP§ 1AlwaysReplication by a covered CAP application moves data from an SAP product into a non-SAP product.
  • § 1 License. Productive customer applications are limited to SAP BTP or another SAP-licensed platform, and mass extraction to a non-SAP product is restricted except where solely required for SAP interoperability.

Section 1 restricts mass extraction to a non-SAP product and states a scoped interoperability exception. That boundary is central to a replication design and must be checked against the actual use.

SAP Developer License Agreement 3.2 CAP →

Artifacts5

5 of 5 artifacts
ArtifactSignals
CDS plugins3
cds-data-federationData federation for CAP via delegation, caching and replication
Signals
Use terms
cds-data-pipelineScheduled READ, MAP, WRITE pipelines between CAP services
Signals
Use terms
cds-federation-synonymsCAP-to-CAP data federation over SAP HANA synonyms
Signals
Functional boundary+1
Packages2
@cap-js-community/commonSix CAP features in one package, from replication cache to rate limits
Signals
Functional boundary
@sap/cdsCAP Node.js runtime
Signals
none

Content3

Group by
Piece, what it offers
CAP-level Data Federation
YouTube — SAP Developers playlists, SAP Developers, Talk
CAP-level Data Federation
YouTube — SAP Developers playlists, SAP Developers, Talk
Federating, Replicating, and Caching Remote Data in CAP — Part 2
SAP Community, Mike Zaschka, part 2 of 2, BlogThe reasoningA recipeRunnable code
The Full Picture: Federating, Replicating, and Caching Remote Data in CAP — Part 1
SAP Community, Mike Zaschka, part 1 of 2, BlogThe reasoning

Details

Coverage
statecore and community, CAP, Node.js, derived
also inBTP/BAIP
Comparison properties6

These are the questions used to compare what the artifacts do. Values come from their documentation and may apply to a particular ecosystem or runtime. Each recorded value in the comparison opens its statement and sources.

StrategyRefreshDelta handlingWrites reach the sourceReads fromWrites to
For your agent